From 54468958fd54b356a9ed6aedb2b95a1769f145f9 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 3 Jul 2020 15:18:44 -0500 Subject: [PATCH] cmd: add stage example to remove per https://github.com/iterative/dvc.org/pull/1497#issuecomment-650111941 --- content/docs/command-reference/remove.md | 45 +++++++++++++++++++++--- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/content/docs/command-reference/remove.md b/content/docs/command-reference/remove.md index 327230aa66..19b08a3771 100644 --- a/content/docs/command-reference/remove.md +++ b/content/docs/command-reference/remove.md @@ -39,10 +39,10 @@ how it can be used to replace or modify files that are tracked by DVC. - `-v`, `--verbose` - displays detailed tracing information. -## Examples +## Example: remove a tracked file (or directory) -Let's imagine we have `foo.csv` and `bar.csv` files that are already -[tracked](/doc/command-reference/add) with DVC: +Let's imagine we have `foo.csv` and `bar.csv` files, that are already +[tracked](/doc/command-reference/add) by DVC: ```dvc $ ls *.csv* @@ -55,8 +55,8 @@ $ cat .gitignore /foo.csv ``` -Remove the `foo.csv.dvc` file, and check that the data file is gone from -`.gitignore`: +This removed the `foo.csv.dvc` file, and lists `.gitignore` to double check that +the corresponding entry is gone from there: ```dvc $ dvc remove foo.csv.dvc @@ -67,3 +67,38 @@ foo.csv $ cat .gitignore /bar.csv ``` + +> The same procedure applies to tracked directories. + +## Example: remove a stage + +Let's imagine we have a stage named `train` in our +[`dvc.yaml` file](/doc/user-guide/dvc-files-and-directories#dvcyaml-file), and +corresponding files in the workspace: + +```yaml +train: + deps: + - foo.csv + outs: + - model +``` + +```dvc +$ ls +dvc.yaml dvc.lock +... foo.csv model +``` + +Running `dvc remove` on the stage name will remove this entire entry from +`dvc.yaml`, and delete its outputs: + +```dvc +$ dvc remove train +$ ls +dvc.yaml dvc.lock +... foo.csv +``` + +Notice that the dependency `foo.csv` is not removed, since it may be the output +of a previous stage.