[Piuparts-commits] [SCM] piuparts git repository branch, develop, updated. 0.52-18-g16393b8

Tue May 28 12:12:37 UTC 2013

The following commit has been merged in the develop branch:
commit 16393b84636fee957e14e23809ca0ca62a8d57ec
Author: Holger Levsen <holger at layer-acht.org>
Date:   Tue May 28 14:12:31 2013 +0200

    piuparts.1.txt, README.txt and README_pejacevic.txt: proof-read and cleaned up.

diff --git a/README.txt b/README.txt
index 3ef0b17..8ca0553 100644
--- a/README.txt
+++ b/README.txt
@@ -49,7 +49,7 @@ squeeze, you can do so with:
 ----
 
 By default, this will read the first mirror from your
-'/etc/apt/sources.list ' file. If you want to specify a different
+'/etc/apt/sources.list' file. If you want to specify a different
 mirror you can do it with the option '-m':
 
 ----
diff --git a/README_pejacevic.txt b/README_pejacevic.txt
index 8f43daa..20159f2 100644
--- a/README_pejacevic.txt
+++ b/README_pejacevic.txt
@@ -12,8 +12,7 @@ piuparts-master and piuparts-slaves packages as described in
 
 piuparts.debian.org is a setup running on two systems: pejacevic.debian.org,
 running the piuparts-master instance and an apache webserver to display the
-results and piu-slave-bm-a.debian.org, running a piuparts-slave node.
-Hopefully soon there should be several slave-nodes running on that system.
+results and piu-slave-bm-a.debian.org, running four piuparts-slave nodes.
 
 === piuparts installation from source
 
@@ -34,7 +33,7 @@ Hopefully soon there should be several slave-nodes running on that system.
 
 === User setup
 
-On pejacevic the piuparts-master user piuaprtsm needs to be installed, on
+On pejacevic the piuparts-master user piupartsm needs to be installed, on
 piu-slave-bm-a a piupartss user is needed for the slave.
 Both are members of the group piuparts and '/srv/piuparts.debian.org' needs to
 be chmod 2775 and chown piuparts(sm):piuparts.
@@ -128,25 +127,27 @@ holger at piu-slave-bm-a$ sudo su - piupartss update-piuparts-slave-setup bikeshed
 
 === Running piuparts
 
-==== Starting and stopping the slave
+==== Starting and stopping the slaves
 
-Run the following script under *your* user account you will start
+Run the following script under *your* user account to start four instances of
 piuparts-slave on pejacevic, piuparts-master will be started automatically by
-the slave.
+the slaves.
 
 ----
 holger at pejacevic:~$ sudo -u piupartss -i slave_run
 ----
 
 There are several cronjobs installed via '~piupartsm/crontab' and
-'~piupartss/crontab') which monitor the slave and the host it's running on.
+'~piupartss/crontab') which monitor the slaves and the hosts it's running on.
 
-It's possible to kill the slave any time by pressing Ctrl-C.
+It's possible to kill a slave any time by pressing Ctrl-C.
 Pressing Ctrl-C once will wait for the current test to finish,
 pressing twice will abort the currently running test (which will be redone).
 Clean termination may take some time and can be aborted by a third Ctrl-C,
 but that may leave temporary directories and processes around.
 
+See the 'piuparts_slave_run (8)' manpage for more information on 'slave_run'.
+
 ==== Joining an existing slave session
 
 Run the following script under *your* user account:
@@ -155,6 +156,8 @@ Run the following script under *your* user account:
 holger at pejacevic:~$ sudo -u piupartss -i slave_join
 ----
 
+See the 'piuparts_slave_join (8)' manpage for more information on 'slave_join'.
+
 === Filing bugs
 
 Use the following usertags:
@@ -166,7 +169,7 @@ Usertags: piuparts piuparts.d.o
 
 === Generating reports for the website
 
-'piuparts-report' is run daily five minutes after midnight from
+'piuparts-report' is run daily at midnight and at noon from
 '~piupartsm/crontab' on pejacevic.
 
 === Cronjobs to aid problem spotting
