Merge lp:~lool/upstart/document-stop-in-pre-start into lp:upstart

[Loïc Minier]

Hey,

Wondered why documentation wasn't symmetric and also why stop/start without argument wasn't mentioned from their manpages, so submitting these proposed fixes.

Cheers,

[James Hunt (jamesodhunt)]

Thanks Loïc - looks good.

review: Approve

[Loïc Minier (lool)]

I can't land this myself; would you be so kind to merge it into lp:upstart? (permission error when I try to do so myself)

[James Hunt (jamesodhunt)]

Done. Thanks again!

=== modified file 'init/man/init.5'
--- init/man/init.5	2012-03-01 12:18:25 +0000
+++ init/man/init.5	2012-03-04 23:36:31 +0000
@@ -195,7 +195,10 @@
 This process will be run after the job's
 .BR starting (7)
 event has finished, but before the main process is run.  It is typically
-used to prepare the environment, such as making necessary directories.
+used to prepare the environment, such as making necessary directories,
+and it may also call the
+.BR stop (8)
+command without arguments to cancel the start.
 .\"
 .TP
 .B post\-start exec\fR|\fBscript\fR...

=== modified file 'util/man/initctl.8'
--- util/man/initctl.8	2012-02-16 15:45:41 +0000
+++ util/man/initctl.8	2012-03-04 23:36:31 +0000
@@ -139,6 +139,13 @@
 If the job is already running,
 .B start
 will return an error.
+
+When called from the
+.IR pre\-stop
+stanza of a job configuration,
+.B start
+may be called without argument to cancel the
+.B stop.
 .\"
 .TP
 .B stop
@@ -155,6 +162,13 @@
 for a description of the output format and
 .B start
 for a discussion on instances.
+
+When called from the
+.IR pre\-start
+stanza of a job configuration,
+.B stop
+may be called without an argument to cancel the
+.B start.
 .\"
 .TP
 .B restart