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

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

From
Jeff King <peff@peff.net>
Date
Apr 1, 2009, 10:14 UTC
Message-ID
<20090401101400.GA26181@coredump.intra.peff.net>
In-Reply-To
<1238575834-17838-1-git-send-email-chris_johnsen@pobox.com>
On Wed, Apr 01, 2009 at 03:50:34AM -0500, Chris Johnsen wrote:
Show 5 quoted lines
> 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. :)

Show 6 quoted lines
> 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
 ------------------
Previous: Chris JohnsenNext: Junio C Hamano
Message 18 of 22 in “Add warning about known issues to documentation of cvsimport”
  1. Add warning about known issues to documentation of cvsimportHeiko Voigt, Mar 23, 2009
  2. Ferry Huberts (Pelagic)Mar 23, 2009
  3. Heiko VoigtMar 30, 2009
  4. Ferry Huberts (Pelagic)Mar 31, 2009
  5. Heiko VoigtMar 31, 2009
  6. cvsimport: Add a note about crlf options to the documentationHeiko Voigt, Mar 31, 2009
  7. Ferry Huberts (Pelagic)Mar 31, 2009
  8. Jeff KingMar 24, 2009
  9. Heiko VoigtMar 30, 2009
  10. Junio C HamanoMar 31, 2009
  11. Cleanup warning about known issues in cvsimport documentationHeiko Voigt, Mar 31, 2009
  12. Jeff KingMar 31, 2009
  13. Cleanup warning about known issues in cvsimport documentationHeiko Voigt, Apr 1, 2009
  14. Jeff KingMar 31, 2009
  15. Jeff KingMar 31, 2009
  16. Junio C HamanoMar 31, 2009
  17. Documentation: use "spurious .sp" XSLT if DOCBOOK_SUPPRESS_SP is setChris Johnsen, Apr 1, 2009
  18. Jeff KingApr 1, 2009
  19. Junio C HamanoApr 2, 2009
  20. Jeff KingApr 1, 2009
  21. Chris JohnsenApr 1, 2009
  22. Jeff KingApr 1, 2009

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.