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

add repro --recursive in Repro command reference #396

Closed
wants to merge 13 commits into from
4 changes: 2 additions & 2 deletions static/docs/commands-reference/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
11 changes: 4 additions & 7 deletions static/docs/commands-reference/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -70,11 +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` - 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 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.
Expand Down
7 changes: 6 additions & 1 deletion static/docs/commands-reference/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Copy link
Contributor

@jorgeorpinel jorgeorpinel Jun 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a space between - and R.
But anyway, the usage shown with dvc gc -h (latest DVC version: 0.41.3+1e7e2a) is

usage: dvc gc [-h] [-q | -v] [-a] [-T] [-c] [-r REMOTE] [-f] [-j JOBS]
              [-p [REPOS [REPOS ...]]]

Which doesn't include -R (and doesn't match the current docs 😓 )

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok and it dvc -R is not mentioned in docs for a no of other commands as well like fetch, status, metrics,gc and somemore.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. So did you update this usage and remove the -R option from this doc?

Could you please open an issue for the docs that are missing the -R option and need update in their usage blocks?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened issue iterative/dvc#2154_

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there still a space in this file between - and R

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kurianbenoy Where did you get gc -R from anyways?

[-p [PROJECTS [PROJECTS ...]]]
```

Expand Down Expand Up @@ -47,6 +47,11 @@ 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` - 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
GC are parallel.
Expand Down
9 changes: 4 additions & 5 deletions static/docs/commands-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` - `targets` values is expected to be a directory path.
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` - 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
Expand Down
9 changes: 4 additions & 5 deletions static/docs/commands-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +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 directory path.
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` - 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
Expand Down
5 changes: 4 additions & 1 deletion static/docs/commands-reference/repro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,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]
[-p] [-P] [--ignore-build-cache] [--no-commit]
[-p] [-P] [-R] [--ignore-build-cache] [--no-commit]
[targets [targets ...]]
kurianbenoy marked this conversation as resolved.
Show resolved Hide resolved

positional arguments:
Expand Down Expand Up @@ -100,6 +100,9 @@ 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` - it reproduce all stages for specified directory/targets.
The `targets` value is expected to be a directory path and also files as well.

## Examples

For simplicity, let's build a pipeline defined below (if you want get your hands
Expand Down