Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd: update commit-related info. #1989

Merged
merged 23 commits into from
Dec 13, 2020
Merged

cmd: update commit-related info. #1989

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
5f5c1ff
cmd: update commit-related info
jorgeorpinel Dec 1, 2020
68c9c1a
Merge branch 'master' into cmd/commit
jorgeorpinel Dec 8, 2020
94eb1f8
cmd: improve commit intro
jorgeorpinel Dec 8, 2020
9c22f7e
cmd: update commit description
jorgeorpinel Dec 8, 2020
45da240
cmd: shorten commit intro
jorgeorpinel Dec 9, 2020
9b06323
cmd: mention that commit is an alternative to add
jorgeorpinel Dec 9, 2020
6ba7ea0
cmd: generalize use case of commit (not just about stages)
jorgeorpinel Dec 9, 2020
98c464f
cmd: separate add from repro cases of commit
jorgeorpinel Dec 10, 2020
a0cb751
cmd: term: don't say "under development"
jorgeorpinel Dec 10, 2020
ba6e109
cmd: clarify commit scenarios
jorgeorpinel Dec 10, 2020
3711dc8
cmd: clarify diffs among -no-cache options in run, repro
jorgeorpinel Dec 10, 2020
ce8ccad
cmd: update import/run --no-exec regarding caching
jorgeorpinel Dec 10, 2020
1c7d4a1
cmd: reinstate note on caching in import refs.
jorgeorpinel Dec 10, 2020
0be1fe0
cmd: rephrase first p in commit
jorgeorpinel Dec 10, 2020
f63a664
cmd: simplify main scenario in commit desc.
jorgeorpinel Dec 10, 2020
12a1a8e
Merge branch 'master' into cmd/commit
jorgeorpinel Dec 12, 2020
97be1b9
cmd: more uses for run -O
jorgeorpinel Dec 12, 2020
144749f
cmd: mention import --no-exec in commit
jorgeorpinel Dec 12, 2020
859e874
cmd: restructure commit desc
jorgeorpinel Dec 12, 2020
cf34cf6
cmd: impro/add motivation to run/repro/import --no-commit/exec
jorgeorpinel Dec 12, 2020
11c2768
cmd: update motivation for --no-exec
jorgeorpinel Dec 13, 2020
36997ed
cmd: Other->Specifically in secondary commit scenarios
jorgeorpinel Dec 13, 2020
b45e324
cmd: simplify import* --no-exec
jorgeorpinel Dec 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions content/docs/command-reference/import-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,15 @@ source.
default file name: `<file>.dvc`, where `<file>` is the desired file name of
the imported data (`out`).

- `--no-exec` - create `.dvc` file without actually downloading `url`. The data
hash is not calculated when this option is used, only the import metadata is
saved to the `.dvc` file. It can be useful to skip the download if the file or
directory already exists locally, for example, along with `dvc commit` to
store it in the cache and record its hash value in the `.dvc` file.
- `--no-exec` - create the import `.dvc` file without actually downloading
`url`. The data hash is not calculated when this option is used, only the
import metadata is saved to the `.dvc` file. It can be useful to skip the
download if the file/directory already exists locally, for example, along with
`dvc commit` to store it in the cache and record its hash value in the `.dvc`
file.

This is useful if, for example, you need to build a project that will use
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you have repetition useful ... useful

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm yeah this sentence wasn't great, sorry... Updated in d3ed553.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's repetitive with the last sentence of the previous paragraph, essentially it reads:

something. It is useful when A.

This is useful when B.

is it intentional?

and overall it got complicated again. Is there a way to merge A and B?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. I guess this is why we didn't have so much motivation in the --no-exec options before... I tried to merge it now but it's still a little long.

Maybe we should remove the part about "if the file/directory already exists locally"? It seems like a very edge case to download something manually and THEN register it with import.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should remove the part about "if the file/directory already exists locally"

Yeah, I removed that to simplify.

imports first, and download them all at once later (with `dvc repro`).

- `--desc <text>` - user description of the data (optional). This doesn't
affect any DVC operations.
Expand Down
9 changes: 6 additions & 3 deletions content/docs/command-reference/import.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,12 @@ repo at `url`) are not supported.
- `--no-exec` - create the import `.dvc` file without actually downloading the
file or directory. The data hash is not calculated when this option is used,
only the import metadata is saved to the `.dvc` file. It can be useful to skip
the download if the file or directory already exists locally, for example,
along with `dvc commit` to store it in the cache and record its hash value in
the `.dvc` file.
the download if the file/directory already exists locally, for example, along
with `dvc commit` to store it in the cache and record its hash value in the
`.dvc` file.

This is useful if, for example, you need to build a project that will use
imports first, and download them all at once later (with `dvc repro`).

- `--desc <text>` - user description of the data (optional). This doesn't affect
any DVC operations.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/repro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ up-to-date and only execute the final stage.

- `--no-commit` - do not store the outputs of this execution in the cache
(`dvc.yaml` and `dvc.lock` are still created or updated); useful to avoid
caching unnecessary data when executing tests or experiments. Use `dvc commit`
to finish the operation.
caching unnecessary data when exploring different data or stages. Use
`dvc commit` to finish the operation.

- `-m`, `--metrics` - show metrics after reproduction. The target pipelines must
have at least one metrics file defined either with the `dvc metrics` command,
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,8 @@ $ dvc run -n my_stage './my_script.sh $MYENVVAR'

- `--no-commit` - do not store the outputs of this execution in the cache
(`dvc.yaml` and `dvc.lock` are still created or updated); useful to avoid
caching unnecessary data when executing tests or experiments. Use `dvc commit`
to finish the operation.
caching unnecessary data when exploring different data or stages. Use
`dvc commit` to finish the operation.

- `--always-changed` - always consider this stage as changed (uses the
`always_changed` field in `dvc.yaml`). As a result `dvc status` will report it
Expand Down