Skip to content

params: document --targets option #2031

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.

Sign up for GitHub

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

Merged
shcheklein merged 3 commits into from
Dec 21, 2020
Merged

params: document --targets option #2031

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e86eb11
params: document --targets option
pared Dec 18, 2020
42c61b5
Update content/docs/command-reference/params/diff.md
pared Dec 21, 2020
2064cce
Restyled by prettier (#2042)
restyled-io[bot] Dec 21, 2020
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
17 changes: 16 additions & 1 deletion content/docs/command-reference/params/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ commits in the <abbr>DVC repository</abbr>, or between a commit and the
## Synopsis

```usage
usage: dvc params diff [-h] [-q | -v] [--all] [--show-json] [--show-md]
usage: dvc params diff [-h] [-q | -v] [--targets [<path> [<path> ...]]]
[--all] [--show-json] [--show-md] [--no-path]
[a_rev] [b_rev]

positional arguments:
Expand Down Expand Up @@ -35,6 +36,20 @@ itself does not ascribe any specific meaning for these values.

## Options

- `--targets <paths>` - limit command scope to these params files. When
specifying arguments for `--targets` before `revisions`, you should use `--`
after this option's arguments, e.g.:

```dvc
$ dvc params diff --targets m1.json m2.yaml -- HEAD v1
```

Alternatively, you can also run the above statement as:

```dvc
$ dvc params diff HEAD v1 --targets m1.json m2.json
```

- `--all` - prints all parameters including not changed.

- `--show-json` - prints the command's output in easily parsable JSON format,
Expand Down