diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/PROGRAMMING | 111 | ||||
| -rw-r--r-- | doc/README | 59 | ||||
| -rw-r--r-- | doc/TODO | 96 | ||||
| -rw-r--r-- | doc/from-debstd | 63 | ||||
| -rw-r--r-- | doc/v2 | 64 |
5 files changed, 271 insertions, 122 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING index 6cae08a5..da21ea9d 100644 --- a/doc/PROGRAMMING +++ b/doc/PROGRAMMING @@ -1,6 +1,4 @@ This file documents things you should know to write a new debhelper program. -Any program with a name that begins with dh_ should conform to these -guidelines (with the historical exception of dh_make). Standardization: --------------- @@ -13,14 +11,14 @@ pollute the name space too much. Debhelper programs should never output anything to standard output except error messages, important warnings, and the actual commands they run that -modify files under debian/ (this last only if they are passed -v, and if you -output the commands, you should indent them with 1 tab). This is so we don't -have a lot of noise output when all the debhelper commands in a debian/rules -are run, so the important stuff is clearly visible. +modify files under debian/ and debian/tmp, etc (this last only if they are +passed -v, and if you output the commands, you should indent them with 1 tab). +This is so we don't have a lot of noise output when all the debhelper commands +in a debian/rules are run, so the important stuff is clearly visible. -Debhelper programs should accept all options listed in the "SHARED -DEBHELPER OPTIONS" section of debhelper(7), including any long forms of -these options, like --verbose . If necessary, the options may be ignored. +Debhelper programs should accept the options, -v, -i, -a, -p, --no-act, and +-P, and any long forms of these options, like --verbose . If necessary, the +options may be ignored. If debhelper commands need config files, they should use debian/package.filename as the name of the config file (replace filename @@ -31,25 +29,19 @@ information that appears in the config files, on their command lines, if possible, and apply that information to the first package they act on. Debhelper programs should never modify the debian/postinst, debian/prerm, -etc scripts. Instead, they can add lines to debian/postinst.debhelper, etc. +etc scripts, instead, they can add lines to debian/postinst.debhelper, etc. The autoscript() function (see below) is one easy way to do this. dh_installdeb is an exception, it will run after the other commands and merge these modifications into the actual postinst scripts. -In general, files named debian/*.debhelper are internal to debhelper, and -their existence or use should not be relied on by external programs such as -the build process of a package. - -Debhelper programs should default to doing exactly what policy says to do. - There are always exceptions. Just ask me. Introducing Dh_Lib.pm: --------------------- -Dh_Lib.pm is the library used by all debhelper programs to parse their +Dh_lib.pm 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 +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 @@ -57,16 +49,17 @@ 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.pm like this: -use Debian::Debhelper::Dh_Lib +BEGIN { push @INC, "debian", "/usr/lib/debhelper" } +use 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. +The init() function in the perl version. This causes Dh_lib to +parse the command line and do some other initialization tasks. Argument processing: ------------------- @@ -85,10 +78,10 @@ switch variable description --no-act NO_ACT should the program not actually do anything? -i,-a,-p,-N DOPACKAGES a space delimited list of the binary packages to act on (in Dh_Lib.pm, this is an array) --i DOINDEP set if we're acting on binary independent - packages --a DOARCH set if we're acting on binary dependent - packages +-i,-p,-N DOINDEP a space delimited list of the binary independent + packages to act on +-a,-p,-N DOARCH a space delimited list of the binary dependent + packages to act on -n NOSCRIPTS if set, do not make any modifications to the package's postinst, postrm, etc scripts. -X EXCLUDE exclude a something from processing (you @@ -111,8 +104,6 @@ switch variable description other program. (This is an array) -m M_PARAMS will be set to a string, you decide what it means to your program --l L_PARAMS will be set to a string, you decide what it - means to your program -V V_FLAG will be set to a string, you decide what it means to your program -V V_FLAG_SET will be 1 if -V was specified, even if no @@ -125,15 +116,6 @@ switch variable description --init-script INIT_SCRIPT will be set to a string, which specifies an init script name (probably only dh_installinit will ever use this) ---sourcedir SOURCEDIR will be set to a string (probably only - dh_movefiles will ever use this) ---destdir DESTDIR will be set to a string (probably only - dh_builddeb will ever use this) ---filename FILENAME will be set to a string ---flavor FLAVOR will be set to a string (probably only - dh_installemacsen will ever use this) ---number PRIORITY will be set to a number (deprecated) ---priority PRIORITY will be set to a number Any additional command line parameters that do not start with "-" will be ignored, and you can access them later just as you normally would. @@ -148,7 +130,7 @@ The following keys are also set in the %dh hash when you call init(): MAINPACKAGE the name of the first binary package listed in debian/control FIRSTPACKAGE the first package we were instructed to act on. This package - typically gets special treatment; additional arguments + typically gets special treatment, additional arguments specified on the command line may effect it. Functions: @@ -156,34 +138,31 @@ Functions: Dh_Lib.pm also contains a number of functions you may find useful. -doit(@command) +doit() 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($command) +complex_doit() 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($message) +verbose_print() Pass this command a string, and it will echo it if $dh{VERBOSE} is set. -error($errormsg) +error() Pass this command a string, it will output it to standard error and exit. -warning($message) +warning() Pass this command a string, and it will output it to standard error as a warning message. -tmpdir($dir) +tmpdir() 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($num) - Pass this command a number, and if the current compatibility level - is less than or equal to that number, it will return true. - Looks at DH_COMPAT to get the compatibility level. -pkgfile($package, $basename) + package build directory. Typically, this will be "debian/tmp" or + "debian/package". +pkgfile() 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 +170,17 @@ pkgfile($package, $basename) 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($package) +pkgext() 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($package) +isnative() 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($package, $scriptname, $snippetname, $sedcommands) +autoscript() Pass parameters: - binary package to be affected - script to add to @@ -210,29 +189,5 @@ autoscript($package, $scriptname, $snippetname, $sedcommands) (optional) This command automatically adds shell script snippets to a debian maintainer script (like the postinst or prerm). -dirname($pathname) - Return directory part of pathname. -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. -excludefile($filename) - This function returns true if -X has been used to ask for the file - to be excluded. - --- Joey Hess <joeyh@debian.org> +-- Joey Hess <joeyh@master.debian.org> @@ -1 +1,58 @@ -Please see the debhelper(7) man page for documentation. +Debhelper is a collection of programs that can be used in debian/rules files +to automate common tasks related to building debian binary packages. For +further documentation, see the man pages for dh_* commands. For an overview +of debhelper, see the debhelper(1) man page. + +To help you get started, I've included examples of debian/rules files +that use debhelper commands extensively. See /usr/doc/debhelper/examples/ . +These files are also useful as they give one good order you can run the +various debhelper scripts in (though other variations are possible). + +Starting a new package: +---------------------- + +You can just use the example rules files and do the rest of the new package +set up by hand, or you could try the new dh-make package, which contains a +"dh_make" command that is similar to debmake, and tries to automate the +process. + +Converting from debstd to debhelper: +----------------------------------- + +See the file "from-debstd" for documentation on how to do this. + +Automatic generation of debian install scripts: +---------------------------------------------- + +Some debhelper commands will automatically generate parts of debian install +scripts. If you want these automatically generated things included in your +debian install scripts, then you need to add "#DEBHELPER#" to your scripts, +in the place the code should be added. "#DEBHELPER#" will be replaced by any +auto-generated code when you run dh_installdeb. + +All scripts that automatically generate code in this way let it be disabled +by the -n parameter. + +Note that it will be shell code, so you cannot directly use it in a perl +script. If you would like to embed it into a perl script, here is one way to +do that (note the tricky use of backquotes) (also note that I made sure that +$1, $2, etc are set with the set command): + +print << `EOF` +set -- @ARGV +#DEBHELPER# +EOF + +Other notes: +----------- + +Note that if you are generating a debian package that has arch-indep and +arch-dependent portions, and you are using dh_movefiles to move the +arch-indep files out of debian/tmp, you need to make sure that dh_movefiles +does this even if only the arch-dependent package is being built (for ports +to other architectures). I handle this in debian/rules.multi by calling +dh_movefiles in the install target. + +Debhelper's home page is at http://kitenet.net/programs/debhelper/ + +-- Joey Hess <joeyh@master.debian.org> @@ -1,52 +1,62 @@ This is the TODO for debhelper. As more and more people use debhelper, this list grows - I welcome patches to fix items on it! -Wishlist items: - -* All debhelper programs should only accept the options they are documented - to accept (rather than accepting all debhelper options). They should - be able to print brief usage summaries. - - I think this calls for a restucturing. Make a Debhelper.pm class. Each - program subclasses the class. The class provides command line parsing, - useful functions, and so on. Skeleton of a debhelper command would then - be: - - use base qw{Debhelper}; +Bugs: - sub startup { - # Add initialization stuff here. - } +* all commands should print a warning message if non-cumulative parameters + are given more than once (ie, two -u's to dh_gencontrol). (#22588) + (Bug currently under dispute, I think this is bogus). - sub perpackage { - my $package=shift; - - # Stuff to do for each package here. - } - - sub fini { - # And final stuff here, if any. - } +Wishlist items: - This needs more thought. - -* install-info, as of dpkg 1.10, parses the info file for section if - --section is not given. So I should be able to stop parsing it myself for - section, after dpkg 1.10 has been around long enough. +* Make dh_movefiles remove emptied directories after it's moved all the + files out of them (#17111). +* info support for debhelper (currently implemented, but I hate how I did it, + so it's not in the package.) (#15717) +* enhance dh_installmanpages so it associates binaries and man pages and + installs the man pages into the correct areas to suit the binaries they + document. I may need to make this only happen when a switch is given, to + preserve backward compatibility. (#16933, #17061) +* maybe make dh_installmanpages look at the .TH line of man pages whose + filenames end in .man, to figure out what section they go it. This would + require a switch to turn on, for backwards compatibility. +* All debhelper programs should be checked that they output files with the + correct permissions no matter what the umask is set to. Currently, only + those programs that run after dh_fixperms have been so checked. (Checking + the rest is low priority, since dh_fixperms fixes any incorrect permissions + they might have; still it would be nice to check them too, just to make + debhelper more flexible.) One easy fix is to add umask 022 to dh_lib, + however, there may be unforeseen ramifications of such a change. +* something should add ldconfig calls properly to the postinst of packages + that contain shared libraries. maybe dh_makeshlibs? But it wasn't designed + to do that originally, and even worse, it is often run after + dh_installdeb, so the fragments wouldn't go into the postinst. So maybe a + new script is called for. +* Need a way to make dh_strip not strip any static libs. Also, it'd be nice + if there were options to dh_strip, dh_compress, etc, to allow inclusion of + directories and exclusion of files based on filename globbing. (Request from + Matthias Klose <doko@cs.tu-berlin.de>) +* docbase support (#25233). Waiting for docbase to stabilize and be used + widely. +* dhelp support. Currently pending on dhelp use becoming widespead (#18342) +* Support use of environment variables in data taken from user, ie, in + debian/dirs. The problem with doing this is that we really want to allow + any filenames in that input, even those that look like environment + variables. However, it may be worth adding a switch to make it parse + environment variables. (#20964) +* It's possible to speed up debhelper by having it cache some values that + multiple commands call. One way to do this would be to write dh_cache, + that generates the cache. The catch is that if the user runs that program, + they are stating that they don't do anything later to invalidate the cache, + without calling ch_cache again. (#23792) +* Add a switch to dh_installdeb to allow it to do user defined + substitutions. OTOH, maybe it's better if people just sed + postinst.in before debhelper gets it's hands on it... (#25235) Deprecated: -* DH_COMPAT 1. Can be removed once all packages are seen to be using 2 or - higher. I won't hold my breath. -* Also, grep the entire archive for all dh_* command lines (I do this now), - and check to see what other switches are not being used, and maybe remove - some of them. I'd also like to deprecate/remove debian/compress files, -X is - a better idea. -* dh_suidregister. Once nothing in the archive uses it. -* dh_installmanpages. Only mildly deprecated right now. Once dh_installman - catches on, make it emit a warning, and then wait for it to go away. -* dh_testversion. Remove as soon as nothing uses it. -* dh_movefiles. I won't hold my breath. -* debconf-mergetemplates support and the debian/template.ll files and the - debconf-utils dependency. -* dh_undocumented +* remove dh_installdebfiles, dh_du. + - need to wait a reasonable length of time. I'm currently planning + on doing this after slink is released or one year after they were + deprecated, whichever comes first. Be sure to grep whole debian + archive for all of them before removing them, though! diff --git a/doc/from-debstd b/doc/from-debstd new file mode 100644 index 00000000..86f29dce --- /dev/null +++ b/doc/from-debstd @@ -0,0 +1,63 @@ +Converting from debstd to debhelper: +----------------------------------- + +Debhelper is designed to be mostly backwards compatible to debstd. I say +mostly because I haven't made debhelper handle everything that debstd does +yet, and in a few cases, debhelper does things differently (and I hope, +better). + +In general, you can switch over to using debhelper as follows. In your +debian/rules, you currently will have some lines that read something like +this: + + debstd CHANGES TODO README + dpkg-gencontrol + dpkg --build debian/tmp .. + +Debhelper comes with a command called dh_debstd that mimics the behavior of +debstd, by calling various debhelper commands. So in the root directory of +your package you are converting, run: + + dh_debstd CHANGES TODO README --verbose --no-act + +Notice the parallel to the debstd command above, I just added +"--verbose --noact" to the end. This will make dh_debstd output a list of +commands that it thinks will emulate what debstd would have done, without +actually doing anything to your package. The list will look similar to this: + + dh_installdirs + dh_installdocs TODO README + dh_installexamples + dh_installchangelogs CHANGES + dh_installmenu + dh_installcron + dh_installmanpages + dh_movefiles + dh_strip + dh_compress + dh_fixperms + dh_suidregister + dh_shlibdeps + dh_gencontrol + dh_makeshlibs + dh_installdeb + dh_md5sums + dh_builddeb + +Now copy that output into debian/rules, replacing the debstd command, as +well as any dpkg-gencontrol and dpkg --build commands. + +Finally, debstd automatically modified postinst, postrm, etc scripts. Some +of the debhelper apps do that too, but they do it differently. Debstd just +appends its commands to the end of the script. Debhelper requires that you +insert a tag into your scripts, that will tell debhelper where to insert +commands. So if you have postinst, postrm, etc scripts, add a line reading +"#DEBHELPER#" to the end of them. + +Once you think it's all set up properly, do a test build of your package. If +it works ok, I recommend that you compare the new package and the old +debstd-generated package very closely. Pay special attention to the +postinst, postrm, etc scripts, and make sure that the new package contains +all the same files as the old, with the same permissions. + +-- Joey Hess <joeyh@master.debian.org> @@ -0,0 +1,64 @@ +Debhelper v2 is a major new revision of debhelper. Currently, v2 is still +being worked on, and will change in drastic ways without notice. To keep +this from breaking packages, debhelper will continue to operate in v1 +compatability mode by default. + +To enable debhelper v2 features (do this with *caution*), set DH_COMPAT=2 in +your debian/rules. Also, it is a very good idea to add a call to your +debian/rules like this: + dh_testversion 2 +To ensure that your package won't be built with some old version of +debhelper that ignores the DH_COMPAT flag. + +Here are the changes I'm planning to make to debhelper for v2, based on +prior discussion on debian-devel. + +Items marked with a + are done. All others will happen as soon as I can code +them. + ++ Standardize on the name used for the temporary build directory of a + package. Currently it's debian/tmp/ for the first package and + debian/<package>/ for other packages of a multi-binary package. I've + decided after much agonizing to to use debian/<package>. The main thing this + has going for it is it means lots of multi-binary packages need only small + alterations, since they already use debian/<package> for making most of + thier .deb's anyway. I eliminated the other ideas for these reasons: + - debian/tmp/<package>: debian/tmp already has history behind it, + changing how it's used would be confusing. + - debian/build/<package>: confusing (is the code compiled there?) + - debian/tmp-<package>, debian/package-<tmp>: too long, little gain + +* dh_installmanpages will be made into a non-DWIM program, so you'll have to + specify all man pages to install and possibly where to put them. This may + look something like: + dh_installmanpages -x xterm.1 xfoo.1 xbar.man + dh_installmanpages --section=8 su.man + Ok, there's a _little_ DWIM left in there, it'll be smart enough to munge + the .man filenames properly. It'll probably just assume all man pages have + an extention, and delete that extentation, and add the correct one. + +* dh_movefiles will use a name other than debian/<package>.files for the + list of what to move, because it can't use debian/files for the first + package, since that file is already used elsewhere. It'll use + debian/<package>.move + +* dh_movefiles should delete empty directories after it's moved all files + out of them. (#17111) + +* debian/README will be installed as /usr/doc/<package>/README in native + packages, and as README.Debian in non-native packages. This is consistent + with the handing of debian/TODO and debian/changelog. (#34628) + +* There will be no change to the names of debhelper config files used, I've + decided against debian/<package>/* and the like, because although those + subdirs do work, they're not allowed by the packaging manual, and they'd + make source unpacking by hand a lot harder. I will leave these files + completly as they are now. However, I will remove most of the language + documenting that debian/<foo> works, and will deprecate that usage. + debian/<package>.<foo> will be preferred even in single binary packages. + +* Every file in etc/ will be automatically be flagged as a conffile. + +* Debhelper config files will support globbing via * and ?, when + appropriate. To turn this off and use those changarcters raw, just quote + them. |