diff --git a/crates/cli/src/args.rs b/crates/cli/src/args.rs index 4f1065e..581139b 100644 --- a/crates/cli/src/args.rs +++ b/crates/cli/src/args.rs @@ -145,17 +145,14 @@ pub struct Args { /// 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 - /// finished. You can also use 'do-nothing', which ignores events while the command is running - /// and may be useful to avoid spurious changes made by that command, or 'restart', which - /// terminates the running command and starts a new one. Finally, there's 'signal', which only - /// sends a signal; this can be useful with programs that can reload their configuration without - /// a full restart. + /// Default is to 'do-nothing', 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 'queue' which will run the command once again when the current run has finished if any + /// events occur while it's running, or 'restart', which terminates the running command and starts + /// a new one. Finally, there's 'signal', 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 '--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( short, long, diff --git a/doc/watchexec.1 b/doc/watchexec.1 index b4831f7..6314178 100644 --- a/doc/watchexec.1 +++ b/doc/watchexec.1 @@ -1,6 +1,6 @@ .ie \n(.g .ds Aq \(aq .el .ds Aq ' -.TH watchexec 1 "watchexec 1.25.1" +.TH watchexec 1 "watchexec 2.0.0" .SH NAME watchexec \- Execute commands when watched files change .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 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. - -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 \fB\-r\fR, \fB\-\-restart\fR 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. .SH VERSION -v1.25.1 +v2.0.0 .SH AUTHORS Félix Saparelli , Matt Green diff --git a/doc/watchexec.1.md b/doc/watchexec.1.md index 149887b..8212b9b 100644 --- a/doc/watchexec.1.md +++ b/doc/watchexec.1.md @@ -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 -Default is to queue up events and run the command once again when the -previous run has finished. You can also use do-nothing, which ignores -events while the command is running and may be useful to avoid spurious -changes made by that command, or restart, which terminates the running -command and starts a new one. Finally, theres signal, which only sends a -signal; this can be useful with programs that can reload their -configuration without a full restart. +Default is to do-nothing, 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 queue which will run the command +once again when the current run has finished if any events occur while +its running, or restart, which terminates the running command and starts +a new one. Finally, theres signal, 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 \--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** : 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 -v1.25.1 +v2.0.0 # AUTHORS