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.

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: document target granularity for push/pull/etc, et al. #1384

Merged
merged 71 commits into from
Aug 6, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
08e2a25
docs: document target granularity for push/pull/etc
efiop May 31, 2020
619bdd9
Merge branch 'master' into fix-886
jorgeorpinel Jul 9, 2020
eba2cf5
cmd: move parenthesis
jorgeorpinel Jul 9, 2020
e24e2bb
cmd: prep status for granularity info
jorgeorpinel Jul 9, 2020
76e94b1
cmd: remove _changed checksum_ status
jorgeorpinel Jul 9, 2020
3398775
Merge branch 'master' into fix-886
jorgeorpinel Jul 10, 2020
1bf9af5
cmd: reinstate _changed checksum_ status (but only for .dvc files)
jorgeorpinel Jul 10, 2020
94a86c5
cmd: explain granularity for status, and other 1.0 updates
jorgeorpinel Jul 10, 2020
489a6c1
cmd: add info about granularity to push and pull
jorgeorpinel Jul 10, 2020
169db68
cmd: update target arg desc in several commands
jorgeorpinel Jul 11, 2020
f866f1e
cmd: simplify status target behavior desc.
jorgeorpinel Jul 11, 2020
06fe612
cmd: remove granularity note from status desc, but leave example note
jorgeorpinel Jul 11, 2020
a0292ef
cmd: add granularity example to status
jorgeorpinel Jul 11, 2020
02340f1
cmd: granularity examples for status and fetch
jorgeorpinel Jul 12, 2020
c2d7b5b
cmd: fix example in status
jorgeorpinel Jul 12, 2020
b01ccd9
cmd: fix formatting in a few cmds
jorgeorpinel Jul 12, 2020
44e3396
cmd: fixes to checkout desc
jorgeorpinel Jul 13, 2020
e81060a
cmd: improve fetch ref per coming changes to checkout...
jorgeorpinel Jul 13, 2020
bd3f657
cmd: granularity example for checkout
jorgeorpinel Jul 13, 2020
ae6f85e
cmd: note which commands support granularity in file/dir targets
jorgeorpinel Jul 13, 2020
bcd2c88
cmd: link granularity notes to add directory example and
jorgeorpinel Jul 13, 2020
bcbfe68
cmd: add notes about granular path support for (list) get and import
jorgeorpinel Jul 13, 2020
12bb0c4
cmd: roll back note about orphan stages
jorgeorpinel Jul 13, 2020
cb518f9
cmd: roll back note about usefulness of checkout
jorgeorpinel Jul 13, 2020
5e29b0d
cmd: improve first step bullet in checkout
jorgeorpinel Jul 13, 2020
46404b3
cmd: remove note on orphan stages from add
jorgeorpinel Jul 13, 2020
e30ad99
cmd: fix characters in fetch
jorgeorpinel Jul 14, 2020
9327d61
cmd: small fix to push/pull
jorgeorpinel Jul 14, 2020
d67d0ca
cmd: make granularity note part of path desc in list/get/import
jorgeorpinel Jul 14, 2020
29f7465
cmd: update target granularity notes in add and checkout
jorgeorpinel Jul 14, 2020
d9b7f53
cmd: update example title and note on granularity
jorgeorpinel Jul 14, 2020
b241bf5
cmd: shorten remaining notes on granularity
jorgeorpinel Jul 14, 2020
7502b84
cmd: update specific target example titles
jorgeorpinel Jul 14, 2020
f3f6425
cmd: improve targets explanation in fetch
jorgeorpinel Jul 14, 2020
81db6e1
cmd: simplify granularity example note in checkout
jorgeorpinel Jul 14, 2020
9879c1d
cmd: further simplify notes about granularity
jorgeorpinel Jul 15, 2020
46caf71
cmd: fix typo in fetch
jorgeorpinel Jul 15, 2020
7f354d9
Merge branch 'master' into fix-886
jorgeorpinel Jul 15, 2020
f434350
Merge branch 'master' into fix-886
jorgeorpinel Jul 20, 2020
99a9789
cmd: update granularity note in add: Tracking directories + ex
jorgeorpinel Jul 20, 2020
a36ba41
cmd: update checkout ref to improve tagets and granularity explanations
jorgeorpinel Jul 20, 2020
80074ed
cmd: correct dvc.yaml -> dvc.lock in status, checkout, and fetch
jorgeorpinel Jul 20, 2020
73512e1
cmd: introduce p about fetch targets arg
jorgeorpinel Jul 20, 2020
cac98e3
Update content/docs/command-reference/status.md
jorgeorpinel Jul 20, 2020
b89fed8
cmd: intro status targets arg p and granularity note
jorgeorpinel Jul 20, 2020
b745aa6
cmd: update status and fetch example granularity note
jorgeorpinel Jul 20, 2020
f3c8dd4
Merge branch 'fix-886' of github.com:iterative/dvc.org into fix-886
jorgeorpinel Jul 20, 2020
8e7f63a
cmd: improve status dependency example and text
jorgeorpinel Jul 20, 2020
20927fe
cmd: apply unified notes about target granularity to push and pull
jorgeorpinel Jul 20, 2020
5cc92af
cmd: double check granularity notes in list/import/get are unified
jorgeorpinel Jul 20, 2020
3ecc352
Merge branch 'master' into fix-886
jorgeorpinel Jul 22, 2020
ff3d7aa
cmd: update dvc.lock -> dvc.yaml in some cases
jorgeorpinel Jul 22, 2020
e87e397
cmd: rewrite checkout desc per private feedback
jorgeorpinel Jul 23, 2020
478c8a2
cmd: rewrite checkout desc
jorgeorpinel Jul 24, 2020
1e420b6
cmd: don't use term "synchronize" in checkout
jorgeorpinel Jul 24, 2020
9f1876f
cmd: a couple more updates to checkout
jorgeorpinel Jul 24, 2020
508cf97
cmd: mention checkout deals with several filel/dirs in example
jorgeorpinel Jul 24, 2020
9895f02
Merge branch 'master' into fix-886
jorgeorpinel Aug 2, 2020
a0c869b
cmd: fix fetch description and related passages in other refs
jorgeorpinel Aug 3, 2020
87faff3
cmd: update note about granularity in list, get, import
jorgeorpinel Aug 3, 2020
f280bdf
cmd: update status example title
jorgeorpinel Aug 3, 2020
5370f1f
cmd: more feedback on fetch rewrite
jorgeorpinel Aug 4, 2020
41f4db7
cmd: simplify granularity note in all its docs
jorgeorpinel Aug 4, 2020
4cac81f
term: don't use "as a whole" phrase for tracked dirs
jorgeorpinel Aug 4, 2020
cabc8bf
cmd: make paragraph plural for consistency
jorgeorpinel Aug 4, 2020
6ac8b0f
cmd: update dvc.yaml vs lock file mention in status
jorgeorpinel Aug 4, 2020
8fd47ac
Merge branch 'master' into fix-886
jorgeorpinel Aug 5, 2020
b3eb463
cmd: edit notes about .dvcignore. General one in desc, specific one i…
jorgeorpinel Aug 5, 2020
a919f85
cmd: mention dvc.yaml in checkout desc
jorgeorpinel Aug 6, 2020
d6f9610
cmd: small corrections to fetch
jorgeorpinel Aug 6, 2020
acf0196
cmd: update explanation of stages and output hash values in status
jorgeorpinel Aug 6, 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
3 changes: 3 additions & 0 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ dependencies backward from the target [stage files](/doc/command-reference/run),
through the corresponding [pipelines](/doc/command-reference/pipeline), to find
data files to pull.

