Browse Source

Update documentation regarding pinning

Davin McCall 3 years ago
parent
commit
6249384b0d
2 changed files with 14 additions and 8 deletions
  1. 3 4
      TODO
  2. 11 4
      doc/manpages/dinitctl.8.m4

+ 3 - 4
TODO

@@ -1,6 +1,6 @@
 For version 0.9.1
 For version 0.9.1
 -----------------
 -----------------
-* update docs re pinning
+* [DONE] update docs re pinning
 * control protocol: START: add response case for not starting because pinned in stopped
 * control protocol: START: add response case for not starting because pinned in stopped
 * make sure process/bgprocess correctly handle stop when the process has already died
 * make sure process/bgprocess correctly handle stop when the process has already died
   (i.e. when pinned-started but process died)
   (i.e. when pinned-started but process died)
@@ -8,10 +8,9 @@ For version 0.9.1
 
 
 For version 0.10.0:
 For version 0.10.0:
 -------------------
 -------------------
-* Check that desired_state is getting set correctly. (Currently we don't decide whether a service
-  will restart until it stops...)
+* [DONE] Check that desired_state is getting set correctly. (Currently we don't decide whether a
+  service will restart until it stops...)
 * for non-system init, fail to start if the control socket exists
 * for non-system init, fail to start if the control socket exists
-* fail to start if control socket already exists (unless running as system mgr)
 
 
 For version 0.11.+:
 For version 0.11.+:
 ------------------
 ------------------

+ 11 - 4
doc/manpages/dinitctl.8.m4

@@ -81,8 +81,15 @@ Suppress status output, except for errors.
 Do not wait for issued command to complete; exit immediately.
 Do not wait for issued command to complete; exit immediately.
 .TP
 .TP
 \fB\-\-pin\fR
 \fB\-\-pin\fR
-Pin the service in the requested state. The service will not leave the state until it is unpinned, although
-start/stop commands will be "remembered" while the service is pinned.
+Pin the service in the requested state. The service will not leave the state until it is unpinned.
+
+A service that is pinned stopped cannot be marked active, that is, start commands issued to the
+service have no effect. Dependents (via hard dependency relationships) of the pinned service will
+be unable to start.
+
+A service that is pinned started cannot be stopped, however its explicit activation can be removed
+(eg via the \fBstop\fR or \fBrelease\fR commands). Once unpinned, a service which is not explicitly
+activated, and which has no active dependents, will automatically stop.
 .TP
 .TP
 \fB\-\-force\fR
 \fB\-\-force\fR
 Stop the service even if it will require stopping other services which depend on the specified service.
 Stop the service even if it will require stopping other services which depend on the specified service.
@@ -101,7 +108,7 @@ error will be displayed unless the \fB\-\-force\fR option is used.
 
 
 The \fBrestart\fR option (see \fBdinit-service\fR(5)) applied to the stopped service will not cause the
 The \fBrestart\fR option (see \fBdinit-service\fR(5)) applied to the stopped service will not cause the
 service to restart when it is stopped via this command (that is, this command inhibits automatic restart).
 service to restart when it is stopped via this command (that is, this command inhibits automatic restart).
-This also applies to dependents that must also be stopped.
+This also applies to any dependents that must also be stopped at the same time.
 
 
 Any pending \fBstart\fR orders are cancelled,
 Any pending \fBstart\fR orders are cancelled,
 though a service which is starting will continue its startup before then stopping (unless the service is
 though a service which is starting will continue its startup before then stopping (unless the service is
@@ -114,7 +121,7 @@ activation status or dependency links from dependents.
 .TP
 .TP
 \fBwake\fR
 \fBwake\fR
 Start the specified service after reattaching dependency links from all active dependents of the specified
 Start the specified service after reattaching dependency links from all active dependents of the specified
-service. The service will not be marked explicitly activated, and so will stop if the dependents stop.
+service. The service will not be marked explicitly activated, and so will stop if all the dependents stop.
 .TP
 .TP
 \fBrelease\fR
 \fBrelease\fR
 Clear the explicit activation mark from a service (the service will then stop if it has no active dependents).
 Clear the explicit activation mark from a service (the service will then stop if it has no active dependents).