Re: [PATCH] doc: make HTML manual reproducible

From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Dec 2, 2020, 00:41 UTC
Message-ID: <X8bis7ZnU8FViHjk@camp.crustytoothpaste.net>
In-Reply-To: <20201201095037.20715-1-arnout@bzzt.net>

On 2020-12-01 at 09:50:37, Arnout Engelen wrote:

Show 19 quoted lines

> This makes sure the generated id's inside the html version of the
> documentation use the same id's when the same version of the
> manual is generated twice.
> 
> Signed-off-by: Arnout Engelen <arnout@bzzt.net>
> ---
>  Documentation/Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 80d1908a44..4d1fd5e31f 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -380,7 +380,7 @@ SubmittingPatches.txt: SubmittingPatches
>  	$(QUIET_GEN) cp $< $@
>  
>  XSLT = docbook.xsl
> -XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
> +XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css --stringparam generate.consistent.ids 1

I think we'll want --param here, not --stringparam. This is documented to be an integer, not a string. The difference is that --stringparam sets the value to "1" (that is, a string with a single character) instead of the integer 1.

We may also want to wrap this to the next line like so:

  XSLTOPTS =  --xinclude --stringparam html.stylesheet docbook-xsl.css
  XSLTOPTS += --param generate.consistent.ids 1

Otherwise, I think this is a valuable change, as I've mentioned downthread. I already use this option on my own projects for the same reason.

-- 
brian m. carlson (he/him or they/them)
Houston, Texas, US