-
Notifications
You must be signed in to change notification settings - Fork 409
status: update cmd ref #416
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
Merged
Merged
Changes from all commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
917a0f4
updated: synopsis for dvc status
sanidhyamangal ed5778a
updated: simple ussage and deps example for new status outputs
sanidhyamangal 1da8a7e
updated: synopsis for status command
sanidhyamangal 3c92f4e
Merge remote-tracking branch 'upstream/master'
sanidhyamangal e327a6e
updated: fixed spaces in synopsis section
sanidhyamangal 59c22ec
added: changed checksum and always changed in description of status
sanidhyamangal b219169
Merge remote-tracking branch 'upstream/master'
sanidhyamangal 0af6ff7
updated: local outputs in the status command
sanidhyamangal 6c4376d
fixed: merge conflict
sanidhyamangal b6e6315
updated: some typos
sanidhyamangal 2ab46f7
Update static/docs/commands-reference/status.md
sanidhyamangal e15308a
Update static/docs/commands-reference/status.md
sanidhyamangal ba9406a
Update static/docs/commands-reference/status.md
sanidhyamangal df8dfed
Update static/docs/commands-reference/status.md
sanidhyamangal 89d2303
updated: example dependencies in status
sanidhyamangal bab634c
added: new status for local description
sanidhyamangal ea43a74
Merge remote-tracking branch 'upstream/master'
sanidhyamangal 4c05eb4
updated: positional args in status synopsis
sanidhyamangal f74c743
updated: representation of messages in local description of status
sanidhyamangal a718973
updated: content in status
sanidhyamangal 01dada0
Merge remote-tracking branch 'upstream/master'
sanidhyamangal 1753c75
fixed: styling in status description
sanidhyamangal 884d91c
updated: list of local description in status
sanidhyamangal 73dfbb6
updated: rephrased list of local workspace status commands along with…
sanidhyamangal 363c553
updated: description for status
sanidhyamangal a455852
fixed: some gramatical errors in the descriptions
sanidhyamangal 8c3f467
added: examples of changed checksum and always changed in example of …
sanidhyamangal 7637e8d
fixed: merge conflict
sanidhyamangal 2ed3749
updated: a hierarchical splitting of list in status description
sanidhyamangal d26a0d7
fixed: merge conflict
sanidhyamangal 62b575d
updated: description of status command lists
sanidhyamangal 3e41e7d
Merge remote-tracking branch 'upstream/master'
sanidhyamangal 750c29e
updated: list of status and description para
sanidhyamangal 12830f7
Merge remote-tracking branch 'upstream/master'
sanidhyamangal f1b7d1b
Update status.md
shcheklein File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,25 +45,50 @@ detected, `dvc status` prints this message: | |
|
|
||
| ```dvc | ||
| $ dvc status | ||
| Pipeline is up to date. Nothing to reproduce. | ||
| Pipelines are up to date. Nothing to reproduce. | ||
| ``` | ||
|
|
||
| This says that no differences were detected, and therefore that no stages would | ||
| be run again if `dvc repro` were executed. | ||
| This indicates that no differences were detected, and therefore no stages would | ||
| be run again by `dvc repro`. | ||
|
|
||
| If instead, differences are detected, `dvc status` lists those changes. For each | ||
| DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that | ||
| differ are listed. For each item listed, either the file name or the checksum is | ||
| shown, and additionally a status word is shown describing the change: | ||
|
|
||
| - For the local workspace: | ||
| - _changed_ means the file has changed | ||
| - For comparison against a remote cache: | ||
| - _new_ means the file exists in the local cache but not the remote cache | ||
| - _deleted_ means the file doesn't exist in the local cache, but exists in the | ||
| remote cache | ||
| DVC-file (stage) with differences, the changes in _dependencies_ and/or | ||
| _outputs_ that differ are listed. For each item listed, either the file name or | ||
| the checksum is shown, and additionally a status word is shown describing the | ||
| changes. This changes list provides a reference to both the status of a | ||
| DVC-file, as well as the changes to individual dependencies and outputs | ||
| described in it: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please end this paragraph in period
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in d0bbaba |
||
|
|
||
| - _changed checksum_ means that the <abbr>DVC-file</abbr> checksum has changed | ||
| (e.g. someone manually edited the file) | ||
|
|
||
| - _always changed_ means that this is a special DVC-file with no dependencies | ||
| (orphans), which is considered always changed and is always executed by `dvc | ||
| repro` | ||
|
|
||
| - _changed deps_ or _changed outs_ means that there are changes in dependencies | ||
| or outputs defined by the <abbr>DVC-file</abbr>. Depending on the use case, | ||
| commands like `dvc commit` or `dvc repro`, `dvc run` should be run to update | ||
| the file. Possible states are: | ||
|
|
||
| - _new_: output exists in workspace, but there is no corresponding checksum | ||
| calculated and saved in the DVC-file for this output yet | ||
|
|
||
| For the _changed_ case, the `dvc repro` command is indicated. | ||
| - _modified_: output or dependency exists in workspace, but the | ||
| corresponding checksum in the DVC-file is not up to date | ||
|
|
||
| - _deleted_: output or dependency does not exist in workspace, but still | ||
| referred in the DVC-file | ||
|
|
||
| - _not in cache_: output exists in workspace and the corresponding checksum | ||
| in the DVC-file is up to date, but there is no corresponding | ||
| <abbr>cache</abbr> entry | ||
|
|
||
| **For comparison against a remote cache:** | ||
|
|
||
| - _new_ means the file exists in the local cache but not the remote cache | ||
| - _deleted_ means the file doesn't exist in the local cache, but exists in the | ||
| remote cache | ||
|
|
||
| For either the _new_ and _deleted_ cases, the local cache (subset of it, that is | ||
| determined by the active workspace) is different from the remote cache. Bringing | ||
|
|
@@ -118,14 +143,19 @@ cache. For the typical process to update workspaces, see | |
| ```dvc | ||
| $ dvc status | ||
|
|
||
| bar.dvc | ||
| outs | ||
| changed: bar | ||
| deps | ||
| changed: foo | ||
| foo.dvc | ||
| outs | ||
| changed: foo | ||
| bar.dvc: | ||
| changed deps: | ||
|
shcheklein marked this conversation as resolved.
|
||
| modified: bar | ||
| changed outs: | ||
| not in cache: foo | ||
| foo.dvc | ||
| changed outs: | ||
| deleted: foo | ||
| changed checksum | ||
| prepare.dvc | ||
| changed outs: | ||
| new: bar | ||
| always changed | ||
| ``` | ||
|
|
||
| This shows that for `bar.dvc` the dependency, `foo`, has changed, and the | ||
|
|
@@ -143,8 +173,8 @@ Pipeline is up to date. Nothing to reproduce. | |
|
|
||
| $ dvc status model.p.dvc --with-deps | ||
| matrix-train.p.dvc | ||
| deps | ||
| changed: code/featurization.py | ||
| changed deps: | ||
| modified: code/featurization.py | ||
| ``` | ||
|
|
||
| If the `dvc status` command is limited to a target that had no changes, result | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.