Skip to content

Commit

Permalink
More misc. updates (#2299)
Browse files Browse the repository at this point in the history
* guide: update Ext Data guide link to add to-cache/remote examples
per #2246 (comment)

* ref: config options copy edits

* ref: destroy copy edit
  • Loading branch information
jorgeorpinel authored Mar 14, 2021
1 parent 2cd74b8 commit 84093cd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 22 deletions.
29 changes: 15 additions & 14 deletions content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ usage: dvc config [-h] [--global | --system | --local] [-q | -v] [-u]
positional arguments:
name Option name in format: section.option or remote.name.option
e.g. 'core.check_update', 'cache.dir', 'remote.myremote.url'
value Option value.
value Option value.
```

## Description
Expand Down Expand Up @@ -187,25 +187,26 @@ This section contains the following options, which affect the project's
for example, they're determined using
[`os.umask`](https://docs.python.org/3/library/os.html#os.umask).

- `cache.local` - name of a _local remote_ to use as a
[custom cache](/doc/user-guide/managing-external-data#examples) directory.
(Refer to `dvc remote` for more information on "local remotes".) This will
overwrite the value provided to `dvc config cache.dir` or `dvc cache dir`.
The following parameters allow setting an
[external cache](/doc/user-guide/managing-external-data#examples) location. A
[DVC remote](/doc/command-reference/remote) name is used (instead of the URL)
because often it's necessary to configure authentication or other connection
settings, and configuring a remote is the way that can be done.

- `cache.s3` - name of an Amazon S3 remote to use as
[external cache](/doc/user-guide/managing-external-data#examples).
- `cache.local` - name of a _local remote_ to use as external cache (refer to
`dvc remote` for more info. on "local remotes".) This will overwrite the value
in `cache.dir` (see `dvc cache dir`).

- `cache.gs` - name of a Google Cloud Storage remote to use as
[external cache](/doc/user-guide/managing-external-data#examples).
- `cache.s3` - name of an Amazon S3 remote to use as external cache.

- `cache.ssh` - name of an SSH remote to use as
[external cache](/doc/user-guide/managing-external-data#examples).
- `cache.gs` - name of a Google Cloud Storage remote to use as external cache.

- `cache.hdfs` - name of an HDFS remote to use as
[external cache](/doc/user-guide/managing-external-data#examples).
- `cache.ssh` - name of an SSH remote to use as external cache.

- `cache.hdfs` - name of an HDFS remote to use as external cache.

- `cache.webhdfs` - name of an HDFS remote with WebHDFS enabled to use as
[external cache](/doc/user-guide/managing-external-data#examples).
external cache.

> Avoid using the same [DVC remote](/doc/command-reference/remote) (used for
> `dvc push`, `dvc pull`, etc.) as external cache, because it may cause file
Expand Down
10 changes: 5 additions & 5 deletions content/docs/command-reference/destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ usage: dvc destroy [-h] [-q | -v] [-f]

## Description

`dvc destroy` removes `dvc.yaml` and `.dvc` files, as well as the internal
`.dvc/` directory from the <abbr>workspace</abbr>.
`dvc destroy` removes `dvc.yaml`, `.dvc` files, and the internal `.dvc/`
directory from the <abbr>project</abbr>.

Note that the <abbr>cache directory</abbr> will be removed as well, unless it's
set to an
Expand Down Expand Up @@ -99,9 +99,9 @@ $ ls -a
.git code.py foo
```

`dvc destroy` command removed `foo.dvc` and the `.dvc/` directory from the
<abbr>workspace</abbr>. But the cache files that are present in `/mnt/cache`
still persist:
`dvc destroy` removed `foo.dvc` and the internal `.dvc/` directory from
<abbr>project</abbr>. But the cache files that are present in `/mnt/cache`
persist:

```dvc
$ tree /mnt/cache
Expand Down
7 changes: 4 additions & 3 deletions content/docs/user-guide/managing-external-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

> ⚠️ This is an advanced feature that we don't recommend using unless you really
> know what you are doing. Artifacts added with --external are not affected by
> `dvc push/pull/status -c`. You are likely looking for
> [straight-to-remote/cache](https://github.com/iterative/dvc/issues/4520)
> functionality or `dvc import-url`
> `dvc push/pull/status -c`. You are likely looking for straight
> [to-cache](/doc/command-reference/add#example-transfer-to-the-cache) or
> [to-remote](/doc/command-reference/add#example-transfer-to-remote-storage)
> transfers, or `dvc import-url`).
There are cases when data is so large, or its processing is organized in such a
way, that its preferable to avoid moving it from its original location. For
Expand Down

0 comments on commit 84093cd

Please sign in to comment.