r333: um.

[debhelper.git] / doc / README

diff --git a/doc/README b/doc/README
index dcc42e612c0419847ab09f932be60e36b4d607aa..14df20e88c2a3cab1dd2d43c2db797b85750f209 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -56,6 +56,26 @@ EOF
 system ($temp) / 256 == 0
        or die "Problem with debhelper scripts: $!\n";
 
+Building a package that doesn't have a doc directory:
+----------------------------------------------------
+
+Policy says that if a package depends on some other package, and they build
+from the same source, the package can make its doc directory be a symlink to
+the doc directory of the package it depends on. If you want to do this with
+debhelper, do the following (assumes the package is foo-doc, which depends
+on foo):
+
+dh_link usr/share/doc/foo usr/share/doc/foo-doc \
+       usr/share/doc/foo usr/doc/foo-doc
+...
+dh_installdocs -N foo-doc
+dh_installexamples -N foo-doc
+dh_installchangelogs -N foo-doc
+
+So the dh_link actually sets up the symlinks. Then the three debhelper commands
+that normally write into doc directory are told not to act on package
+foo-doc. Voila!
+
 Other notes:
 -----------