[Piuparts-devel] RFC: feature/slave-manpages

[Dave Steele]

On Mon, May 27, 2013 at 11:54 AM, Andreas Beckmann <anbe at debian.org> wrote:
> On 2013-05-27 15:59, Holger Levsen wrote:
>> Hi,
>>
>> please comment:
>>
>>   * piuparts-slave.deb: Add piuparts_slave_run.8 and piuparts_slave_join.8
>>     manpages.
>
> ACK for piuparts_slave_join.8
>
> For slave_run you should mention that this interface "... under
> development ..." and may change.
>

What it looks like now:


>From 1548f6ff1b4b51db526c08b0cad364c24b5bc5f0 Mon Sep 17 00:00:00 2001
From: David Steele <dsteele at gmail.com>
Date: Mon, 27 May 2013 12:29:05 -0400
Subject: [PATCH] Edit piuparts_slave_* man pages for more information and
 format.

---
 piuparts_slave_join.8.txt |   11 ++++++++++-
 piuparts_slave_run.8.txt  |    9 ++++++---
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/piuparts_slave_join.8.txt b/piuparts_slave_join.8.txt
index 6f93189..f3dd8d4 100644
--- a/piuparts_slave_join.8.txt
+++ b/piuparts_slave_join.8.txt
@@ -1,5 +1,6 @@
 piuparts_slave_join(8)
 ======================
+:doctype: manpage

 NAME
 ----
@@ -25,9 +26,17 @@ NOTES
 -----
 Make sure to also read */usr/share/doc/piuparts-master/README_server.txt*.

+See *screen*(1) for full instructions on how to navigate between
displays. In short:
+
+*Ctrl-A <n>*::
+    Navigates to display <n>. Slaves are found at screens 1 through
'slave-count', defined in the piuparts configuration file.
+
+*Ctrl-A d*::
+    Detatch from *screen*. The session can be re-established with
*piuparts-slave-join*.
+
 SEE ALSO
 --------
-*piuparts*(1), *piuparts_slave_run*(8)
+*piuparts*(1), *piuparts_slave_run*(8), *screen*(1)

 AUTHOR
 ------
diff --git a/piuparts_slave_run.8.txt b/piuparts_slave_run.8.txt
index cc5a25c..3fd3c5a 100644
--- a/piuparts_slave_run.8.txt
+++ b/piuparts_slave_run.8.txt
@@ -1,5 +1,6 @@
 piuparts_slave_run(8)
 =====================
+:doctype: manpage

 NAME
 ----
@@ -7,11 +8,13 @@ piuparts_slave_run - start up piuparts-slave
instance(s) in screen

 SYNOPSIS
 --------
-*piuparts_slave_run*
+*piuparts_slave_run* ['SLAVE-NUMBERS']

 DESCRIPTION
 -----------
-*piuparts_slave_run* runs piuparts-slave instance(s) in screen which
run *piuparts* tests which test whether Debian packages handle
installation, upgrading, and removal correctly.
+*piuparts_slave_run* runs piuparts-slave instance(s) in *screen*
which run *piuparts* tests which test whether Debian packages handle
installation, upgrading, and removal correctly.
+
+By default, *piuparts_slave_run* will start the number of slaves
specified by the 'slave-count' parameter in the piuparts.conf file. If
'slave-count' is not defined, a single slave will be started. If a
single argument is supplied to *piuparts_slave_run*, consisting of a
space-separated list of numbers between 1 and 'slave-count', only
those slaves will be started.

 OPTIONS
 -------
@@ -27,7 +30,7 @@ Make sure to also read
*/usr/share/doc/piuparts-master/README_server.txt*.

 SEE ALSO
 --------
-*piuparts*(1), *piuparts_slave_join*(8)
+*piuparts*(1), *piuparts_slave_join*(8), *screen*(1)

 AUTHOR
 ------
--
1.7.10.4