Merge branch 'tr/maint-roff-quote' into maint

gitster · gitster · commit 69abb194eed5 · 2009-11-15T16:38:36.000-08:00
* tr/maint-roff-quote:
  Quote ' as \(aq in manpages
diff --git a/Documentation/Makefile b/Documentation/Makefile
@@ -103,6 +103,14 @@ ifdef DOCBOOK_SUPPRESS_SP
 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
 endif
 
+# If your target system uses GNU groff, it may try to render
+# apostrophes as a "pretty" apostrophe using unicode.  This breaks
+# cut&paste, so you should set GNU_ROFF to force them to be ASCII
+# apostrophes.  Unfortunately does not work with non-GNU roff.
+ifdef GNU_ROFF
+XMLTO_EXTRA += -m manpage-quote-apos.xsl
+endif
+
 SHELL_PATH ?= $(SHELL)
 # Shell quote;
 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
diff --git a/Documentation/manpage-quote-apos.xsl b/Documentation/manpage-quote-apos.xsl
@@ -0,0 +1,16 @@
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+		version="1.0">
+
+<!-- work around newer groff/man setups using a prettier apostrophe
+     that unfortunately does not quote anything when cut&pasting
+     examples to the shell -->
+<xsl:template name="escape.apostrophe">
+  <xsl:param name="content"/>
+  <xsl:call-template name="string.subst">
+    <xsl:with-param name="string" select="$content"/>
+    <xsl:with-param name="target">'</xsl:with-param>
+    <xsl:with-param name="replacement">\(aq</xsl:with-param>
+  </xsl:call-template>
+</xsl:template>
+
+</xsl:stylesheet>
diff --git a/Makefile b/Makefile
@@ -159,6 +159,10 @@ all::
 # Define ASCIIDOC_NO_ROFF if your DocBook XSL escapes raw roff directives
 # (versions 1.72 and later and 1.68.1 and earlier).
 #
+# Define GNU_ROFF if your target system uses GNU groff.  This forces
+# apostrophes to be ASCII so that cut&pasting examples to the shell
+# will work.
+#
 # Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's
 # MakeMaker (e.g. using ActiveState under Cygwin).
 #

Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,10 @@ all::`
`159`	`159`	`# Define ASCIIDOC_NO_ROFF if your DocBook XSL escapes raw roff directives`
`160`	`160`	`# (versions 1.72 and later and 1.68.1 and earlier).`
`161`	`161`	`#`
	`162`	`+# Define GNU_ROFF if your target system uses GNU groff. This forces`
	`163`	`+# apostrophes to be ASCII so that cut&pasting examples to the shell`
	`164`	`+# will work.`
	`165`	`+#`
`162`	`166`	`# Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's`
`163`	`167`	`# MakeMaker (e.g. using ActiveState under Cygwin).`
`164`	`168`	`#`