Robot
/
watchexec
mirror of https://github.com/watchexec/watchexec.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document --project-origin in man

This commit is contained in:
Félix Saparelli 2022-04-15 14:43:41 +12:00 committed by Félix Saparelli
parent 515d5568b2
commit 6f3cdac9fd
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/watchexec.1.ronn
View File

@ -87,12 +87,17 @@ Skip loading of version control system (VCS) ignore files. By default, watchexec
* `--no-project-ignore`, `--no-ignore` (deprecated alias):
Skip loading of project-local ignore files (include VCS ignore files). By default, watchexec loads .ignore, .gitignore, .hgignore, and other such files in the current directory (or child directories as applicable) and uses them to filter change events.
The `--no-ignore` alias will be replaced by a new option in 2.0.0, beware!
* `--no-default-ignore`:
Skip default ignore statements. By default, watchexec ignores common temporary files for you, for example `*.swp`, `*.pyc`, and `.DS_Store`, as well as the data directories of known VCS: `.bzr`, `_darcs`, `.fossil-settings`, `.git`, `.hg`, `.pijul`, and `.svn`.
* `--no-global-ignore`:
Skip loading of global ignore files. By default, watchexec loads $HOME/.gitignore and other such global files and uses them to filter change events.
* `--project-origin` <path>:
Overrides the project origin, where ignore files are resolved from (see PATHS section below).
* `-v`, `--verbose`, `-vv`, etc:
Prints diagnostic and debugging messages to STDERR. Increase the amount of `v`s to get progressively more output: for bug reports use **three**, and for deep debugging **four** can be helpful.
@ -120,6 +125,8 @@ The overall project origin is used to find and resolve ignore files, such that i
For this reason, it is not recommended to use Watchexec for watching disparate folders in a filesystem, where those would resolve to a too-broad project origin.
The project origin can be overridden with the `--project-origin` option.
## ENVIRONMENT
In variables that contain lists of paths, the separator is as for the `$PATH` environment variable (a colon, or semicolon on Windows).