[Piuparts-commits] rev 833 - in trunk: . debian

[Holger Levsen]

Author: holger
Date: 2010-11-28 12:18:16 +0000 (Sun, 28 Nov 2010)
New Revision: 833

Modified:
   trunk/README.txt
   trunk/debian/changelog
Log:
* README.txt
  - better documentation of custom scripts.

Modified: trunk/README.txt
===================================================================
--- trunk/README.txt	2010-11-28 10:47:56 UTC (rev 832)
+++ trunk/README.txt	2010-11-28 12:18:16 UTC (rev 833)
@@ -128,59 +128,43 @@
 You have to store them in a directory and give it as argument to
 piuparts: '--scriptsdir=/dir/with/the/scripts'
 
-The scripts can be run:
+The script prefix determines in which step it is executed. You can run 
+several scripts in every step, they are run in alphabetical order.
 
-After the *setup* of the chroot is finished. The name of the script must
-start with:
+The scripts are run *inside* the piuparts chroot and only can be shell 
+scripts, if you want to run Python or Perl scripts, you have to install 
+Python or Perl. The chroot where piuparts is run is minized and does not 
+include Perl.
 
-'post_setup_'
+The variable PIUPARTS_OBJECTS is set to the packages currently being tested
+(seperated by spaces, if applicable) or the .changes file(s) being used. 
+So when running in master-slave mode, it will be set to the (one) package 
+being tested at a time.
 
-Before *installing* your package. The name of the script must
-start with:
+The following prefixes for scripts are recognized:
 
-'pre_install_'
+'post_setup_' - after the *setup* of the chroot is finished.
 
-After *installing* your package and its deps. In the case of the 
-upgrade test, it is after install and upgrade. The name of the 
-script must start with:
+'pre_install_' - before *installing* your package.
 
-'post_install_'
+'post_install_' - after *installing* your package and its dependencies. 
+In the case of the upgrade test, it is after install and upgrade.
 
-Before *removing* your package, The name of the script must start with:
+'pre_remove_' - before *removing* your package.
 
-'pre_remove_'
+'post_remove_' - after *removing* your package.
 
-After *removing* your package, The name of the script must start with:
+'post_purge_' - after *purging* your package.
 
-'post_remove_'
+'pre_upgrade_' - before *upgrading* your package, once the current version in the archive
+has been installed (this is done in the second test, "Installation, upgrade and 
+purging test").
 
-After *purging* your package, The name of the script must start with:
+'pre_distupgrade_' - before *upgrading* the chroot to the *next distribution*.
 
-'post_purge_'
+'post_distupgrade_' - after *upgrading* the chroot to the *next distribution*.
 
-Before *upgrading* your package, once the current version in the archive
-has been installed (this is done in the second test, "Installation, 
-upgrade and purging test"). The name of the script must start with:
 
-'pre_upgrade_'
-
-Before upgrading the chroot to another distro and after upgrading:
-
-'pre_distupgrade_'
-'post_distupgrade_'
-
-You can run several scripts in every step, they are run in alphabetical 
-order.
-
-The scripts are run *inside* the piuparts chroot and only can be shell 
-scripts, if you want to run Python or Perl scripts, you have to install 
-Python or Perl. The chroot where piuparts is run is minized and does not 
-include Perl.
-
-
-The variable PIUPARTS_OBJECTS is set to the packages currently being tested
-(seperated by spaces, if applicable) or the .changes file(s) being used.
-
 === Example custom scripts:
 
 '$ cat post_install_numbers'
@@ -201,7 +185,7 @@
 ----
 
 
-== Distrubuted testing
+== Distributed testing
 
 As part of the quality assurance effort of Debian, 
 piuparts is run on the Debian package archive. This requires a

Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog	2010-11-28 10:47:56 UTC (rev 832)
+++ trunk/debian/changelog	2010-11-28 12:18:16 UTC (rev 833)
@@ -78,6 +78,8 @@
       spotting this. (Closes: #574504)
     - indicate that it's possible to check several packages or .changes files
       at once.
+  * README.txt
+    - better documentation of custom scripts.
 
   [ Evgeni Golov ]
   * piuparts.py: