From cb80e026d0f5cb6cd28dc7a579139f79e395f5c4 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 5 Aug 2020 17:33:38 -0500 Subject: [PATCH] cmd: mention external deps/outs as a bullet in run notes per https://github.com/iterative/dvc.org/pull/1662#pullrequestreview-462062653 --- content/docs/command-reference/run.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 3d391ccddf..de9e3751d6 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -73,10 +73,10 @@ $ dvc run -n printer -d write.sh -o pages ./write.sh $ dvc run -n scanner -d read.sh -d pages -o signed.pdf ./read.sh ``` -Stage dependencies can be any file in the workspace, either untracked, or much -more commonly, tracked by DVC or Git. Outputs will be tracked and -cached by DVC when the stage is run. Every output version will be -cached when the stage is reproduced (see also `dvc gc`). +Stage dependencies can be any file or directory, either untracked, or more +commonly tracked by DVC or Git. Outputs will be tracked and cached +by DVC when the stage is run. Every output version will be cached when the stage +is reproduced (see also `dvc gc`). Relevant notes: @@ -97,10 +97,14 @@ Relevant notes: [Structure of cache directory](/doc/user-guide/dvc-files-and-directories#structure-of-the-cache-directory) for more info.) -- Outputs are deleted from the workspace before executing the - command (including at `dvc repro`) if their paths are found as existing - files/directories. This also means that the stage command needs to recreate - any directory structures defined as outputs every time its executed by DVC. +- [external dependencies](/doc/user-guide/external-dependencies) and + [external outputs](/doc/user-guide/managing-external-data) (outside of the + workspace) are also supported. + +- Outputs are deleted from the workspace before executing the command (including + at `dvc repro`) if their paths are found as existing files/directories. This + also means that the stage command needs to recreate any directory structures + defined as outputs every time its executed by DVC. ### For displaying and comparing data science experiments