If `targets` are files/directories tracked by DVC, DVC will download cache for
them, skipping the rest.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

After a data file is in cache, `dvc pull` can use OS-specific mechanisms like
reflinks or hardlinks to put it in the workspace without copying. See
`dvc checkout` for more details.
Expand Down
3 changes: 3 additions & 0 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ with them. Using the `--with-deps` option, DVC tracks dependencies backward from
the target [stage files](/doc/command-reference/run), through the corresponding
[pipelines](/doc/command-reference/pipeline), to find data files to push.

If `targets` are files/directories tracked by DVC, DVC will download cache for
them skipping the rest.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

## Options

- `-a`, `--all-branches` - determines the files to upload by examining
Expand Down
5 changes: 4 additions & 1 deletion content/docs/command-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,11 @@ only, by listing them as `targets`. (Changes are reported only against these.)
When this is combined with the `--with-deps` option, a search is made for
changes in other stages that affect each target.

In the remote mode, if `targets` are files/directories tracked by DVC, DVC will
only compare the cache for them, skipping the rest.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

In the local mode, changes are detected through the hash value of every file
listed in every stage (in `dvc.yaml` or `.dvc` files) in question against the
listed in every stage (in `dvc.yaml`) or `.dvc` files in question against the
corresponding file in the file system. The command output indicates the detected
changes, if any. If no differences are detected, `dvc status` prints this
message:
Expand Down