git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re* [PATCH] doc: make HTML manual reproducible

From
Junio C Hamano <gitster@pobox.com>
Date
Dec 3, 2020, 02:31 UTC
Message-ID
<xmqqim9jipre.fsf_-_@gitster.c.googlers.com>
In-Reply-To
<20201203020059.GY748@pobox.com>
Todd Zullinger <tmz@pobox.com> writes:
> I suppose we'd ideally look for a v2 with --stringparam
> replaced with --param as you noted upthread?
Yes.
> And maybe an updated commit message to note that it requires
> docbook-xsl 1.79.1 to be effective, but older versions
> gracefully ignore the option?
Yes, definitely.

Here is what I'd queue tentatively to potentially reduce one round-trip (if Arnout is happy with this version, we can just hear "yes, that's good" without a formal v2).

Thanks.
--- >8 ------ >8 ------ >8 ------ >8 ------ >8 ------ >8 ---
From: Arnout Engelen <arnout@bzzt.net>
Date: Tue, 1 Dec 2020 09:50:37 +0000
Subject: [PATCH v2] doc: make HTML manual reproducible

Versions of docbook-xsl newer than 1.79.1 allows xsltproc to assign IDs to nodes in the generated HTML consistently, to make the output resulting from the same source stable and reproducible.

Pass the generate.consistent.ids parameter from the command line to ask for this feature. Older versions of the tool simply ignores the parameter and produces their output the same way as before this change, so there is no need to check for toolchain version.

Signed-off-by: Arnout Engelen <arnout@bzzt.net>
Helped-by: brian m. carlson <sandals@crustytoothpaste.net>
Helped-by: Todd Zullinger <tmz@pobox.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
Notes (amlog):
    Message-Id: <20201201095037.20715-1-arnout@bzzt.net>
 Documentation/Makefile | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 80d1908a44..69dbe4bb0b 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -380,7 +380,10 @@ SubmittingPatches.txt: SubmittingPatches
 	$(QUIET_GEN) cp $< $@
 
 XSLT = docbook.xsl
-XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
+XSLTOPTS =
+XSLTOPTS += --xinclude
+XSLTOPTS += --stringparam html.stylesheet docbook-xsl.css
+XSLTOPTS += --param generate.consistent.ids 1
 
 user-manual.html: user-manual.xml $(XSLT)
 	$(QUIET_XSLTPROC)$(RM) $@+ $@ && \
-- 
2.29.2-589-gfe47622759
Previous: Todd ZullingerNext: Arnout Engelen
Message 13 of 15 in “doc: make HTML manual reproducible”
  1. doc: make HTML manual reproducibleArnout Engelen, Dec 1, 2020
  2. Todd ZullingerDec 1, 2020
  3. Martin ÅgrenDec 1, 2020
  4. Jeff KingDec 2, 2020
  5. Junio C HamanoDec 1, 2020
  6. Martin ÅgrenDec 1, 2020
  7. brian m. carlsonDec 2, 2020
  8. Todd ZullingerDec 2, 2020
  9. Junio C HamanoDec 2, 2020
  10. brian m. carlsonDec 2, 2020
  11. Junio C HamanoDec 3, 2020
  12. Todd ZullingerDec 3, 2020
  13. Re* [PATCH] doc: make HTML manual reproducibleJunio C Hamano, Dec 3, 2020
  14. Arnout EngelenDec 3, 2020
  15. brian m. carlsonDec 2, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.