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

docs: misc updates #1662

Merged
merged 62 commits into from
Aug 5, 2020
Merged
Changes from 1 commit
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
d04f082
cmd: review repro examples
jorgeorpinel Jul 22, 2020
a201abf
cmd: fic tyupo in get-url
jorgeorpinel Jul 22, 2020
f7d1a7e
Merge branch 'master' into jorge
jorgeorpinel Jul 23, 2020
fe8687e
cmd: updates to repro
jorgeorpinel Jul 23, 2020
f3df9d5
cmd: rewrite repro -P desc
jorgeorpinel Jul 23, 2020
ebc1560
cmd: simplified and generalize repro targets desc and DVC file mention
jorgeorpinel Jul 23, 2020
9a8c977
cmd: minor update for repro desc wording
jorgeorpinel Jul 23, 2020
c38ce31
term: don't use "synchronize" in the context of checkout
jorgeorpinel Jul 24, 2020
34217b8
cmd: rewrite Downstream example and added info for sequential executi…
sarthakforwet Jul 24, 2020
a071b7d
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 24, 2020
edff33e
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 24, 2020
71a5088
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 24, 2020
163ed19
cmd: Updated Downstream example
sarthakforwet Jul 25, 2020
cf873a4
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 27, 2020
ca04fb0
repro: Updated Downstream example
sarthakforwet Jul 28, 2020
dded2d7
Merge branch 'repro_misc' of github.com:sarthakforwet/dvc.org into re…
sarthakforwet Jul 28, 2020
30ce7bb
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 29, 2020
66e0603
cmd: updated last para for the description of --downstream and improv…
sarthakforwet Jul 29, 2020
05f0157
Merge branch 'master' into jorge
jorgeorpinel Jul 30, 2020
e532010
cmd: review language of init --subdir
jorgeorpinel Jul 30, 2020
b0fe9c1
term: revuew usage of "granular", esp. around init --subdir
jorgeorpinel Jul 30, 2020
8597f53
repro.md: updated Downstream example
sarthakforwet Jul 30, 2020
8ca9134
cmd: improve init --subdir explanation
jorgeorpinel Jul 30, 2020
8134010
cmd: add info about nested subrepos to init
jorgeorpinel Jul 30, 2020
a5db93f
cmd: fix -P option desc.
jorgeorpinel Jul 31, 2020
40512a1
cmd: improve explanation on how --subdir affects commands
jorgeorpinel Jul 31, 2020
1f77e8f
cmd: simplify nested structures explanation in init
jorgeorpinel Jul 31, 2020
d4bd8f8
Merge branch 'master' into jorge
jorgeorpinel Jul 31, 2020
42b670f
guide: add note aboud `cp` not being a download in external deps
jorgeorpinel Jul 31, 2020
d30bc63
cmd: add note about what --cwd means to repro
jorgeorpinel Jul 31, 2020
0ea4bd3
guide: nvmd! removing that note in external deps
jorgeorpinel Jul 31, 2020
70b7d2a
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
73499f2
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
e40402c
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
1696951
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
bfe6800
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
3a20f21
cmd: more small updates to init
jorgeorpinel Jul 31, 2020
e83bc5d
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
012b72f
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
80d2575
Restyled by prettier
restyled-commits Jul 31, 2020
2d06b22
Merge pull request #1648 from iterative/restyled/pull-1624
jorgeorpinel Jul 31, 2020
a85d8a0
cmd: rewrap metrics diff usage paragraph
jorgeorpinel Aug 3, 2020
38dfee7
Merge branch 'jorge' of github.com:iterative/dvc.org into jorge
jorgeorpinel Aug 3, 2020
fd2a9bb
term: remove "just" from -j desc in 3 refs
jorgeorpinel Aug 3, 2020
8d5adf7
Merge branch 'master' into jorge
jorgeorpinel Aug 5, 2020
221ed75
cmd: add command examples to init --subdir use cases
jorgeorpinel Aug 5, 2020
d14e960
cmd: explain nested repo and projects of all kinds outside of --subdir
jorgeorpinel Aug 5, 2020
5b47bd4
cmd: remove bold names to nested and not-nested structure examples in…
jorgeorpinel Aug 5, 2020
80a0f09
cmd: standardize --jobs option in all refs
jorgeorpinel Aug 5, 2020
5078044
cmd: add speed note to --jobs desc in all refs.
jorgeorpinel Aug 5, 2020
f176872
cmd: change versioning command example in init
jorgeorpinel Aug 5, 2020
cac92e5
cd: change repo comments in init --subdir examples
jorgeorpinel Aug 5, 2020
d1f9d24
cmd: improve note on DVC submodules a little
jorgeorpinel Aug 5, 2020
8d854a1
cmd: better explain why isolation is important in --subdir bullet
jorgeorpinel Aug 5, 2020
be5bc6d
cmd: split last --subdir cases explicitly as 2 bullets
jorgeorpinel Aug 5, 2020
9c3ba77
cmd: remove most notes and code block examples about nesting projects…
jorgeorpinel Aug 5, 2020
67e4248
Merge branch 'master' into jorge
jorgeorpinel Aug 5, 2020
cde3cd2
guide: clarify that tracked data is often needed for
jorgeorpinel Aug 5, 2020
d5d16e4
cmd: add/improve note on tracking directories with add and run
jorgeorpinel Aug 5, 2020
7546c1f
guide: update title of #structure-of-the-cache-directory section of
jorgeorpinel Aug 5, 2020
cb80e02
cmd: mention external deps/outs as a bullet in run notes
jorgeorpinel Aug 5, 2020
c02e81e
cmd: improve note about tracking dirs as outputs in run
jorgeorpinel Aug 5, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
cmd: standardize --jobs option in all refs
per #1615 (review)
et al.
jorgeorpinel committed Aug 5, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 80a0f092c3094b668159beb59182bcec5b5830d7
9 changes: 4 additions & 5 deletions content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
@@ -88,11 +88,10 @@ or `-T` options are used).
directory and its subdirectories for `dvc.yaml` and `.dvc` files to inspect.
If there are no directories among the `targets`, this option is ignored.

