aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorMarius Vollmer <marius.vollmer@nokia.com>2009-04-01 23:14:38 +0300
committerMarius Vollmer <marius.vollmer@nokia.com>2009-04-01 23:14:38 +0300
commit4997695b43c18ca6bacb98b39b451ac96c7a568b (patch)
tree03db24865ac4b995941b6d07fd9713ce13bd624a /HACKING
parentd037d26ad4fec6b936e018b987335f74779f7710 (diff)
Some words about documentation in distributions.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING18
1 files changed, 18 insertions, 0 deletions
diff --git a/HACKING b/HACKING
index f55f6354..8d145a9c 100644
--- a/HACKING
+++ b/HACKING
@@ -25,6 +25,24 @@ separate branches. Upstream development generally happens on the
"pkg-master" into "master". If you want to move changes from
"pkg-master" back to "master", cherry-pick them.
+Documentation
+-------------
+
+Documentation is in HTML and generally distributed in the tarballs and
+distribution tags. We do this so that recipients don't need all the
+crazy build tools that we use and still get some documentation.
+
+Thus, all documentation files should be added to EXTRA_DIST and
+MAINTAINERCLEANFILES.
+
+Since timestamps are not always preserved well enough when checking a
+distribution tag out of Git, it might happen that documentation is
+being regenerated also during a pure target build, and might fail.
+
+It's not yet totally clear how to cope with that: one approach is to
+have something autotool's "missing", another might be to touch all
+generated files during configure. Let's see.
+
Environments
------------