From 6da4cccc538574b6202033f6a9746fd775c629ee Mon Sep 17 00:00:00 2001 From: Saugat Pachhai Date: Tue, 24 Mar 2020 19:25:45 +0545 Subject: [PATCH] cmd-ref: document checkout summary flag --- content/docs/command-reference/checkout.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/checkout.md b/content/docs/command-reference/checkout.md index 1b1d02e9cc..197f0aea0c 100644 --- a/content/docs/command-reference/checkout.md +++ b/content/docs/command-reference/checkout.md @@ -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: @@ -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 displays a list of +changes 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 @@ -69,6 +68,8 @@ be pulled from remote storage using `dvc pull`. ## Options +- `--summary` - displays summary of the changes. + - `-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