Skip to content

Commit 7ab663d

Browse files
committed
ref: clarfy --out option
per #2302 (review)
1 parent 3d10596 commit 7ab663d

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

content/docs/command-reference/add.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ not.
146146
Shell style wildcards supported: `*`, `?`, `[seq]`, `[!seq]`, and `**`
147147

148148
- `-o <path>`, `--out <path>` - destination `path` inside the workspace to place
149-
a data target (instead of using the current working directory). Directories
150-
specified in the path will be created by this command. Note that this can be
151-
used [with an external cache](#straight-to-cache) to avoid using the local
152-
file system.
149+
the data target. By default the data base file name is used in the current
150+
working directory (if this option isn't used). Directories in the given `path`
151+
will be created. Note that for external targets, this can be combined
152+
[with an external cache](#straight-to-cache) to skip the local file system.
153153

154154
- `--to-remote` - allow a target outside of the DVC repository (e.g. an S3
155155
object, SSH directory URL, file on mounted volume, etc.) but don't move it

content/docs/command-reference/get.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ name.
5757
## Options
5858

5959
- `-o <path>`, `--out <path>` - destination `path` to place the downloaded file
60-
or directory (instead of using the current working directory). Directories
61-
specified in the path will be created by this command.
60+
or directory. By default the data base file name is used in the current
61+
working directory (if this option isn't used). Directories in the given `path`
62+
will be created.
6263

6364
- `--rev <commit>` - commit hash, branch or tag name, etc. (any
6465
[Git revision](https://git-scm.com/docs/revisions)) of the repository to

content/docs/command-reference/import.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ repo at `url`) are not supported.
8080
## Options
8181

8282
- `-o <path>`, `--out <path>` - destination `path` inside the workspace to place
83-
the downloaded file or directory (instead of using the current working
84-
directory). Directories specified in the path must already exist, otherwise
85-
this command will fail.
83+
the downloaded file or directory. By default the data base file name is used
84+
in the current working directory (if this option isn't used). Directories in
85+
the given `path` will be created.
8686

8787
- `--file <filename>` - specify a path and/or file name for the `.dvc` file
8888
created by this command (e.g. `--file stages/stage.dvc`). This overrides the

0 commit comments

Comments
 (0)