diff --git a/content/docs/command-reference/data/status.md b/content/docs/command-reference/data/status.md index b11c1bd8d0..cac8786abb 100644 --- a/content/docs/command-reference/data/status.md +++ b/content/docs/command-reference/data/status.md @@ -1,10 +1,11 @@ # data status -Show changes in the data tracked by DVC in the workspace. +Show changes to the files and directories tracked by DVC in the +workspace. - + -For [pipelines](/doc/user-guide/pipelines) status, use `dvc status`. +For the status of data pipelines, see `dvc status`. @@ -52,33 +53,39 @@ DVC uncommitted changes: (there are other changes not tracked by dvc, use "git status" to see) ``` -As shown above, the `dvc data status` displays changes in multiple categories: - -- _Not in cache_ indicates that the hash for files are recorded in `dvc.lock` - and `.dvc` files but the corresponding cache files are missing. -- _DVC committed changes_ indicates that there are changes that are - `dvc-commit`-ed that differs with the last Git commit. There might be more - detailed state on how each of those files changed: _added_, _modified_, - _deleted_ and _unknown_. -- _DVC uncommitted changes_ indicates that there are changes in the - workspace that are not `dvc commit`-ed yet. Same as _DVC - committed changes_, there might be more detailed state on how each of those - files changed. -- _Untracked files_ shows the files that are not being tracked by DVC and Git. - This is disabled by default, unless [`--untracked-files`](#--untracked-files) - is specified. -- _DVC unchanged files_ shows the files that are not changed. This is not shown - by default, unless [`--unchanged`](#--unchanged) is specified. - -By default, `dvc data status` does not show individual changes inside the -tracked directories, which can be enabled with [`--granular`](#--granular) -option. +`dvc data status` displays changes in multiple categories: + +- _Not in cache_ indicates that there are file hashes in `.dvc` or `dvc.lock` + files, but the corresponding cache files are missing. This may + happen after cloning a DVC repository but before using `dvc pull` (or + `dvc fetch`) to download the data; or after using `dvc gc`. + +- _DVC committed changes_ are new, modified, or deleted tracked files or + directories that have been [committed to DVC]. These may be ready for + committing to Git. + +- _DVC uncommitted changes_ are new, modified, or deleted tracked files or + directories that have not been [committed to DVC] yet. You can `dvc add` or + `dvc commit` these. + +- _Untracked files_ have not been added to DVC (nor Git). Only shown if the + `--untracked-files` flag is used. + +- _Unchanged files_ have no modifications. Only shown if the `--unchanged` flag + is used. + +Individual changes to files inside [tracked directories] are not shown by +default but this can be enabled with the `--granular` flag. + +[committed to dvc]: /doc/command-reference/commit +[tracked directories]: /doc/command-reference/add#adding-entire-directories ## Options -- `--granular` - show granular, file-level information of the changes for - DVC-tracked directories. By default, `dvc data status` does not show - individual changes for files inside the tracked directories. +- `--granular` - show granular file-level changes inside DVC-tracked + directories. Note that some granular changes may be reported as `unknown` as + DVC tracks + [directory-level hash values](doc/user-guide/project-structure/internal-files#directories). - `--untracked-files` - show files that are not being tracked by DVC and Git. diff --git a/content/docs/command-reference/status.md b/content/docs/command-reference/status.md index 7d59e3691a..b2b661ca1d 100644 --- a/content/docs/command-reference/status.md +++ b/content/docs/command-reference/status.md @@ -4,9 +4,9 @@ Show changes in the project [pipelines](/doc/user-guide/pipelines), as well as file mismatches either between the cache and workspace, or between the cache and remote storage. - + -For an equivalent to `git status`, use `dvc data status`. +For the status of tracked data, see `dvc data status` (similar to `git status`).