Skip to content

Commit

Permalink
Merge pull request iterative#859 from maykulkarni/local-repo-cache-fi…
Browse files Browse the repository at this point in the history
…x-doc

Document for local repo cache import fix
  • Loading branch information
jorgeorpinel authored Dec 18, 2019
2 parents 5af60ee + 13c1128 commit cb95673
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 11 deletions.
12 changes: 7 additions & 5 deletions static/docs/command-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@ single-purpose command that can be used out of the box after installing DVC.
The `url` argument specifies the address of the Git repository containing the
external <abbr>project</abbr>. Both HTTP and SSH protocols are supported for
online repositories (e.g. `[user@]server:project.git`). `url` can also be a
local file system path to an "offline" repository (in this case instead of
downloading, DVC may copy the target data from the external source project or
it's cache).
local file system path to an "offline" repository (in this case and if it
doesn't have a default remote set up, instead of downloading, DVC will try to
copy the target data from the external source project or it's
<abbr>cache</abbr>).

The `path` argument of this command is used to specify the location, within the
source repository at `url`, of the target(s) to be downloaded. It can point to
Expand All @@ -44,8 +45,9 @@ configured in the project, containing the actual data.)

> See `dvc get-url` to download data from other supported URLs.
After running this command successfully, the data found in the `url` `path` is
created in the current working directory, with its original file name.
After running this command successfully, the data found in the `url`, `path`
combination is created in the current working directory, with its original file
name.

## Options

Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Both methods generate an equivalent [stage file](/doc/command-reference/run)
user from having to manually copy files from each of the remote storage schemes,
and from having to install CLI tools for each service.

Note that import stages are considered always "locked", meaning that if you run
Note that import stages are considered always locked, meaning that if you run
`dvc repro`, they won't be updated. Use `dvc update` on them to update the
downloaded file or directory from the external data source.

Expand Down
9 changes: 5 additions & 4 deletions static/docs/command-reference/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@ the data source changes. (See `dvc update`.)
The `url` argument specifies the address of the Git repository containing the
source <abbr>project</abbr>. Both HTTP and SSH protocols are supported for
online repositories (e.g. `[user@]server:project.git`). `url` can also be a
local file system path to an "offline" repository (in this case instead of
downloading, DVC may copy the target data from the external source project or
it's cache).
local file system path to an "offline" repository (in this case and if it
doesn't have a default remote set up, instead of downloading, DVC will try to
copy the target data from the external source project or it's
<abbr>cache</abbr>).

The `path` argument of this command is used to specify the location of the data
to be downloaded within the source project. It should point to a data file or
Expand All @@ -59,7 +60,7 @@ DVC efficiently determining whether the local copy is out of date.
To actually [track the data](https://dvc.org/doc/get-started/add-files),
`git add` (and `git commit`) the import stage.

Note that import stages are considered always "locked", meaning that if you run
Note that import stages are considered always locked, meaning that if you run
`dvc repro`, they won't be updated. Use `dvc update` or
[re-import](#example-fixed-revisions-re-importing) them to update the downloaded
data artifact from the source project.
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ imported file, directory, or <abbr>data artifact</abbr> up to date.
To indicate which import stages to update, we must specify the corresponding
DVC-file `targets` as command arguments.

Note that import stages are considered always "locked", meaning that if you run
Note that import stages are considered always locked, meaning that if you run
`dvc repro`, they won't be updated. `dvc update` is the only command that can
update them.

Expand Down

0 comments on commit cb95673

Please sign in to comment.