Update manpage/README for new "dinitctl stop" semantics.
authorDavin McCall <davmac@davmac.org>
Sat, 27 Jul 2019 06:15:09 +0000 (16:15 +1000)
committerDavin McCall <davmac@davmac.org>
Sat, 27 Jul 2019 06:15:09 +0000 (16:15 +1000)
"dinitctl stop" will now issue an error if dependent services would be
forced to stop. The new --force option can be used to force a service
and dependents to stop.

README.md
doc/manpages/dinitctl.8.m4

index f36e368ef2c30af2fea6af2b15c14c60169ee5a9..ddda24d0c52808bb27118d50b282e8ff629fe7cc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -308,6 +308,9 @@ command by default acts as a "release" that also forces the service to stop
 (although it may then immediately restart, depending on how it and its
 dependents are configured).
 
+If stopping a service would also require a dependent service to stop, a warning
+will be issued and the `--force` option will be required.
+
 Use the "-s" switch to talk the "system" instance of Dinit, rather than a
 personal instance, e.g:
 
index d56e476cc0e8455d2092f60b4501695730e96e6e..c40d70024771b8c93858d5e9e4a901a4c677143a 100644 (file)
@@ -83,17 +83,19 @@ automatically if its dependents stop. If the service is currently stopping it wi
 to stop before it is then restarted.
 .TP
 \fBstop\fR
-Stop the specified service, and remove explicit activation. The service will stop, but may restart
-immediately if any dependents are configured to restart. If the service has dependents only via
-soft dependency links (i.e. \fBwaits-for\fR dependencies) then these links will be broken, so that
-the service will not restart (any other dependencies, however, are retained).
+Stop the specified service, and remove explicit activation. If the service has (non-soft) dependents, an
+error will be displayed unless the \fB\-\-force\fR option is used.
+
+A service with any dependents via soft dependencies will have these dependency links broken when it stops.
 
 The \fBrestart\fR option applied to the stopped service will not by itself cause the service to restart
 when it is stopped via this command. However, a dependent which is configured to restart may
 cause the service itself to restart as a result.
 
 Any pending \fBstart\fR orders are cancelled,
-though a service which is starting might continue its startup before then stopping.
+though a service which is starting will continue its startup before then stopping (unless the service is
+configured to have an interruptible startup or is otherwise at a stage of startup which can be safely
+interrupted).
 .TP
 \fBwake\fR
 Start the specified service, but do not mark it as explicitly activated if it is not already so