summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Zullinger <tmz@pobox.com>2018-02-21 01:36:03 +0000
committerJason A. Donenfeld <Jason@zx2c4.com>2018-02-21 02:12:57 +0000
commit33414d7869aa55aaccd45cdb82268d454cb79863 (patch)
tree2be5d6faa22089f8d1b0c1d7e14f283550130370
parent03f6e34bb9d683723cfc4fe58ee5bb983b95e173 (diff)
downloadcgit-33414d7869aa55aaccd45cdb82268d454cb79863.tar
cgit-33414d7869aa55aaccd45cdb82268d454cb79863.tar.gz
cgit-33414d7869aa55aaccd45cdb82268d454cb79863.zip
doc: use consistent id's when generating html files
The html documentation is generated using a2x which calls docbook tools to do the work. The generate.consistent.ids parameter ensures that when the docbook stylesheet assigns an id value to an output element it is consistent as long as the document structure has not changed. Having consistent html files reduces frivolous changes between builds. Distributions can more easily deploy multiple architecture builds and compare changes between package versions. End-users avoid needless changes in files deployed or backed up. The generate.consistent.ids parameter was added in docbook-xsl-1.77.0. Older versions gracefully ignore the parameter, so we can pass the parameter unconditionally. Most distributions contain docbook-xsl newer than 1.77.0. This includes Fedora, Debian, Ubuntu, and RHEL/CentOS 7. RHEL/CentOS 6 and Debian Wheezy (old stable) ship with an older version, unsurprisingly. Signed-off-by: Todd Zullinger <tmz@pobox.com>
-rw-r--r--Makefile2
1 files changed, 1 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 8321ecc..687069f 100644
--- a/Makefile
+++ b/Makefile
@@ -134,7 +134,7 @@ doc-pdf: $(DOC_PDF)
a2x -f manpage $<
$(DOC_HTML): %.html : %.txt
- a2x -f xhtml --stylesheet=cgit-doc.css $<
+ a2x -f xhtml --stylesheet=cgit-doc.css --xsltproc-opts="--param generate.consistent.ids 1" $<
$(DOC_PDF): %.pdf : %.txt
a2x -f pdf cgitrc.5.txt