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-ref: document checkout displaying changes #1054

Merged
merged 11 commits into from
Apr 22, 2020
10 changes: 6 additions & 4 deletions content/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DVC-files.
## Synopsis

```usage
usage: dvc checkout [-h] [-q | -v] [-d] [-R] [-f] [--relink]
usage: dvc checkout [-h] [-q | -v] [--summary] [-d] [-R] [-f] [--relink]
[targets [targets ...]]

positional arguments:
Expand Down Expand Up @@ -58,9 +58,8 @@ restoring any file size will be almost instantaneous.
> `cache.slow_link_warning` config option to `false` with `dvc config cache`.

This command will fail to checkout files that are missing from the cache. In
such a case, `dvc checkout` prints a warning message. It also lists removed
files. Any files that can be checked out without error will be restored without
being reported individually.
such a case, `dvc checkout` prints a warning message. It also lists the
partial progress made by the checkout.

There are two methods to restore a file missing from the cache, depending on the
situation. In some cases a pipeline must be reproduced (using `dvc repro`) to
Expand All @@ -69,6 +68,9 @@ be pulled from remote storage using `dvc pull`.

## Options

- `--summary` - displays summary of the changes done by this command in the
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
workspace.

- `-d`, `--with-deps` - determines files to update by tracking dependencies to
the target DVC-files (stages). If no `targets` are provided, this option is
ignored. By traversing all stage dependencies, DVC searches backward from the
Expand Down