Skip to content

Commit

Permalink
feat: Promote edit --watch to stable
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Jan 16, 2024
1 parent 7c117e7 commit c209c2a
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions assets/chezmoi.io/docs/reference/commands/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,15 @@ correctly. This is the default.

## `--watch`

Automatically apply changes when files are saved.

!!! warning

`--watch` is a beta feature with limitations. Known limitations include:

* Only works when `chezmoi edit` is invoked with arguments (i.e.
argument-free `chezmoi edit` is not supported).
* All edited files are applied when any file is saved.
* Only the edited files are watched, not any dependent files (e.g.
`.chezmoitemplates` and `include`d files in templates are not watched).
* Only works on operating systems supported by
[fsnotify](https://github.com/fsnotify/fsnotify).
Automatically apply changes when files are saved, with the following limitations:

* Only available when `chezmoi edit` is invoked with arguments (i.e.
argument-free `chezmoi edit` is not supported).
* All edited files are applied when any file is saved.
* Only the edited files are watched, not any dependent files (e.g.
`.chezmoitemplates` and `include`d files in templates are not watched).
* Only works on operating systems supported by
[fsnotify](https://github.com/fsnotify/fsnotify).

!!! example

Expand Down

0 comments on commit c209c2a

Please sign in to comment.