summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey>2002-01-27 06:34:33 +0000
committerjoey <joey>2002-01-27 06:34:33 +0000
commit81a1cb9028b75304b0261dfd91ba04c0e6b07bb4 (patch)
tree6d0e7665b9271a2724f36db307c267da45822f4b /doc
parent26fc54549b83f4efd2db161b86159dd65da974a9 (diff)
r506: * Introduced the debian/compat file. This is the new, preferred way to say
what debhelper compatability level your package uses. It has the big advantage of being available to debhelper when you run it at the command line, as well as in debian/rules. * A new v4 feature: dh_installinit, in v4 mode, will use invoke-rc.d. This is in v4 for testing, but I may well roll it back into v3 (and earlier) once woody is released and I don't have to worry about breaking things (and, presumably, once invoke-rc.d enters policy). * Some debhelper commands will now build up a new substvars variable, ${misc:Depends}, based on things they know your package needs to depend on. For example, dh_installinit in v4 mode adds sysvinit (>= 2.80-1) to that dep list, and dh_installxfonts adds a dep on xutils. This variable should make it easier to keep track of what your package needs to depends on, supplimenting the ${shlibs:Depends} and ${perl:Depends} substvars. Hmm, this appears to be based loosely on an idea by Masato Taruishi <taru@debian.org>, filtered through a long period of mulling it over. Closes: #76352 * Use the addsubstvar function I wrote for the above in dh_perl too.
Diffstat (limited to 'doc')
-rw-r--r--doc/PROGRAMMING46
-rw-r--r--doc/TODO5
2 files changed, 32 insertions, 19 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 7a78711..b12a1a2 100644
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -156,34 +156,34 @@ Functions:
Dh_Lib.pm also contains a number of functions you may find useful.
-doit()
+doit(@command)
Pass this function an array that is a
shell command. It will run the command (unless $dh{NO_ACT} is set), and
if $dh{VERBOSE} is set, it will also output the command to stdout. You
should use this function for almost all commands your program performs
that manipulate files in the package build directories.
-complex_doit()
+complex_doit($command)
Pass this function a string that is a shell command, it will run it
similarly to how doit() does. You can pass more complicated commands
to this (ie, commands involving piping redirection), however, you
have to worry about things like escaping shell metacharacters.
-verbose_print()
+verbose_print($message)
Pass this command a string, and it will echo it if $dh{VERBOSE} is set.
-error()
+error($errormsg)
Pass this command a string, it will output it to standard error and
exit.
-warning()
+warning($message)
Pass this command a string, and it will output it to standard error
as a warning message.
-tmpdir()
+tmpdir($dir)
Pass this command the name of a binary package, it will return the
name of the tmp directory that will be used as this package's
package build directory. Typically, this will be "debian/package".
-compat()
+compat($num)
Pass this command a number, and if the current compatibility level
- equals that number, it will return true. Looks at DH_COMPAT to get
- the compatibility level.
-pkgfile()
+ is less than or equal to that number, it will return true.
+ Looks at DH_COMPAT to get the compatibility level.
+pkgfile($package, $basename)
Pass this command the name of a binary package, and the base name of a
file, and it will return the actual filename to use. This is used
for allowing debhelper programs to have configuration files in the
@@ -191,17 +191,17 @@ pkgfile()
package. The convention is that the files are named
debian/package.filename, and debian/filename is also allowable for
the $dh{MAINPACKAGE}. If the file does not exist, nothing is returned.
-pkgext()
+pkgext($package)
Pass this command the name of a binary package, and it will return
the name to prefix to files in debian/ for this package. For the
$dh{MAINPACKAGE}, it returns nothing (there is no prefix), for the other
packages, it returns "package.".
-isnative()
+isnative($package)
Pass this command the name of a package, it returns 1 if the package
is a native debian package.
As a side effect, $dh{VERSION} is set to the version number of the
package.
-autoscript()
+autoscript($package, $scriptname, $snippetname, $sedcommands)
Pass parameters:
- binary package to be affected
- script to add to
@@ -210,10 +210,26 @@ autoscript()
(optional)
This command automatically adds shell script snippets to a debian
maintainer script (like the postinst or prerm).
-dirname()
+dirname($pathname)
Return directory part of pathname.
-basename()
+basename($pathname)
Return base of pathname,
+addsubstvar($package, $substvar, $deppackage, $verinfo, $remove)
+ This function adds a dependency on some package to the specified
+ substvar in a package's substvar's file. It needs all these
+ parameters:
+ - binary package that gets the item
+ - name of the substvar to add the item to
+ - the package that will be depended on
+ - version info for the package (optional) (ie: ">= 1.1")
+ - if this last parameter is passed, the thing that would be added
+ is removed instead. This can be useful to ensure that a debhelper
+ command is idempotent. Note that without this parameter, if you
+ call the function twice with the same values it will only add one
+ item to the substvars file.
+delsubstvar($package, $substvar)
+ This function removes the entire line for the substvar from the
+ package's shlibs file.
-- Joey Hess <joeyh@debian.org>
diff --git a/doc/TODO b/doc/TODO
index 2b1e303..548a394 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -58,10 +58,7 @@ Wishlist items:
v4:
-These items are part of v4 already:
-
-* dhmakeshlibs -V omits the debian part of the version number from the
- generated dependancy in the shlibs file
+See debhelper's man page for what's implemented so far.
These items are planned: