r522: * Set DH_ALWAYS_EXCLUDE=CVS and debhelper will exclude CVS directories

[debhelper.git] / debhelper.pod

diff --git a/debhelper.pod b/debhelper.pod
index df822163aaf48e8fd563be818756ed4bcf55960a..67cfbe73eb80505e58febf039bc5e0a470933808 100644 (file)
--- a/debhelper.pod
+++ b/debhelper.pod
@@ -185,11 +185,13 @@ the set command):
 =head2 Automatic generation of miscellaneous dependencies.
 
 Some debhelper commands may make the generated package need to depend on
-some other packages. For example, if you use L<dh_installdebconf(1)>, you'r
+some other packages. For example, if you use L<dh_installdebconf(1)>, your
 package will generally need to depend on debconf. Or if you use
 L<dh_installxfonts(1)>, your package will generally need to depend on a
 particular version of xutils. Keeping track of these miscellaneous
-dependencies can be annoying, so debhelper offers a way to automate it.
+dependencies can be annoying since they are dependant on how debhelper does
+things, so debhelper offers a way to automate it.
+
 All commands of this type, besides documenting what dependencies may be
 needed on their man pages, will automatically generate a substvar called
 ${misc:Depends}. If you put that token into your debian/control file, it
@@ -223,9 +225,9 @@ introduced. You tell debhelper which compatability level it should use, and
 it modifies its behavior in various ways.
 
 You tell debhelper what compatability level to use by writing a number to
-debian/compat. For example, to turn on V3 mode:
+debian/compat. For example, to turn on V4 mode:
 
-  % echo 3 > debian/compat
+  % echo 4 > debian/compat
 
 These are the available compatablity levels:
 
@@ -246,8 +248,7 @@ as the package tree directory for every package that is built.
 
 =item V3
 
-This is the reccommended mode of operation. It does everything V2 does,
-plus:
+This mode works like V2, with the following additions:
 
 =over 8
 
@@ -268,8 +269,8 @@ Every file in etc/ is automatically flagged as a conffile by dh_installdeb.
 
 =item V4
 
-This mode is still under development, and its behavior may change at any
-time. Currently, it does everything V3 does, plus:
+This is the reccommended mode of operation. It does everything V3 does,
+plus:
 
 =over 8
 
@@ -283,6 +284,15 @@ the generated dependancy line in the shlibs file.
 dh_installinit uses the new invoke-rc.d program in its generated maintainer
 scripts. (This may later be rolled back into V3).
 
+=item -
+
+dh_fixperms will make all files in bin/ directories and in etc/init.d 
+executable.
+
+=item -
+
+dh_link will correct existing links to conform with policy.
+
 =back
 
 =back
@@ -344,6 +354,19 @@ older debhelpers will ignore it and do things you don't want them to. One very
 good way to set DH_OPTIONS is by using "Target-specific Variable Values" in
 your debian/rules file. See the make documentation for details on doing this.
 
+=item DH_ALWAYS_EXCLUDE
+
+If set, this adds the value the variable is set to to the -X options of all
+commands that support the -X option. Moreover, dh_builddeb will rm -rf
+anything that matches the value in your package build tree.
+
+This can be useful if you are doing a build from a CVS source tree, in
+which case setting DH_ALWAYS_EXCLUDE=CVS will prevent any CVS directories
+from sneaking into the package you build. Or, if a package has a source
+tarball that (unwisely) includes CVS directories, you might want to export
+DH_ALWAYS_EXCLUDE=CVS in debian/rules, to make it take effect wherever
+your package is built.
+
 =back
 
 =head1 SEE ALSO