summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Blake <eblake@redhat.com>2014-05-13 15:34:30 -0600
committerEric Blake <eblake@redhat.com>2014-05-13 15:34:30 -0600
commitf5ef8cf7b90a1400b7955904a82814edb2a7d71e (patch)
tree1515dfcd6f6ab102f963eaf0fe7edd3180a2cd27
parent12d9ca5eef1e839aa61f7e821fa4b2bee4c63d23 (diff)
downloadm4-f5ef8cf7b90a1400b7955904a82814edb2a7d71e.tar.gz
doc: fix line-wrapped macro definitions
The html rendering of the manual ate a comma and inserted an awkward line wrap for the "example" macro prototype: https://www.gnu.org/software/m4/manual/m4-1.4.17/html_node/Manual.html As documented in autoconf, use of @c does not work for macros which are designed for inline use within @deffn and friends. http://git.savannah.gnu.org/gitweb/?p=autoconf.git;a=commitdiff;h=a357718 * doc/m4.texi: Drop bogus @c. Reported by Marijn Schouten, fix by Patrice Dumas copied from autoconf code base. Signed-off-by: Eric Blake <eblake@redhat.com>
-rw-r--r--ChangeLog7
-rw-r--r--doc/m4.texi4
2 files changed, 9 insertions, 2 deletions
diff --git a/ChangeLog b/ChangeLog
index 9b865cfb..5643bea8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2014-05-13 Eric Blake <eblake@redhat.com>
+
+ doc: fix line-wrapped macro definitions
+ * doc/m4.texi: Drop bogus @c.
+ Reported by Marijn Schouten, fix by Patrice Dumas copied from
+ autoconf code base.
+
2014-02-05 Vitezslav Crhonek <vcrhonek@redhat.com> (tiny change)
main: diagnose unsupported --word-regexp
diff --git a/doc/m4.texi b/doc/m4.texi
index 1f142909..2960cff9 100644
--- a/doc/m4.texi
+++ b/doc/m4.texi
@@ -23,7 +23,7 @@
@c The ARG is an optional argument. To be used for macro arguments in
@c their documentation (@defmac).
@macro ovar{varname}
-@r{[}@var{\varname\}@r{]}@c
+@r{[}@var{\varname\}@r{]}
@end macro
@c @dvar{ARG, DEFAULT}
@@ -31,7 +31,7 @@
@c The ARG is an optional argument, defaulting to DEFAULT. To be used
@c for macro arguments in their documentation (@defmac).
@macro dvar{varname, default}
-@r{[}@var{\varname\} = @samp{\default\}@r{]}@c
+@r{[}@var{\varname\} = @samp{\default\}@r{]}
@end macro
@comment %**end of header