summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey>2000-01-17 05:25:36 +0000
committerjoey <joey>2000-01-17 05:25:36 +0000
commitf06ac32c0e70741472b5b2f09dd1c011c3f53441 (patch)
treeb7aa75e801824d65de28a9bfb118659c6f4551de /doc
parent23cee323324f4bb3fc0d0033ef5bd0e4af62dc85 (diff)
r333: um.
Diffstat (limited to 'doc')
-rw-r--r--doc/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/README b/doc/README
index dcc42e6..14df20e 100644
--- 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:
-----------