summaryrefslogtreecommitdiff
path: root/doc/check-typography
diff options
context:
space:
mode:
authorvlefevre <vlefevre@280ebfd0-de03-0410-8827-d642c229c3f4>2016-05-04 14:01:31 +0000
committervlefevre <vlefevre@280ebfd0-de03-0410-8827-d642c229c3f4>2016-05-04 14:01:31 +0000
commit2aa6ff4e04eb22c92f9a3eda7df676728569d0f1 (patch)
treec1bc296b94f87236860b95094c72e415aa35b5cb /doc/check-typography
parente0758db7f0cc2f7f8f21d3450329ba15aeb4fc50 (diff)
downloadmpfr-2aa6ff4e04eb22c92f9a3eda7df676728569d0f1.tar.gz
[Makefile.am] Add doc/check-typography to the tarball as it is needed
to rebuild the mpfr.info file if the mpfr.texi file is modified. [doc/check-typography] Added copyright notice and explanations. git-svn-id: svn://scm.gforge.inria.fr/svn/mpfr/trunk@10285 280ebfd0-de03-0410-8827-d642c229c3f4
Diffstat (limited to 'doc/check-typography')
-rwxr-xr-xdoc/check-typography18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/check-typography b/doc/check-typography
index 4fe9d01c7..ce2342471 100755
--- a/doc/check-typography
+++ b/doc/check-typography
@@ -1,8 +1,26 @@
#!/bin/sh
+# Copyright 2016 Free Software Foundation, Inc.
+# This script is free software; the Free Software Foundation
+# gives unlimited permission to copy and/or distribute it,
+# with or without modifications, as long as this notice is preserved.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+# PARTICULAR PURPOSE.
+
o=$(grep -E '[A-Z]\)?[.!?]( |$)' mpfr.texi | grep -Ev '^(\* .*::|@c )')
[ -z "$o" ] && exit
+# Note: The default Texinfo rules are heuristics allowing one to get
+# typography correct by default in most cases, but it is also easy to
+# leave errors if one does not check the generated info file. Thus it
+# is better to make typography explicit concerning punctuation marks.
+# The above test checks lines ending with a capital letter possibly
+# followed by a closing parenthesis, followed by one of the concerned
+# punctuation marks; menu items and comments are ignored.
+
cat <<EOF
[check-typography] Warning! Possibly incorrect typography.
Make it explicit to avoid ambiguities: