diff mbox

[PROPOSED] Fix doc quoting problems with Texinfo 5

Message ID 1449771388-13394-1-git-send-email-eggert@cs.ucla.edu
State New, archived
Headers

Commit Message

Paul Eggert Dec. 10, 2015, 6:16 p.m. UTC 
  Without this change, in the info file output Texinfo 5 quotes code
in text with undirected single quotes 'like this' and generates
code examples that with many PDF readers cannot be cut out of PDFs
and pasted into code.
* manual/libc.texinfo: Configure the libc manual like the GNU
Emacs manual, by using @documentencoding and setting
txicodequoteundirected and txicodequotebacktick.  This way,
Texinfo 5 quotes code in text with directed single quotes ‘like
this’ and produces examples that can be cut out of PDFs.  This
change causes Texinfo 5 to generate info files that contain UTF-8
characters in the set {'‘', '’', '“', '”', 'Ä', 'ä', 'ö', '−',
'–', '—', '©', '⇒', '•', '…'}, which is OK nowadays.
---
 ChangeLog           | 14 ++++++++++++++
 manual/libc.texinfo |  7 +++++++
 2 files changed, 21 insertions(+)

Comments

Paul Eggert Jan. 10, 2016, 8:28 a.m. UTC | #1 
No further comment and this is merely fixing the documentation output format so 
I installed the doc quoting fix proposed in 
<https://sourceware.org/ml/libc-alpha/2015-12/msg00187.html>. For ancient 
Texinfo (4.9 or earlier) this change should have no effect, aside from perhaps 
some stderr chatter when building the documentation.
diff mbox

Patch

diff --git a/ChangeLog b/ChangeLog
index 81e5791..6a71f9f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,19 @@ 
 2015-12-10  Paul Eggert  <eggert@cs.ucla.edu>
 
+	Fix doc quoting problems with Texinfo 5
+	Without this change, in the info file output Texinfo 5 quotes code
+	in text with undirected single quotes 'like this' and generates
+	code examples that with many PDF readers cannot be cut out of PDFs
+	and pasted into code.
+	* manual/libc.texinfo: Configure the libc manual like the GNU
+	Emacs manual, by using @documentencoding and setting
+	txicodequoteundirected and txicodequotebacktick.  This way,
+	Texinfo 5 quotes code in text with directed single quotes ‘like
+	this’ and produces examples that can be cut out of PDFs.  This
+	change causes Texinfo 5 to generate info files that contain UTF-8
+	characters in the set {'‘', '’', '“', '”', 'Ä', 'ä', 'ö', '−',
+	'–', '—', '©', '⇒', '•', '…'}, which is OK nowadays.
+
 	Split large string section; add truncation advice
 	* manual/examples/strncat.c: Remove.
 	This example was misleading, as the code would have undefined
diff --git a/manual/libc.texinfo b/manual/libc.texinfo
index 554f8b0..5d8ad07 100644
--- a/manual/libc.texinfo
+++ b/manual/libc.texinfo
@@ -2,6 +2,13 @@ 
 @comment %**start of header (This is for running Texinfo on a region.)
 @setfilename libc.info
 @settitle The GNU C Library
+@documentencoding UTF-8
+@c '@codequotebacktick on' and '@codequoteundirected on' require
+@c Texinfo 5.0 or later, so use the older equivalent @set variables
+@c supported in Texinfo 4.11 and later.
+@set txicodequoteundirected
+@set txicodequotebacktick
+
 @c setchapternewpage odd
 
 @include macros.texi