Re: [PATCH] Documentation: use "spurious .sp" XSLT if DOCBOOK_SUPPRESS_SP is set

[Jeff King <peff@peff.net>]

On Wed, Apr 01, 2009 at 03:50:34AM -0500, Chris Johnsen wrote:

> With this change, the "spurious .sp" suppression XSLT code is
> disabled by default. It can be enabled by defining
> DOCBOOK_SUPPRESS_SP.
> [...]
> Signed-off-by: Chris Johnsen <chris_johnsen@pobox.com>

Acked-by: Jeff King <peff@peff.net>

This looks good to me. Thank you for being so thorough in both the
research and implementation, especially when I was being so lazy. :)

> I went with a "feature knob" instead of a "version knob" since my
> research in the docbook SVN repo indicates that multiple versions
> are affected. Maybe the name could be better. Also I am not at
> all sure that my research into past docbook-xsl releases is 100%
> accurate. Anyone motivated enough to install old versions of
> docbook-xsl and test with them?

I think the "feature knob" makes sense. I don't know that it is worth
extensive testing with old releases. You have a pretty good guess about
which versions are affected, and people who experience the problem can
turn the knob. Your Makefile comments make it easy for them find the
knob once they see the breakage.

It is probably worth mentioning in the release notes to give a heads-up,
though.

Something like:

-- >8 --
Subject: mention docbook knob in the release notes

People with ancient docbook-xsl will see the return of the "spurious
.sp" unless this knob is turned, so let's inform them.

---
diff --git a/Documentation/RelNotes-1.6.3.txt b/Documentation/RelNotes-1.6.3.txt
index f0a2e41..0c8a14e 100644
--- a/Documentation/RelNotes-1.6.3.txt
+++ b/Documentation/RelNotes-1.6.3.txt
@@ -107,6 +107,11 @@ Updates since v1.6.2
 * Makefile learned 'coverage' option to run the test suites with
   coverage tracking enabled.
 
+* Building the manpages with docbook-xsl between 1.69.1 and 1.71.1 now
+  requires setting DOCBOOK_SUPPRESS_SP to work around a docbook-xsl bug.
+  This workaround used to be enabled by default, but causes problems
+  with newer versions of docbook-xsl.
+
 Fixes since v1.6.2
 ------------------