Skip to content

Commit

Permalink
status: small bullet list fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Jul 30, 2019
1 parent 77e08ea commit d0bbaba
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions static/docs/commands-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,40 +55,37 @@ If instead, differences are detected, `dvc status` lists those changes. For each
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:
changes (described below). 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.

- _changed checksum_ means that the <abbr>DVC-file</abbr> checksum has changed
(e.g. someone manually edited the file)
(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`
(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

- _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
- _new_: output exists in workspace, but there is no corresponding checksum
calculated and saved in the DVC-file for this output yet.
- _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
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

0 comments on commit d0bbaba

Please sign in to comment.