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

docs: use --external for add/run #1387

Merged
merged 5 commits into from
Jun 22, 2020
Merged
Show file tree
Hide file tree
Changes from 3 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
7 changes: 5 additions & 2 deletions content/docs/command-reference/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Track data files or directories with DVC, by creating a corresponding
## Synopsis

```usage
usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [-f <filename>]
targets [targets ...]
usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [--external]
[-f <filename>] targets [targets ...]

positional arguments:
targets Input files/directories to add.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -98,6 +98,9 @@ This way you bring data provenance and make your project
when ready to commit outputs with DVC. This is analogous to using `git add`
before `git commit`.

- `--external` - allow `targets` that are outside of the DVC repository. See
[Managing External Data](/doc/user-guide/managing-external-data).

- `-f <filename>`, `--file <filename>` - specify name of the DVC-file it
generates. This option works only if there is a single target. By default the
name of the generated DVC-file is `<target>.dvc`, where `<target>` is the file
Expand Down
5 changes: 4 additions & 1 deletion content/docs/command-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ usage: dvc run [-h] [-q | -v] [-d <path>] [-o <path>] [-O <path>]
[-w <path>] [--no-exec] [--overwrite-dvcfile]
[--no-run-cache] [--no-commit]
[--outs-persist <path>] [--outs-persist-no-cache <path>]
[--always-changed]
[--always-changed] [--external]
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
command

positional arguments:
Expand Down Expand Up @@ -183,6 +183,9 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.)
> Note that DVC-files without dependencies are automatically considered
> "always changed", so this option has no effect in those cases.

- `--external` - allow outputs that are outside of the DVC repository. See
[Managing External Data](/doc/user-guide/managing-external-data).

Comment on lines +243 to +245
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But external dependencies don't require the use of this flag? Hmmm that may be confusing 😕

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, only outs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to iterative/dvc#1545 (comment) now that this is merged. Thanks

- `-h`, `--help` - prints the usage/help message, and exit.

- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
Expand Down
15 changes: 10 additions & 5 deletions content/docs/user-guide/managing-external-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ The default local cache location is `.dvc/cache`, so there is no need to specify
it explicitly.

```dvc
$ dvc add /home/shared/mydata
$ dvc add /home/shared/mydata --external
$ dvc run -d data.txt \
--external \
-o /home/shared/data.txt \
cp data.txt /home/shared/data.txt
```
Expand All @@ -68,10 +69,11 @@ $ dvc remote add sshcache ssh://[email protected]:/cache
$ dvc config cache.ssh sshcache
# Add data on SSH directly
$ dvc add ssh://[email protected]:/mydata
$ dvc add ssh://[email protected]:/mydata --external
# Create the stage with external SSH output
$ dvc run -d data.txt \
--external \
-o ssh://[email protected]:/home/shared/data.txt \
scp data.txt [email protected]:/home/shared/data.txt
```
Expand All @@ -86,10 +88,11 @@ $ dvc remote add s3cache s3://mybucket/cache
$ dvc config cache.s3 s3cache
# Add data on S3 directly
$ dvc add s3://mybucket/mydata
$ dvc add s3://mybucket/mydata --external
# Create the stage with external S3 output
$ dvc run -d data.txt \
--external \
-o s3://mybucket/data.txt \
aws s3 cp data.txt s3://mybucket/data.txt
```
Expand All @@ -104,10 +107,11 @@ $ dvc remote add gscache gs://mybucket/cache
$ dvc config cache.gs gscache
# Add data on GS directly
$ dvc add gs://mybucket/mydata
$ dvc add gs://mybucket/mydata --external
# Create the stage with external GS output
$ dvc run -d data.txt \
--external \
-o gs://mybucket/data.txt \
gsutil cp data.txt gs://mybucket/data.txt
```
Expand All @@ -122,10 +126,11 @@ $ dvc remote add hdfscache hdfs://[email protected]/cache
$ dvc config cache.hdfs hdfscache
# Add data on HDFS directly
$ dvc add hdfs://[email protected]/mydata
$ dvc add hdfs://[email protected]/mydata --external
# Create the stage with external HDFS output
$ dvc run -d data.txt \
--external \
-o hdfs://[email protected]/home/shared/data.txt \
hdfs fs -copyFromLocal \
data.txt \
Expand Down