Skip to content

Commit

Permalink
docs: add --run-cache for fetch/pull/push (#1481)
Browse files Browse the repository at this point in the history
Related to #1289
  • Loading branch information
efiop authored Jun 23, 2020
1 parent 97d15ae commit 27a00bc
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
7 changes: 6 additions & 1 deletion content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Get tracked files or directories from

```usage
usage: dvc fetch [-h] [-q | -v] [-j <number>]
[-r <name>] [-a] [-T] [-d] [-R] [--all-commits]
[-r <name>] [-a] [-T]
[--all-commits] [-d] [-R]
[--run-cache]
[targets [targets ...]]
positional arguments:
Expand Down Expand Up @@ -77,6 +79,9 @@ or `-T` options are used).
[remote storage](/doc/command-reference/remote) to fetch from (see
`dvc remote list`).

- `--run-cache` - downloads all available history of stage runs from the remote
repository.

- `-d`, `--with-deps` - determines files to download by tracking dependencies to
the `targets`. If none are provided, this option is ignored. By traversing all
stage dependencies, DVC searches backward from the target stages in the
Expand Down
3 changes: 3 additions & 0 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ reflinks or hardlinks to put it in the workspace without copying. See
[remote storage](/doc/command-reference/remote) to pull from (see
`dvc remote list`).

- `--run-cache` - downloads all available history of stage runs from the remote
repository.

- `-j <number>`, `--jobs <number>` - number of threads to run simultaneously to
handle the downloading of files from the remote. The default value is
`4 * cpu_count()`. For SSH remotes, the default is just `4`. Using more jobs
Expand Down
7 changes: 5 additions & 2 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Upload tracked files or directories to
## Synopsis

```usage
usage: dvc push [-h] [-q | -v] [-j <number>]
[-r <name>] [-a] [-T] [-d] [-R] [--all-commits]
usage: dvc push [-h] [-q | -v] [-j <number>] [-r <name>] [-a] [-T]
[--all-commits] [-d] [-R] [--run-cache]
[targets [targets ...]]
positional arguments:
Expand Down Expand Up @@ -102,6 +102,9 @@ the target [stage files](/doc/command-reference/run), through the corresponding
[remote storage](/doc/command-reference/remote) to push from (see
`dvc remote list`).

- `--run-cache` - uploads all available history of stage runs to the remote
repository.

- `-j <number>`, `--jobs <number>` - number of threads to run simultaneously to
handle the uploading of files from the remote. The default value is
`4 * cpu_count()`. For SSH remotes, the default is just `4`. Using more jobs
Expand Down

0 comments on commit 27a00bc

Please sign in to comment.