Skip to content

Commit 9df0605

Browse files
authored
docs(stdio): put --log before the task name in the example (#874)
## Motivation `docs/stdio.md` shows `vp run build --log=<mode>`. `vp run` stops reading its own flags at the task name, so that command passes `--log=<mode>` to the task and keeps the default output mode: ``` $ vt run build --log=labeled $ vtt print built --log=labeled ⊘ cache disabled built --log=labeled ``` ## Changes - Show `vp run --log=<mode> build`. - Say that arguments after the task name go to the task.
1 parent a3c087a commit 9df0605

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

‎docs/stdio.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ How stdin, stdout, and stderr are connected to task processes, controlled by the
55
## The `--log` Flag
66

77
```
8-
vp run build --log=<mode>
8+
vp run --log=<mode> build
99
```
1010

11+
The flag goes before the task name. Anything after the task name is passed to the task, so `vp run build --log=grouped` runs the task's command with `--log=grouped` appended.
12+
1113
| Mode | Description |
1214
| --------------------------- | ----------------------------------------------------------------------------- |
1315
| `interleaved` **(default)** | Output streams directly to the terminal as tasks produce it. |

0 commit comments

Comments
 (0)