X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=debhelper.pod;h=e840d31f0b054af86814282daa87c1d6dffab12d;hb=22644829621e3613ac87a51e1ccac021a096dbc6;hp=b13dbcdce93c08bd36c8e99b0fee3ae8388b231f;hpb=a0656a38e5b6b196cdece6951190ba77e28c76df;p=debhelper.git diff --git a/debhelper.pod b/debhelper.pod index b13dbcd..e840d31 100644 --- a/debhelper.pod +++ b/debhelper.pod @@ -17,9 +17,8 @@ policy changes, and packages that use them will require only a rebuild to comply with the new policy. A typical debian/rules file that uses debhelper will call several debhelper -commands in sequence. Debhelper commands are all named with a "dh_" prefix. -Examples of rules files that use debhelper are in -F +commands in sequence, or use L to automate this process. Examples of +rules files that use debhelper are in F To create a new debian package using debhelper, you can just copy one of the sample rules files and edit it by hand. Or you can try the dh-make @@ -119,6 +118,16 @@ are not architecture independent. Do not act on the specified package even if an -a, -i, or -p option lists the package as one that should be acted on. +=item B<--ignore=>I + +Ignore the specified file. This can be used if debian/ contains a debhelper +config file that a debhelper command should not act on. Note that +debian/compat, debian/control, and debian/changelog can't be ignored, but +then, there should never be a reason to ignore those files. + +For example, if upstream ships a debian/init that you don't want +dh_installinit to install, use --ignore=debian/init + =item B<-P>I, B<--tmpdir=>I Use "tmpdir" for package build directory. The default is debian/ @@ -174,9 +183,6 @@ B<-a>, B<-i>, B<-p>, and B<-s> parameters. These parameters are cumulative. If none are given, debhelper programs default to acting on all packages listed in the control file. -See F for an example of how to -use this in a package that generates multiple binary packages. - =head2 Automatic generation of debian install scripts Some debhelper commands will automatically generate parts of debian @@ -246,9 +252,9 @@ introduced. You tell debhelper which compatibility level it should use, and it modifies its behavior in various ways. Tell debhelper what compatibility level to use by writing a number to -debian/compat. For example, to turn on V5 mode: +debian/compat. For example, to turn on V7 mode: - % echo 5 > debian/compat + % echo 7 > debian/compat Unless otherwise indicated, all debhelper documentation assumes that you are using the most recent compatibility level, and in most cases does not @@ -329,8 +335,7 @@ dh_link will correct existing links to conform with policy. =item V5 -This is the recommended mode of operation. It does everything V4 does, -plus: +Changes from V4 are: =over 8 @@ -355,8 +360,7 @@ dh_install errors out if wildcards expand to nothing. =item V6 -This mode is still under development. Currently it has these differences -compared to V5: +Changes from V5 are: =over 8 @@ -367,18 +371,52 @@ fragements in reverse order for the prerm and postrm scripts. =item - -dh_installwm will install a slave manpage link for x-window-manager.1.gz. +dh_installwm will install a slave manpage link for x-window-manager.1.gz, +if it sees the man page in usr/share/man/man1 in the package build +directory. =item - dh_builddeb did not previously delete everything matching DH_ALWAYS_EXCLUDE, if it was set to a list of things to exclude, such as -"CVS:.svn". Now it does. +"CVS:.svn:.git". Now it does. =item - dh_installman allows overwriting existing man pages in the package build -directory. In previous compatability levels it silently refuses to do this. +directory. In previous compatibility levels it silently refuses to do this. + +=back + +=item V7 + +This is the recommended mode of operation. + +Changes from V6 are: + +=over 8 + +=item - + +dh_install, will fall back to looking for files in debian/tmp if it doesn't +find them in the current directory (or wherever you tell it look using +--srcdir). This allows dh_install to interoperate with dh_auto_install, +which installs to debian/tmp, without needing any special parameters. + +=item - + +dh_clean will read debian/clean and delete files listed there. + +=item - + +dh_clean will delete toplevel *-stamp files. + +=item - + +dh_installchangelogs will guess at what file is the upstream changelog if +none is specified. + +=back =back @@ -414,9 +452,9 @@ Once your package uses debhelper to build, be sure to add debhelper to your Build-Depends line in debian/control. You should build-depend on a version of debhelper equal to (or greater than) the debhelper compatibility level your package uses. So if your package used -compatibility level 5: +compatibility level 7: - Build-Depends: debhelper (>= 5) + Build-Depends: debhelper (>= 7) =head1 ENVIRONMENT @@ -470,7 +508,7 @@ DH_ALWAYS_EXCLUDE=CVS:.svn A set of example debian/rules files that use debhelper. -=item L +=item L Debhelper web site.