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

doc: fix --on-busy-update help text (#825)

This commit is contained in:
Félix Saparelli 2024-04-23 14:44:59 +12:00 committed by GitHub
parent d388a280f0
commit a4df258735
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 18 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
crates/cli/src/args.rs
View File

@ -145,17 +145,14 @@ pub struct Args {
/// What to do when receiving events while the command is running /// What to do when receiving events while the command is running
/// ///
/// Default is to 'queue' up events and run the command once again when the previous run has /// Default is to 'do-nothing', which ignores events while the command is running, so that
/// finished. You can also use 'do-nothing', which ignores events while the command is running /// changes that occur due to the command are ignored, like compilation outputs. You can also
/// and may be useful to avoid spurious changes made by that command, or 'restart', which /// use 'queue' which will run the command once again when the current run has finished if any
/// terminates the running command and starts a new one. Finally, there's 'signal', which only /// events occur while it's running, or 'restart', which terminates the running command and starts
/// sends a signal; this can be useful with programs that can reload their configuration without /// a new one. Finally, there's 'signal', which only sends a signal; this can be useful with
/// a full restart. /// programs that can reload their configuration without a full restart.
/// ///
/// The signal can be specified with the '--signal' option. /// The signal can be specified with the '--signal' option.
///
/// Note that this option is scheduled to change its default to 'do-nothing' in the next major
/// release. File an issue if you have any concerns.
#[arg( #[arg(
short, short,
long, long,

8
doc/watchexec.1
View File

@ -1,6 +1,6 @@
.ie \n(.g .ds Aq \(aq .ie \n(.g .ds Aq \(aq
.el .ds Aq ' .el .ds Aq '
.TH watchexec 1 "watchexec 1.25.1" .TH watchexec 1 "watchexec 2.0.0"
.SH NAME .SH NAME
watchexec \- Execute commands when watched files change watchexec \- Execute commands when watched files change
.SH SYNOPSIS .SH SYNOPSIS
@ -56,11 +56,9 @@ If this doesn\*(Aqt completely clear the screen, try \*(Aq\-\-clear=reset\*(Aq.
\fB\-o\fR, \fB\-\-on\-busy\-update\fR=\fIMODE\fR \fB\-o\fR, \fB\-\-on\-busy\-update\fR=\fIMODE\fR
What to do when receiving events while the command is running What to do when receiving events while the command is running
Default is to \*(Aqqueue\*(Aq up events and run the command once again when the previous run has finished. You can also use \*(Aqdo\-nothing\*(Aq, which ignores events while the command is running and may be useful to avoid spurious changes made by that command, or \*(Aqrestart\*(Aq, which terminates the running command and starts a new one. Finally, there\*(Aqs \*(Aqsignal\*(Aq, which only sends a signal; this can be useful with programs that can reload their configuration without a full restart. Default is to \*(Aqdo\-nothing\*(Aq, which ignores events while the command is running, so that changes that occur due to the command are ignored, like compilation outputs. You can also use \*(Aqqueue\*(Aq which will run the command once again when the current run has finished if any events occur while it\*(Aqs running, or \*(Aqrestart\*(Aq, which terminates the running command and starts a new one. Finally, there\*(Aqs \*(Aqsignal\*(Aq, which only sends a signal; this can be useful with programs that can reload their configuration without a full restart.
The signal can be specified with the \*(Aq\-\-signal\*(Aq option. The signal can be specified with the \*(Aq\-\-signal\*(Aq option.
Note that this option is scheduled to change its default to \*(Aqdo\-nothing\*(Aq in the next major release. File an issue if you have any concerns.
.TP .TP
\fB\-r\fR, \fB\-\-restart\fR \fB\-r\fR, \fB\-\-restart\fR
Restart the process if it\*(Aqs still running Restart the process if it\*(Aqs still running
@ -577,6 +575,6 @@ Use @argfile as first argument to load arguments from the file \*(Aqargfile\*(Aq
Didn\*(Aqt expect this much output? Use the short \*(Aq\-h\*(Aq flag to get short help. Didn\*(Aqt expect this much output? Use the short \*(Aq\-h\*(Aq flag to get short help.
.SH VERSION .SH VERSION
v1.25.1 v2.0.0
.SH AUTHORS .SH AUTHORS
Félix Saparelli <felix@passcod.name>, Matt Green <mattgreenrocks@gmail.com> Félix Saparelli <felix@passcod.name>, Matt Green <mattgreenrocks@gmail.com>

20
doc/watchexec.1.md
View File

@ -92,19 +92,17 @@ If this doesnt completely clear the screen, try \--clear=reset.
: What to do when receiving events while the command is running : What to do when receiving events while the command is running
Default is to queue up events and run the command once again when the Default is to do-nothing, which ignores events while the command is
previous run has finished. You can also use do-nothing, which ignores running, so that changes that occur due to the command are ignored, like
events while the command is running and may be useful to avoid spurious compilation outputs. You can also use queue which will run the command
changes made by that command, or restart, which terminates the running once again when the current run has finished if any events occur while
command and starts a new one. Finally, theres signal, which only sends a its running, or restart, which terminates the running command and starts
signal; this can be useful with programs that can reload their a new one. Finally, theres signal, which only sends a signal; this can
configuration without a full restart. be useful with programs that can reload their configuration without a
full restart.
The signal can be specified with the \--signal option. The signal can be specified with the \--signal option.
Note that this option is scheduled to change its default to do-nothing
in the next major release. File an issue if you have any concerns.
**-r**, **\--restart** **-r**, **\--restart**
: Restart the process if its still running : Restart the process if its still running
@ -852,7 +850,7 @@ Didnt expect this much output? Use the short -h flag to get short help.
# VERSION # VERSION
v1.25.1 v2.0.0
# AUTHORS # AUTHORS