summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-04-20 16:05:24 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-04-20 16:05:24 -0400
commit1ddf9d2cca0dac8a5ac417f47d60956bf33e5e7b (patch)
tree8577b0f61749e0bd3f5a71700a9c4e4568fe22b4 /doc
parentb65858486382827007883e8285a8a44c6c79ef3e (diff)
Move dh sequence documentation to PROGRAMMING.
Diffstat (limited to 'doc')
-rw-r--r--doc/PROGRAMMING33
1 files changed, 21 insertions, 12 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 5c60a0b..9963181 100644
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -46,27 +46,19 @@ Debhelper programs should default to doing exactly what policy says to do.
There are always exceptions. Just ask me.
-Introducing Dh_Lib.pm:
----------------------
+Introducing Dh_Lib:
+------------------
-Dh_Lib.pm is the library used by all debhelper programs to parse their
+Dh_Lib is the library used by all debhelper programs to parse their
arguments and set some useful variables. It's not mandatory that your
program use Dh_Lib.pm, but it will make it a lot easier to keep it in sync
with the rest of debhelper if it does, so this is highly encouraged.
-(There used to be a version of Dh_lib.pm that was a library of functions for
-shell scripts. If you want to write a debhelper command that is a shell
-script, I can dig up that old library for you. Only the perl one is
-supported now, though.)
-
-Use Dh_Lib.pm like this:
+Use Dh_Lib like this:
use Debian::Debhelper::Dh_Lib
init();
-The BEGIN block is there to make perl look for the module in all the right
-places.
-
The init() function causes Dh_lib to parse the command line and do some other
initialization tasks.
@@ -258,4 +250,21 @@ write_log($cmd, $package ...)
Writes the log files for the specified package(s), adding
the cmd to the end.
+Sequence Addons
+---------------
+
+The dh(1) command has a --with <addon> parameter that ca be used to load
+a sequence addon named Debian::Debhelper::Sequence::<addon>.
+These addons can add/remove commands to the dh command sequences, by calling
+some functions from Dh_Lib:
+
+insert_before($existing_command, $new_command)
+ Insert $new_command in sequences before $existing_command
+
+insert_after($existing_command, $new_command)
+ Insert $new_command in sequences after $existing_command
+
+remove_command($existing_command)
+ Remove $existing_command from the list of commands to run.
+
-- Joey Hess <joeyh@debian.org>