diff --git a/content/docs/command-reference/add.md b/content/docs/command-reference/add.md index 4d49e0c9fe8..7ea479b1e19 100644 --- a/content/docs/command-reference/add.md +++ b/content/docs/command-reference/add.md @@ -7,7 +7,7 @@ file. ```usage usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [--external] - [--file ] [--glob] + [--file ] [--glob] [--desc ] targets [targets ...] positional arguments: @@ -148,6 +148,8 @@ directory symlinks. pattern as specified by `target`. Shell-style wildcards are supported: `*`, `?`, `[seq]`, `[!seq]`, and `**`. +- `--desc` - arbitrary string description for generated `.dvc` file. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 8eb6714f81b..d27a693259e 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -12,7 +12,7 @@ usage: dvc run [-h] [-q | -v] -n [-d ] [-o ] [-w ] [--no-exec] [-f] [--no-run-cache] [--no-commit] [--outs-persist ] [--outs-persist-no-cache ] - [--always-changed] [--external] + [--always-changed] [--external] [--desc ] command positional arguments: @@ -263,6 +263,8 @@ $ dvc run -n my_stage './my_script.sh $MYENVVAR' - `--external` - allow outputs that are outside of the DVC repository. See [Managing External Data](/doc/user-guide/managing-external-data). +- `--desc` - arbitrary string description for this stage. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/user-guide/dvc-files-and-directories.md b/content/docs/user-guide/dvc-files-and-directories.md index 7f95efb29df..01abf42a526 100644 --- a/content/docs/user-guide/dvc-files-and-directories.md +++ b/content/docs/user-guide/dvc-files-and-directories.md @@ -34,6 +34,7 @@ They use a simple [YAML](https://yaml.org/) format, meant to be easy to read, edit, or even created manually. Here is a sample: ```yaml +desc: cats and dogs dataset outs: - md5: a304afb96060aad90176268345e10355 path: data.xml @@ -60,6 +61,7 @@ meta: - `meta` (optional): Arbitrary metadata can be added manually with this field. Any YAML contents is supported. `meta` contents are ignored by DVC, but they can be meaningful for user processes that read `.dvc` files. +- `desc` (optional): Arbitrary string description for this `.dvc` file. An _output entry_ (`outs`) consists of these fields: @@ -128,6 +130,7 @@ stages: metrics: - performance.json training: + desc: train your model cmd: python train.py deps: - train.py @@ -173,6 +176,7 @@ the possible following fields: - `meta` (optional): Arbitrary metadata can be added manually with this field. Any YAML contents is supported. `meta` contents are ignored by DVC, but they can be meaningful for user processes that read or write `.dvc` files directly. +- `desc` (optional): Arbitrary string description for this stage. `dvc.yaml` files also support `# comments`.