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 description of the pull option to outs in .dvc files #5263

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion content/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ The execution of `dvc checkout` does the following:

- Checks `dvc.lock` and `.dvc` files to compare the hash values of their
<abbr>outputs</abbr> against the actual files or directories in the
<abbr>workspace</abbr> (similar to `dvc status`).
<abbr>workspace</abbr> (similar to `dvc status`). Outputs with `pull: false`
are not updated unless explicitly mentioned in `targets` (see `.dvc` files).

> Stage outputs must be defined in `dvc.yaml` (and `dvc.lock` contain their
> hash values), or they'll be skipped with a warning.
Expand Down
7 changes: 4 additions & 3 deletions content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,10 @@ Here are some scenarios in which `dvc fetch` is useful, instead of pulling:

Without arguments, it downloads all files and directories referenced in the
current workspace (found in `dvc.yaml` and `.dvc` files) that are missing from
the workspace. Any `targets` given to this command limit what to fetch. It
accepts paths to tracked files or directories (including paths inside tracked
directories), `.dvc` files, and <abbr>stage</abbr> names (found in `dvc.yaml`).
the workspace (except for outputs with `pull: false` set, see `.dvc` files). Any
`targets` given to this command limit what to fetch. It accepts paths to tracked
files or directories (including paths inside tracked directories), `.dvc` files,
and <abbr>stage</abbr> names (found in `dvc.yaml`).

The `--all-branches`, `--all-tags`, and `--all-commits` options enable fetching
files/dirs referenced in multiple Git commits.
Expand Down
7 changes: 4 additions & 3 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,10 @@ The `dvc remote` used is determined in order, based on

Without arguments, it downloads all files and directories referenced in the
current workspace (found in `dvc.yaml` and `.dvc` files) that are missing from
the workspace. Any `targets` given to this command limit what to pull. It
accepts paths to tracked files or directories (including paths inside tracked
directories), `.dvc` files, and stage names (found in `dvc.yaml`).
the workspace (except for outputs with `pull: false` set, see `.dvc` files). Any
`targets` given to this command limit what to pull. It accepts paths to tracked
files or directories (including paths inside tracked directories), `.dvc` files,
and stage names (found in `dvc.yaml`).

The `--all-branches`, `--all-tags`, and `--all-commits` options enable pulling
files/dirs referenced in multiple Git commits.
Expand Down
1 change: 1 addition & 0 deletions content/docs/user-guide/project-structure/dvc-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ The following subfields may be present under `outs` entries:
| `remote` | Name of the remote to use for pushing/fetching |
| `persist` | Whether the output file/dir should remain in place while `dvc repro` runs (`false` by default: outputs are deleted when `dvc repro` starts) |
| `push` | Whether or not this file or directory, when previously <abbr>cached</abbr>, is uploaded to remote storage by `dvc push` (`true` by default). |
| `pull` | Whether this file or directory should be be affected by `dvc fetch`, `dvc checkout`, or `dvc pull` when no targets are specified (`true` by default) |

[etag]: https://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation
[external outputs]: /doc/user-guide/pipelines/external-dependencies-and-outputs
Expand Down
Loading