Skip to content

Commit

Permalink
cmd: separate note about push/pull not changing or saving DVC metafiles
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Aug 16, 2020
1 parent 9af40e9 commit 4717b78
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 23 deletions.
32 changes: 17 additions & 15 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,23 @@ positional arguments:

## Description

The `dvc pull` and `dvc push` commands are the means for uploading and
The `dvc push` and `dvc pull` commands are the means for uploading and
downloading data to and from remote storage (S3, SSH, GCS, etc.). These commands
are similar to `git pull` and `git push`, respectively.

are similar to `git push` and `git pull`, respectively.
[Data sharing](/doc/use-cases/sharing-data-and-model-files) across environments
and preserving data versions (input datasets, intermediate results, models,
[metrics](/doc/command-reference/metrics), etc) remotely are the most common use
cases for these commands.
[metrics](/doc/command-reference/metrics), etc.) remotely are the most common
use cases for these commands.

`dvc pull` downloads data from [remote storage](/doc/command-reference/remote)
and places it in the <abbr>workspace</abbr>. It has the same effect as running
`dvc fetch` and `dvc checkout`.

The `dvc pull` command downloads data from
[remote storage](/doc/command-reference/remote) and places it in the
<abbr>workspace</abbr>. `dvc pull` has the same effect as running `dvc fetch`
and `dvc checkout`.
> Note that pulling data does not change any `dvc.yaml` or `.dvc` files, nor
> does it save any changes to the code, `dvc.lock`, or `.dvc` files (that should
> be saved with `git commit` and `git push`).
The default remote is used (see `dvc config core.remote`) unless the `--remote`
The default remote is used (see `dvc remote default`) unless the `--remote`
option is used. See `dvc remote` for more information on how to configure a
remote.

Expand All @@ -45,13 +47,13 @@ The `targets` given to this command (if any) 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`).

After the data is in the cache, `dvc pull` uses OS-specific mechanisms like
reflinks or hardlinks to put it in the workspace, trying to avoid copying. See
`dvc checkout` for more details.
After the data is in the <abbr>cache</abbr>, `dvc pull` uses OS-specific
mechanisms like reflinks or hardlinks to put it in the workspace, trying to
avoid copying. See `dvc checkout` for more details.

Note that the command `dvc status -c` can list files referenced in current
stages (in `dvc.yaml`) or `.dvc` files, but missing from the <abbr>cache</abbr>.
It can be used to see what files `dvc pull` would download.
stages (in `dvc.yaml`) or `.dvc` files, but missing from the cache. It can be
used to see what files `dvc pull` would download.

## Options

Expand Down
16 changes: 8 additions & 8 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ positional arguments:

## Description

The `dvc pull` and `dvc push` commands are the means for uploading and
The `dvc push` and `dvc pull` commands are the means for uploading and
downloading data to and from remote storage (S3, SSH, GCS, etc.). These commands
are similar to `git pull` and `git push`, respectively.

are similar to `git push` and `git pull`, respectively.
[Data sharing](/doc/use-cases/sharing-data-and-model-files) across environments,
and preserving data versions (input datasets, intermediate results, models,
[metrics](/doc/command-reference/metrics), etc.) remotely are the most common
use cases for these commands.

The `dvc push` command uploads data to
[remote storage](/doc/command-reference/remote). It doesn't save any changes to
the code, `dvc.yaml`, or `.dvc` files (that should be saved with `git commit`
and `git push`).
`dvc push` uploads data to [remote storage](/doc/command-reference/remote).

> Note that pushing data does not change any `dvc.yaml` or `.dvc` files, nor
> does it save any changes to the code, `dvc.lock`, or `.dvc` files (that should
> be saved with `git commit` and `git push`).
The default remote is used (see `dvc config core.remote`) unless the `--remote`
The default remote is used (see `dvc remote default`) unless the `--remote`
option is used. See `dvc remote` for more information on how to configure a
remote.

Expand Down

0 comments on commit 4717b78

Please sign in to comment.