Skip to content

Commit

Permalink
move each command to a node so it appears in the TOC
Browse files Browse the repository at this point in the history
This also uses menu-entry-name vs. node-name to disambiguate the 'start'
and 'stop' subcommands of 'buildbot' and 'buildslave'
  • Loading branch information
Dustin J. Mitchell committed Aug 20, 2010
1 parent 44e9de9 commit fe752d3
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions master/docs/cmdline.texinfo
Expand Up @@ -64,7 +64,15 @@ developers who are editing the code that the buildbot is monitoring.
The following @command{buildbot} sub-commands are intended for
buildmaster administrators:

@heading create-master
@menu
* create-master::
* start: start (buildbot).
* stop: stop (buildbot).
* sighup::
@end menu

@node create-master
@subsubsection create-master

This creates a new directory and populates it with files that allow it
to be used as a buildmaster's base directory.
Expand All @@ -77,7 +85,8 @@ editing this file.
buildbot create-master -r BASEDIR
@end example

@heading start
@node start (buildbot)
@subsubsection start

This starts a buildmaster which was already created in the given base
directory. The daemon is launched in the background, with events logged
Expand All @@ -87,15 +96,17 @@ to a file named @file{twistd.log}.
buildbot start BASEDIR
@end example

@heading stop
@node stop (buildbot)
@subsubsection stop

This terminates the buildmaster running in the given directory.

@example
buildbot stop BASEDIR
@end example

@heading sighup
@node sighup
@subsubsection sighup

This sends a SIGHUP to the buildmaster running in the given directory,
which causes it to re-read its @file{master.cfg} file.
Expand Down Expand Up @@ -677,7 +688,14 @@ the requested build to complete.
only and does not provide any additional functionality. One can create,
start, stop and restart the buildslave.

@heading create-slave
@menu
* create-slave::
* start: start (buildslave).
* stop: stop (buildslave).
@end menu

@node create-slave
@subsection create-slave

This creates a new directory and populates it with files that let it
be used as a buildslave's base directory. You must provide several
Expand All @@ -692,7 +710,8 @@ buildslave create-slave -r @var{BASEDIR} @var{MASTERHOST}:@var{PORT} @var{SLAVEN

The create-slave options are described in @xref{Buildslave Options}.

@heading start
@node start (buildslave)
@subsection start

This starts a buildslave which was already created in the given base
directory. The daemon is launched in the background, with events logged
Expand All @@ -702,7 +721,8 @@ to a file named @file{twistd.log}.
buildbot start BASEDIR
@end example

@heading stop
@node stop (buildslave)
@subsection stop

This terminates the daemon buildslave running in the given directory.

Expand Down

0 comments on commit fe752d3

Please sign in to comment.