Skip to content
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 Jun 6, 2019
ed5778a
updated: simple ussage and deps example for new status outputs
sanidhyamangal Jun 6, 2019
1da8a7e
updated: synopsis for status command
sanidhyamangal Jun 9, 2019
3c92f4e
Merge remote-tracking branch 'upstream/master'
sanidhyamangal Jun 9, 2019
e327a6e
updated: fixed spaces in synopsis section
sanidhyamangal Jun 11, 2019
59c22ec
added: changed checksum and always changed in description of status
sanidhyamangal Jun 11, 2019
b219169
Merge remote-tracking branch 'upstream/master'
sanidhyamangal Jun 11, 2019
0af6ff7
updated: local outputs in the status command
sanidhyamangal Jun 12, 2019
6c4376d
fixed: merge conflict
sanidhyamangal Jun 12, 2019
b6e6315
updated: some typos
sanidhyamangal Jun 12, 2019
2ab46f7
Update static/docs/commands-reference/status.md
sanidhyamangal Jun 13, 2019
e15308a
Update static/docs/commands-reference/status.md
sanidhyamangal Jun 13, 2019
ba9406a
Update static/docs/commands-reference/status.md
sanidhyamangal Jun 13, 2019
df8dfed
Update static/docs/commands-reference/status.md
sanidhyamangal Jun 13, 2019
89d2303
updated: example dependencies in status
sanidhyamangal Jun 13, 2019
bab634c
added: new status for local description
sanidhyamangal Jun 13, 2019
ea43a74
Merge remote-tracking branch 'upstream/master'
sanidhyamangal Jun 13, 2019
4c05eb4
updated: positional args in status synopsis
sanidhyamangal Jun 14, 2019
f74c743
updated: representation of messages in local description of status
sanidhyamangal Jun 16, 2019
a718973
updated: content in status
sanidhyamangal Jun 16, 2019
01dada0
Merge remote-tracking branch 'upstream/master'
sanidhyamangal Jun 16, 2019
1753c75
fixed: styling in status description
sanidhyamangal Jun 16, 2019
884d91c
updated: list of local description in status
sanidhyamangal Jun 17, 2019
73dfbb6
updated: rephrased list of local workspace status commands along with…
sanidhyamangal Jun 20, 2019
363c553
updated: description for status
sanidhyamangal Jun 25, 2019
a455852
fixed: some gramatical errors in the descriptions
sanidhyamangal Jun 25, 2019
8c3f467
added: examples of changed checksum and always changed in example of …
sanidhyamangal Jun 26, 2019
7637e8d
fixed: merge conflict
sanidhyamangal Jun 26, 2019
2ed3749
updated: a hierarchical splitting of list in status description
sanidhyamangal Jul 3, 2019
d26a0d7
fixed: merge conflict
sanidhyamangal Jul 3, 2019
62b575d
updated: description of status command lists
sanidhyamangal Jul 14, 2019
3e41e7d
Merge remote-tracking branch 'upstream/master'
sanidhyamangal Jul 14, 2019
750c29e
updated: list of status and description para
sanidhyamangal Jul 23, 2019
12830f7
Merge remote-tracking branch 'upstream/master'
sanidhyamangal Jul 23, 2019
f1b7d1b
Update status.md
shcheklein Jul 27, 2019
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
78 changes: 54 additions & 24 deletions static/docs/commands-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Comment thread
shcheklein marked this conversation as resolved.

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:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please end this paragraph in period . not column :

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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
Expand Down Expand Up @@ -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:
Comment thread
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
Expand All @@ -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
Expand Down