From 13779e3db99081bbd2fe7315a9363b4663a5656a Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Sun, 2 Jun 2019 07:05:45 +0530 Subject: [PATCH 01/13] add repro --recursive in Repro command reference --- static/docs/commands-reference/repro.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index 30a6d2297b..ddba6df956 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -9,7 +9,7 @@ dependencies to find only those that have to be rerun. ```usage usage: dvc repro [-h] [-q | -v] - [-f] [-s] [-c CWD] [-m] [--dry] [-i] + [-f] [-s] [-c CWD] [-m] [--dry] [-i] [-R] [-p] [-P] [--ignore-build-cache] [--no-commit] [targets [targets ...]] @@ -100,6 +100,13 @@ option is specified) and updates DVC-files with the new checksum information. - `--downstream` - rerun the commands down the pipeline of the target file including the one in it. +- `R, --recursive` - the `targets` value is expected to be a directory path. + With this option, you can reproduce all stages in a specified directory. + Determines the files to download by searching the named directory and its + subdirectories for DVC files to download data for. Along with providing a + `target`, or `target` along with `--with-deps`, it is yet another way to + limit the scope of DVC files to upload. + ## Examples For simplicity, let's build a pipeline defined below (if you want get your hands From 0d71a0e427ce725127aa90735e167e256efab4ce Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Sun, 2 Jun 2019 07:40:36 +0530 Subject: [PATCH 02/13] Mention target usage for files --- static/docs/commands-reference/repro.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index ddba6df956..2927d1815e 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -100,12 +100,13 @@ option is specified) and updates DVC-files with the new checksum information. - `--downstream` - rerun the commands down the pipeline of the target file including the one in it. -- `R, --recursive` - the `targets` value is expected to be a directory path. - With this option, you can reproduce all stages in a specified directory. - Determines the files to download by searching the named directory and its - subdirectories for DVC files to download data for. Along with providing a - `target`, or `target` along with `--with-deps`, it is yet another way to - limit the scope of DVC files to upload. +- `R, --recursive` - the `targets` value is expected to be a directory path or + a path corresponding to a specific file. With this option, you can reproduce + all stages in a specified directory. It determines the files to download by + searching the named directory and its subdirectories for DVC-files to + download data for. Along with providing a `target`, or `target` along with + `--with-deps`, it is yet another way to limit the scope of DVC-files to + reproduce. ## Examples From bbc285895e1c6726dfa7a7e948f54341742156fa Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Mon, 3 Jun 2019 00:27:25 +0530 Subject: [PATCH 03/13] fix intentation --- static/docs/commands-reference/repro.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index 2927d1815e..3249a91453 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -100,13 +100,13 @@ option is specified) and updates DVC-files with the new checksum information. - `--downstream` - rerun the commands down the pipeline of the target file including the one in it. -- `R, --recursive` - the `targets` value is expected to be a directory path or - a path corresponding to a specific file. With this option, you can reproduce - all stages in a specified directory. It determines the files to download by - searching the named directory and its subdirectories for DVC-files to - download data for. Along with providing a `target`, or `target` along with - `--with-deps`, it is yet another way to limit the scope of DVC-files to - reproduce. +- `R`, `--recursive` - the `targets` value is expected to be a directory path + or a path corresponding to a specific file. With this option, you can + reproduce all stages in a specified directory. It determines the files to + download by searching the named directory and its subdirectories for + DVC-files to download data for. Along with providing a `target`, or `target` + along with `--with-deps`, it is yet another way to limit the scope of + DVC-files toreproduce. ## Examples From fecfa434b6daa32f056731b0648cb13846baefde Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Mon, 3 Jun 2019 00:28:15 +0530 Subject: [PATCH 04/13] Mention about new target values for -R in dvc push --- static/docs/commands-reference/pull.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md index 63e3cd45fa..1a8a12e9e2 100644 --- a/static/docs/commands-reference/pull.md +++ b/static/docs/commands-reference/pull.md @@ -85,8 +85,8 @@ reflinks or hardlinks to put it in the workspace without copying. See surfaces behavior from the `dvc checkout` command because `dvc pull` in effect performs a _checkout_ after downloading files. -- `-R`, `--recursive` - `targets` values is expected to be a directory path. - Determines the files to download by searching the named directory and its +- `-R`, `--recursive` - `targets` values is expected to be a directory path + or a path corresponding to a specific file. Determines the files to download by searching the named directory and its subdirectories for DVC-files to download data for. Along with providing a `target`, or `target` along with `--with-deps` it is yet another way to cut the scope of DVC-files to download. From 30e1a12f7f1502cddbd0825ec5931f5f6bc93a67 Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Mon, 3 Jun 2019 00:28:35 +0530 Subject: [PATCH 05/13] Mention about new target values for -R in dvc pull --- static/docs/commands-reference/push.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md index 13abbfe77d..272d79ee08 100644 --- a/static/docs/commands-reference/push.md +++ b/static/docs/commands-reference/push.md @@ -88,8 +88,8 @@ backward through the pipeline to find data files to push. backward through the pipeline from the named target(s). This means DVC will not push files referenced later in the pipeline than the named target(s). -- `-R`, `--recursive` - the `targets` value is expected to be a directory path. - With this option, `dvc pull` determines the files to upload by searching the +- `-R`, `--recursive` - the `targets` value is expected to be a directory path + or a path corresponding to a specific file. With this option, `dvc pull` determines the files to upload by searching the named directory, and its subdirectories, for DVC-files for which to upload data. Along with providing a `target`, or `target` along with `--with-deps`, it is yet another way to limit the scope of DVC-files to upload. From f4b9d40226e01d76c9ff6c3318ce79b6f8a8034a Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Thu, 6 Jun 2019 00:58:03 +0530 Subject: [PATCH 06/13] Modified value of targets --- static/docs/commands-reference/pull.md | 8 ++++---- static/docs/commands-reference/push.md | 9 +++++---- static/docs/commands-reference/repro.md | 11 +++++------ 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md index 1a8a12e9e2..f7a71380a7 100644 --- a/static/docs/commands-reference/pull.md +++ b/static/docs/commands-reference/pull.md @@ -86,10 +86,10 @@ reflinks or hardlinks to put it in the workspace without copying. See performs a _checkout_ after downloading files. - `-R`, `--recursive` - `targets` values is expected to be a directory path - or a path corresponding to a specific file. Determines the files to download by searching the named directory and its - subdirectories for DVC-files to download data for. Along with providing a - `target`, or `target` along with `--with-deps` it is yet another way to cut - the scope of DVC-files to download. + and also files as well. Determines the files to download by searching the + named directory and its subdirectories for DVC-files to download data for. + Along with providing a `target`, or `target` along with `--with-deps` it is + yet another way to cut the scope of DVC-files to download. - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while downloading files from the remote cache. The effect is to control the diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md index 272d79ee08..913da7863e 100644 --- a/static/docs/commands-reference/push.md +++ b/static/docs/commands-reference/push.md @@ -89,10 +89,11 @@ backward through the pipeline to find data files to push. not push files referenced later in the pipeline than the named target(s). - `-R`, `--recursive` - the `targets` value is expected to be a directory path - or a path corresponding to a specific file. With this option, `dvc pull` determines the files to upload by searching the - named directory, and its subdirectories, for DVC-files for which to upload - data. Along with providing a `target`, or `target` along with `--with-deps`, - it is yet another way to limit the scope of DVC-files to upload. + and also files as well. With this option, `dvc pull` determines the files to + upload by searching the named directory, and its subdirectories, for + DVC-files for which to upload data. Along with providing a `target`, or + `target` along with `--with-deps`, it is yet another way to limit the scope + of DVC-files to upload. - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while uploading files to the remote cache. The effect is to control the number diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index 3249a91453..f11f97ba5c 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -101,12 +101,11 @@ option is specified) and updates DVC-files with the new checksum information. including the one in it. - `R`, `--recursive` - the `targets` value is expected to be a directory path - or a path corresponding to a specific file. With this option, you can - reproduce all stages in a specified directory. It determines the files to - download by searching the named directory and its subdirectories for - DVC-files to download data for. Along with providing a `target`, or `target` - along with `--with-deps`, it is yet another way to limit the scope of - DVC-files toreproduce. + and also files as well. With this option, you can reproduce all stages in a + specified directory. It determines the files to download by searching the + named directory and its subdirectories for DVC-files to download data for. + Along with providing a `target`, or `target` along with `--with-deps`, it + is yet another way to limit the scope of DVC-files toreproduce. ## Examples From 5ce14e5ca1bf0553d7c1849a4b16a8954bf4bb92 Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Thu, 6 Jun 2019 19:52:58 +0530 Subject: [PATCH 07/13] -R for gc command --- static/docs/commands-reference/gc.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/static/docs/commands-reference/gc.md b/static/docs/commands-reference/gc.md index 323f2d3d30..3969d219ad 100644 --- a/static/docs/commands-reference/gc.md +++ b/static/docs/commands-reference/gc.md @@ -6,7 +6,7 @@ Remove unused objects from cache or remote storage. ```usage usage: dvc gc [-h] [-q | -v] [-a] [-T] [-c] - [-r REMOTE] [-f] [-j JOBS] + [-r REMOTE] [-f] [-j JOBS] [- R] [-p [PROJECTS [PROJECTS ...]]] ``` @@ -47,6 +47,13 @@ usually helps to save some space. - `-r`, `--remote` - name of the remote storage to collect unused objects from if `-c` option is specified. +- `-R`, `--recursive` - `targets` values is expected to be a directory path + and also files as well. It removes the unused objects from cache or remote + storageDetermines the files to download by searching the + named directory and its subdirectories for DVC-files to download data for. + Along with providing a `target`, or `target` along with `--with-deps` it is + yet another way to cut the scope of DVC-files to download. + - `-j`, `--jobs` - garbage collector parallelism level. The default value is `4 * cpu_count()`. For SSH remotes default is 4. For now only some phases of GC are parallel. From ba267ed6aef2f6307bb186f6b264815f5964e8da Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Thu, 6 Jun 2019 20:16:50 +0530 Subject: [PATCH 08/13] update about targets message in pull command --- static/docs/commands-reference/pull.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md index f7a71380a7..28feee43ab 100644 --- a/static/docs/commands-reference/pull.md +++ b/static/docs/commands-reference/pull.md @@ -85,10 +85,10 @@ reflinks or hardlinks to put it in the workspace without copying. See surfaces behavior from the `dvc checkout` command because `dvc pull` in effect performs a _checkout_ after downloading files. -- `-R`, `--recursive` - `targets` values is expected to be a directory path - and also files as well. Determines the files to download by searching the - named directory and its subdirectories for DVC-files to download data for. - Along with providing a `target`, or `target` along with `--with-deps` it is +- `-R`, `--recursive` - `targets` value is expected to be a file along with its + directory path or a directory. Determines the files to download by searching + the named directory and its subdirectories for DVC-files to download data for + .Along with providing a `target`, or `target` along with `--with-deps` it is yet another way to cut the scope of DVC-files to download. - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously From d248f79ddedcf449ccef15cc3fb3162d01957bba Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Sat, 8 Jun 2019 15:44:42 +0530 Subject: [PATCH 09/13] rephrased -R description of dvc pull --- static/docs/commands-reference/pull.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md index 28feee43ab..d2eef37365 100644 --- a/static/docs/commands-reference/pull.md +++ b/static/docs/commands-reference/pull.md @@ -85,11 +85,11 @@ reflinks or hardlinks to put it in the workspace without copying. See surfaces behavior from the `dvc checkout` command because `dvc pull` in effect performs a _checkout_ after downloading files. -- `-R`, `--recursive` - `targets` value is expected to be a file along with its - directory path or a directory. Determines the files to download by searching - the named directory and its subdirectories for DVC-files to download data for - .Along with providing a `target`, or `target` along with `--with-deps` it is - yet another way to cut the scope of DVC-files to download. +- `-R`, `--recursive` - each `targets` value is expected to be a path to a file + or directory, relative to current location(eg.`data/models`). Determines + DVC-files to download data for the target directory. Along with providing a + `target`, and/or `--with-deps` it is yet another way to cut the scope of + DVC-files to download. - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while downloading files from the remote cache. The effect is to control the From 8b568dfb31a301aca5153ddc3027b19c50961656 Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Sat, 8 Jun 2019 15:45:00 +0530 Subject: [PATCH 10/13] rephrased -R description of dvc push --- static/docs/commands-reference/push.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md index 913da7863e..802fa7c2c3 100644 --- a/static/docs/commands-reference/push.md +++ b/static/docs/commands-reference/push.md @@ -88,12 +88,12 @@ backward through the pipeline to find data files to push. backward through the pipeline from the named target(s). This means DVC will not push files referenced later in the pipeline than the named target(s). -- `-R`, `--recursive` - the `targets` value is expected to be a directory path - and also files as well. With this option, `dvc pull` determines the files to - upload by searching the named directory, and its subdirectories, for - DVC-files for which to upload data. Along with providing a `target`, or - `target` along with `--with-deps`, it is yet another way to limit the scope - of DVC-files to upload. +- `-R`, `--recursive` - the `targets` value is expected to be a path to a file + or directory, relative to the current location(eg.`data/models/predict.pkl`). + and also files as well. With this option, `dvc push` determines the files to + upload by searching the target directory and its subdirectories for DVC-files + to upload data. Along with providing a `target`, and/or +`--with-deps` it is yet another way to cut the scope of DVC-files to download. - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while uploading files to the remote cache. The effect is to control the number From 1ee43e9bb1435da954752d0a05121e0da16e0145 Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Tue, 18 Jun 2019 23:36:16 +0530 Subject: [PATCH 11/13] Made changes regarding context of usage of dvc -R for some commands --- static/docs/commands-reference/add.md | 4 ++-- static/docs/commands-reference/commit.md | 8 +++----- static/docs/commands-reference/gc.md | 10 ++++------ static/docs/commands-reference/pull.md | 9 ++++----- static/docs/commands-reference/push.md | 10 ++++------ static/docs/commands-reference/repro.md | 10 ++++------ 6 files changed, 21 insertions(+), 30 deletions(-) diff --git a/static/docs/commands-reference/add.md b/static/docs/commands-reference/add.md index 369e482950..e908cff952 100644 --- a/static/docs/commands-reference/add.md +++ b/static/docs/commands-reference/add.md @@ -6,8 +6,8 @@ DVC-file). ## Synopsis ```usage -usage: dvc add [-h] [-q | -v] [-f] - [-R] [--no-commit] +usage: dvc add [-h] [-q | -v] [-R] + [--no-commit] [-f FILE] targets [targets ...] positional arguments: diff --git a/static/docs/commands-reference/commit.md b/static/docs/commands-reference/commit.md index a418187717..73fcc31ca8 100644 --- a/static/docs/commands-reference/commit.md +++ b/static/docs/commands-reference/commit.md @@ -70,11 +70,9 @@ It handles that last step of adding the file to the DVC cache. backward through the pipeline from the named target(s). This means DVC will not commit files referenced later in the pipeline than the named target(s). -- `-R`, `--recursive` - the `targets` value is expected to be a directory path. - With this option, `dvc commit` determines the files to commit by searching the - named directory, and its subdirectories, for DVC-files for which to commit - data. Along with providing a `target`, or `target` along with `--with-deps`, - it is yet another way to limit the scope of DVC-files to upload. +- `-R`, `--recursive` - determines the files to commit cache- by searching the + named directory/targets, and its subdirectories, for DVC-files for which to + commit data. The `targets` value is expected to be a directory path or a file - `-f`, `--force` - commit data even if checksums for dependencies or outputs did not change. diff --git a/static/docs/commands-reference/gc.md b/static/docs/commands-reference/gc.md index 3969d219ad..8b0c2c3e45 100644 --- a/static/docs/commands-reference/gc.md +++ b/static/docs/commands-reference/gc.md @@ -47,12 +47,10 @@ usually helps to save some space. - `-r`, `--remote` - name of the remote storage to collect unused objects from if `-c` option is specified. -- `-R`, `--recursive` - `targets` values is expected to be a directory path - and also files as well. It removes the unused objects from cache or remote - storageDetermines the files to download by searching the - named directory and its subdirectories for DVC-files to download data for. - Along with providing a `target`, or `target` along with `--with-deps` it is - yet another way to cut the scope of DVC-files to download. +- `-R`, `--recursive` - It removes the unused objects from cache or remote + storage and determines the DVC-files to download by searching the named + directory/targets for DVC-files to download data for. `targets` values is + expected to be a directory path and also files as well. - `-j`, `--jobs` - garbage collector parallelism level. The default value is `4 * cpu_count()`. For SSH remotes default is 4. For now only some phases of diff --git a/static/docs/commands-reference/pull.md b/static/docs/commands-reference/pull.md index d2eef37365..d96078a46a 100644 --- a/static/docs/commands-reference/pull.md +++ b/static/docs/commands-reference/pull.md @@ -85,11 +85,10 @@ reflinks or hardlinks to put it in the workspace without copying. See surfaces behavior from the `dvc checkout` command because `dvc pull` in effect performs a _checkout_ after downloading files. -- `-R`, `--recursive` - each `targets` value is expected to be a path to a file - or directory, relative to current location(eg.`data/models`). Determines - DVC-files to download data for the target directory. Along with providing a - `target`, and/or `--with-deps` it is yet another way to cut the scope of - DVC-files to download. +- `-R`, `--recursive` - It pulls data from the cache to the workspace for data + files and directories that are referenced in those DVC-files/targets. + `targets` value is expected to be a path to a file or directory, relative to + current location(eg.`data/models`) - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while downloading files from the remote cache. The effect is to control the diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md index 802fa7c2c3..947a477ed4 100644 --- a/static/docs/commands-reference/push.md +++ b/static/docs/commands-reference/push.md @@ -88,12 +88,10 @@ backward through the pipeline to find data files to push. backward through the pipeline from the named target(s). This means DVC will not push files referenced later in the pipeline than the named target(s). -- `-R`, `--recursive` - the `targets` value is expected to be a path to a file - or directory, relative to the current location(eg.`data/models/predict.pkl`). - and also files as well. With this option, `dvc push` determines the files to - upload by searching the target directory and its subdirectories for DVC-files - to upload data. Along with providing a `target`, and/or -`--with-deps` it is yet another way to cut the scope of DVC-files to download. +- `-R`, `--recursive` - It push data from the cache to the workspace for data + files and directories that are referenced in those DVC-files/targets. The + `targets` value is expected to be a path to a file or directory, relative to + the current location(eg.`data/models/predict.pkl`). - `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously while uploading files to the remote cache. The effect is to control the number diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index f11f97ba5c..a0f03b87bd 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -100,12 +100,10 @@ option is specified) and updates DVC-files with the new checksum information. - `--downstream` - rerun the commands down the pipeline of the target file including the one in it. -- `R`, `--recursive` - the `targets` value is expected to be a directory path - and also files as well. With this option, you can reproduce all stages in a - specified directory. It determines the files to download by searching the - named directory and its subdirectories for DVC-files to download data for. - Along with providing a `target`, or `target` along with `--with-deps`, it - is yet another way to limit the scope of DVC-files toreproduce. +- `R`, `--recursive` - you can reproduce all stages in a specified target. It + determines the files to download by searching the named directory and its + subdirectories for DVC-files to download data for. the `targets` value is + expected to be a directory path and also files as well. ## Examples From 3f7120bfee125d3ad8e3512aec62583e8984d2ed Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Tue, 18 Jun 2019 23:40:47 +0530 Subject: [PATCH 12/13] fix repro -h command list --- static/docs/commands-reference/repro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index a0f03b87bd..a3b9e824c9 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -9,8 +9,8 @@ dependencies to find only those that have to be rerun. ```usage usage: dvc repro [-h] [-q | -v] - [-f] [-s] [-c CWD] [-m] [--dry] [-i] [-R] - [-p] [-P] [--ignore-build-cache] [--no-commit] + [-f] [-s] [-c CWD] [-m] [--dry] [-i] + [-p] [-P] [-R] [--ignore-build-cache] [--no-commit] [targets [targets ...]] positional arguments: From 3457ad803fdc39f50334b30f69995d91af14db06 Mon Sep 17 00:00:00 2001 From: kurianbenoy Date: Thu, 20 Jun 2019 15:20:23 +0530 Subject: [PATCH 13/13] update files --- static/docs/commands-reference/commit.md | 9 ++++----- static/docs/commands-reference/push.md | 2 +- static/docs/commands-reference/repro.md | 6 ++---- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/static/docs/commands-reference/commit.md b/static/docs/commands-reference/commit.md index 73fcc31ca8..2695313af1 100644 --- a/static/docs/commands-reference/commit.md +++ b/static/docs/commands-reference/commit.md @@ -17,8 +17,7 @@ positional arguments: ## Description The `dvc commit` command is useful for several scenarios where a dataset is -being changed: a [stage](/doc/commands-reference/run) or -[pipeline](/doc/get-started/pipeline) is in development, when one wishes to run +being changed: a [stage](/doc/commands-reference/run) or [pipeline](/doc/get-started/pipeline) is in development, when one wishes to run commands outside the control of DVC, or to force DVC-files updates to save time rerunning the stage or pipeline. @@ -70,9 +69,9 @@ It handles that last step of adding the file to the DVC cache. backward through the pipeline from the named target(s). This means DVC will not commit files referenced later in the pipeline than the named target(s). -- `-R`, `--recursive` - determines the files to commit cache- by searching the - named directory/targets, and its subdirectories, for DVC-files for which to - commit data. The `targets` value is expected to be a directory path or a file +- `-R`, `--recursive` - determines the files to commit by searching the named + directory/targets, and its subdirectories, for DVC-files for which to commit + data. The `targets` value is expected to be a directory path or a file. - `-f`, `--force` - commit data even if checksums for dependencies or outputs did not change. diff --git a/static/docs/commands-reference/push.md b/static/docs/commands-reference/push.md index 947a477ed4..5ec265e273 100644 --- a/static/docs/commands-reference/push.md +++ b/static/docs/commands-reference/push.md @@ -88,7 +88,7 @@ backward through the pipeline to find data files to push. backward through the pipeline from the named target(s). This means DVC will not push files referenced later in the pipeline than the named target(s). -- `-R`, `--recursive` - It push data from the cache to the workspace for data +- `-R`, `--recursive` - it push data from the cache to the workspace for data files and directories that are referenced in those DVC-files/targets. The `targets` value is expected to be a path to a file or directory, relative to the current location(eg.`data/models/predict.pkl`). diff --git a/static/docs/commands-reference/repro.md b/static/docs/commands-reference/repro.md index a3b9e824c9..78e42f97be 100644 --- a/static/docs/commands-reference/repro.md +++ b/static/docs/commands-reference/repro.md @@ -100,10 +100,8 @@ option is specified) and updates DVC-files with the new checksum information. - `--downstream` - rerun the commands down the pipeline of the target file including the one in it. -- `R`, `--recursive` - you can reproduce all stages in a specified target. It - determines the files to download by searching the named directory and its - subdirectories for DVC-files to download data for. the `targets` value is - expected to be a directory path and also files as well. +- `R`, `--recursive` - it reproduce all stages for specified directory/targets. + The `targets` value is expected to be a directory path and also files as well. ## Examples