@@ -186,6 +189,6 @@ More checks should be added as we become aware of them.
 
 Last updated: May 2013
 
-Holger Levsen <holger at debian.org>
+Holger Levsen <holger at layer-acht.org>
 
 // vim: set filetype=asciidoc:
diff --git a/TODO b/TODO
index 733c917..08e8b3e 100644
--- a/TODO
+++ b/TODO
@@ -1,4 +1,4 @@
-things to do for piuparts
+Things to do for piuparts
 =========================
 
 Please also check the BTS, especially the bugs with a severity higher than
@@ -23,6 +23,11 @@ for 0.5x:
     + the current method only works if -slave is configured after -master
     - maybe do this manually again as well?
 
+- Documentation related:
+  - Move master-slave related documentation from README.txt to README_server.txt
+    and leave a pointer in the former. Link README_server.html on piuparts.d.o.
+  - examples are duplicated in piuparts.1.txt and README.txt - only keep one copy.
+
 - in maintainer view:
   - sort buggy states up again
   - sort packages on maintainer pages alphabetically (states first though)
@@ -46,8 +51,6 @@ for 0.5x:
 
 - maybe compress all logfiles
 
-- re-read all documentation carefully and update were needed.
-
 - move counts.txt from htdocs to master
 
 
diff --git a/debian/changelog b/debian/changelog
index af6b0ac..2d0f41d 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -28,6 +28,10 @@ piuparts (0.53) UNRELEASED; urgency=low
   * Edit piuparts_slave_* man pages for more information and format.
   * Specify the manpage doctype for AsciiDoc man sources.
 
+  [ Holger Levsen ]
+  * piuparts.1.txt, README.txt and README_pejacevic.txt: proof-read and
+    cleaned up.
+
  -- Andreas Beckmann <anbe at debian.org>  Mon, 27 May 2013 18:24:27 +0200
 
 piuparts (0.52) unstable; urgency=low
