From 6f3cdac9fdd5b7f161eb01c25283ef6c75b093bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fe=CC=81lix=20Saparelli?= Date: Fri, 15 Apr 2022 14:43:41 +1200 Subject: [PATCH] Document --project-origin in man --- doc/watchexec.1.ronn | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/watchexec.1.ronn b/doc/watchexec.1.ronn index f1f9fbf..892576a 100644 --- a/doc/watchexec.1.ronn +++ b/doc/watchexec.1.ronn @@ -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` : +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).