Skip to content

Commit d4e26e6

Browse files
committed
docs(sync): Note repos not found behavior
1 parent 0576a16 commit d4e26e6

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

docs/cli/sync.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,35 @@
66

77
## Error handling
88

9+
### Repos not found in config
10+
11+
As of 1.13.x, if you enter a repo term (or terms) that aren't found throughout
12+
your configurations, it will show a warning:
13+
14+
```console
15+
$ vcspull sync non_existent_repo
16+
No repo found in config(s) for "non_existent_repo"
17+
```
18+
19+
```console
20+
$ vcspull sync non_existent_repo existing_repo
21+
No repo found in config(s) for "non_existent_repo"
22+
```
23+
24+
```console
25+
$ vcspull sync non_existent_repo existing_repo another_repo_not_in_config
26+
No repo found in config(s) for "non_existent_repo"
27+
No repo found in config(s) for "another_repo_not_in_config"
28+
```
29+
30+
Since syncing terms are treated as a filter rather than a lookup, the message is
31+
considered a warning, so will not exit even if `--exit-on-error` flag is used.
32+
33+
### Syncing
34+
935
As of 1.13.x, vcspull will continue to the next repo if an error is encountered when syncing multiple repos.
1036

11-
To imitate the old behavior, use `--exit-on-error` / `-x`:
37+
To imitate the old behavior, the `--exit-on-error` / `-x` flag:
1238

1339
```console
1440
$ vcspull sync --exit-on-error grako django

0 commit comments

Comments
 (0)