diff --git a/piuparts-report.py b/piuparts-report.py
index 948d5d3..668f9eb 100644
--- a/piuparts-report.py
+++ b/piuparts-report.py
@@ -214,7 +214,7 @@ HTML_FOOTER = """
    <a href="http://packages.qa.debian.org/piuparts" target="_blank">piuparts</a>
    is GPL2 <a href="http://packages.debian.org/changelogs/pool/main/p/piuparts/current/copyright" target="_blank">licenced</a>
    and was written by <a href="mailto:liw at iki.fi">Lars Wirzenius</a> and is now maintained by
-   <a href="mailto:holger at debian.org">Holger Levsen</a> and
+   <a href="mailto:holger at layer-acht.org">Holger Levsen</a> and
    <a href="mailto:piuparts-devel at lists.alioth.debian.org">others</a> using
    <a href="http://anonscm.debian.org/gitweb/?p=piuparts/piuparts.git" target="_blank">piuparts.git</a>.
    Weather icons are from the <a href="http://tango.freedesktop.org/Tango_Icon_Library" target="_blank">Tango Icon Library</a>.
diff --git a/piuparts.1.txt b/piuparts.1.txt
index 2a5cafc..2728089 100644
--- a/piuparts.1.txt
+++ b/piuparts.1.txt
@@ -40,13 +40,13 @@ OPTIONS
 -------
 Options must come before the other command line arguments.
 
-*-a, --apt*::
+*-a*, *--apt*::
   The package arguments on the command line are to be treated as package names and installed via *apt-get* instead  of  being  names  of  package  files, to be installed via *dpkg -i*.
 
 *--arch*='arch'::
   Create chroot and run tests for (non-default) architecture 'arch'. The default is the output from 'dpkg --print-architecture'.
 
-*-b* tarball, *--basetgz*='tarball'::
+*-b* 'tarball', *--basetgz*='tarball'::
   Use tarball as the contents of the initial chroot, instead of building a new one with debootstrap.
 +
 The tarball can be created with the '-s' option, or you can use one that *pbuilder* has created (see '-p'). If you create one manually, make sure the root of the chroot is the root of the tarball.
@@ -57,7 +57,7 @@ The tarball can be created with the '-s' option, or you can use one that *pbuild
 *-d* 'name', *--distribution*='name'::
   Which Debian distribution to use: a code name (for example squeeze, wheezy or sid) or experimental. The default is sid (=unstable).
 
-*-D* 'flavor', *--defaults* 'flavor'::
+*-D* 'flavor', *--defaults*='flavor'::
   Use default settings suitable for a particular flavor of Debian: either debian or ubuntu. The default is debian.
 
 *--do-not-verify-signatures*::
@@ -109,10 +109,10 @@ The tarball can be created with the '-s' option, or you can use one that *pbuild
 *--install-remove-install*::
   Remove package after installation and reinstall. For testing installation in config-files-remaining state.
 
-*-k, --keep-tmpdir*::
+*-k*, *--keep-tmpdir*::
   Don't remove the temporary directory for the chroot when the program ends.
 
-*-K, --keyring*='filename'::
+*-K*, *--keyring*='filename'::
  Use FILE as the keyring to use with debootstrap when creating chroots.
 
 *--keep-sources-list*::
@@ -149,10 +149,10 @@ Note that file: addresses works if the directories are made accessible from with
 *--no-diversions*::
   Don't check for broken diversions.
 
-*-n, --no-ignores*::
+*-n*, *--no-ignores*::
   Forget all built-in and other ignores that have been set so far. Any '-i' or '-I' arguments that come after this one will be obeyed, but none of the ones that come before.
 
-*-N, --no-symlinks*::
+*-N*, *--no-symlinks*::
   Don't check for broken symlinks.
 
 *--fail-if-inadequate*::
@@ -167,13 +167,13 @@ Note that file: addresses works if the directories are made accessible from with
 *--no-install-purge-test*::
   Skip the install and purge test.
 
-*-p, --pbuilder*::
+*-p, *--pbuilder*::
   Use _/var/cache/pbuilder/base.tgz_ as the base tarball. This is a shorthand so that you don't need to use '-b' for it.
 
 *--pedantic-purge-test*::
   Be pedantic when checking if a purged package leaves files behind. If this option is not set, files left in _/tmp_ are ignored.")
 
-*--proxy='URL'*::
+*--proxy*='URL'::
   Use the proxy at URL to access the Debian mirror(s). Takes precedence over
   the 'http_proxy' environment variable. Using a local proxy is recommended
   because piuparts may use large amounts of bandwidth to repeatedly download
@@ -209,7 +209,7 @@ Note that file: addresses works if the directories are made accessible from with
 *--skip-logrotatefiles-test*::
   Skip testing the output from the logrotate files left in the system after remove a package.
 
-*--testdebs-repo='deb-line'::
+*--testdebs-repo*='deb-line'::
   Provide an additional line to be appended to sources.list, e.g.
     'deb <URL> <distrib> <components>' or
     'deb file:// </bind/mount> ./'
@@ -224,15 +224,15 @@ Note that file: addresses works if the directories are made accessible from with
   apt-get. The packages to be tested can be passed as .debs or as package
   names (with '--apt').
 
-*-t directory, --tmpdir*='directory'::
+*-t directory*, *--tmpdir*='directory'::
   Use directory as the place where temporary files and directories are created. The default is the environment variable *TMPDIR*, or _/tmp_ if not set.
 +
 Note: the temporary directory must *not* be mounted with the _nodev_ or _nosuid_ mount option.
 
-*-v, --verbose*::
+*-v*, *--verbose*::
   This option no longer has any meaning, but it is still accepted for backwards compatibility.
 
-*-V, --version*::
+*-V*, *--version*::
   Write out the version number of the program.
 
 *--warn-on-debsums-errors*::

-- 
piuparts git repository