- `-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 `4`. Using more jobs may
improve the total download speed if a combination of small and large files are
being fetched.
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from remote storage. This only applies when the `--cloud` option is used, or a
`--remote` is given. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`.

- `-a`, `--all-branches` - fetch cache for all Git branches instead of just the
current workspace. This means DVC may download files needed to reproduce
6 changes: 4 additions & 2 deletions content/docs/command-reference/gc.md
Original file line number Diff line number Diff line change
@@ -89,8 +89,10 @@ The default remote is cleaned (see `dvc config core.remote`) unless the
[remote storage](/doc/command-reference/remote) to collect unused objects from
if `-c` option is specified (see `dvc remote list`).

- `-j <number>`, `--jobs <number>` - garbage collector parallelism level. The
default `JOBS` argument is `4 * cpu_count()`. For SSH remotes default is 4.
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to access data
from remote storage. This only applies when the `--cloud` option is used, or a
`--remote` is given. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`.

> For now only some phases of garbage collection are parallel.

9 changes: 4 additions & 5 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
@@ -96,11 +96,10 @@ reflinks or hardlinks to put it in the workspace without copying. See
repository into the local run cache. A `dvc repro <stage_name>` is necessary
to checkout these files into the workspace and update the `dvc.lock` file.

- `-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 `4`. Using more jobs may
improve the total download speed if a combination of small and large files are
being fetched.
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from remote storage. This only applies when the `--cloud` option is used, or a
`--remote` is given. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`.

- `-h`, `--help` - prints the usage/help message, and exit.

9 changes: 4 additions & 5 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
@@ -103,11 +103,10 @@ the target [stage files](/doc/command-reference/run), through the corresponding
- `--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 `4`. Using more jobs may
improve the total download speed if a combination of small and large files are
being fetched.
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to upload data
from remote storage. This only applies when the `--cloud` option is used, or a
`--remote` is given. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`.

- `-h`, `--help` - prints the usage/help message, and exit.

8 changes: 4 additions & 4 deletions content/docs/command-reference/status.md
Original file line number Diff line number Diff line change
@@ -142,10 +142,10 @@ workspace) is different from remote storage. Bringing the two into sync requires
- `-r <name>`, `--remote <name>` - specifies which remote storage (see
`dvc remote list`) to compare against. Implies `--cloud`.

- `-j <number>`, `--jobs <number>` - specifies the number of jobs DVC can use to
retrieve information from remote servers. This only applies when the `--cloud`
option is used or a remote is given. The default value is `4 * cpu_count()`.
For SSH remotes, the default is `4`.
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to retrieve
information from remote storage. This only applies when the `--cloud` option
is used, or a `--remote` is given. The default value is `4 * cpu_count()`. For
SSH remotes, the default is `4`.

- `-h`, `--help` - prints the usage/help message, and exit.