Skip to content

Commit

Permalink
docs: run: add --always-changed flag
Browse files Browse the repository at this point in the history
  • Loading branch information
efiop committed Sep 9, 2019
1 parent 80a7a69 commit faf567e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
5 changes: 5 additions & 0 deletions static/docs/commands-reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ usage: dvc run [-h] [-q | -v] [-d DEPS] [-o OUTS] [-O OUTS_NO_CACHE]
[-m METRICS] [-M METRICS_NO_CACHE] [-f FILE] [-c CWD]
[-w WDIR] [--no-exec] [-y] [--overwrite-dvcfile]
[--ignore-build-cache] [--remove-outs] [--no-commit]
[--always-changed]
command
positional arguments:
Expand Down Expand Up @@ -143,6 +144,10 @@ pipeline.

> The `dvc status` command will mention that the file is `not in cache`.
- `--always-changed` - always consider this DVC-file as changed. As a result
`dvc status` will report it as `always changed` and `dvc repro` will always
run it.

- `-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
3 changes: 3 additions & 0 deletions static/docs/user-guide/dvc-file-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ the highlighting for your editor.
Here is a sample DVC-file:

```yaml
always_changed: true
locked: true
cmd: python cmd.py input.data output.data metrics.json
deps:
Expand Down Expand Up @@ -51,6 +52,8 @@ On the top level, `.dvc` file consists of these fields:
- `md5`: md5 checksum for this DVC-file
- `locked`: Whether or not this stage is locked from reproduction
- `wdir`: Directory to run command in (default `.`)
- `always_changed`: Whether or not this stage should be always considered as
changed on commands such as `dvc status` and `dvc repro`

A dependency entry consists of a pair of fields:

Expand Down

0 comments on commit faf567e

Please sign in to comment.