m4-patches
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] doc: fix line-wrapped macro definitions


From: Eric Blake
Subject: [PATCH] doc: fix line-wrapped macro definitions
Date: Tue, 13 May 2014 15:37:45 -0600

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 (dvar, ovar): Drop bogus @c.
Reported by Marijn Schouten, fix by Patrice Dumas copied from
autoconf code base.

Signed-off-by: Eric Blake <address@hidden>
---
 ChangeLog   | 7 +++++++
 doc/m4.texi | 4 ++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 9b865cf..5643bea 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2014-05-13  Eric Blake  <address@hidden>
+
+       doc: fix line-wrapped macro definitions
+       * doc/m4.texi (dvar, ovar): Drop bogus @c.
+       Reported by Marijn Schouten, fix by Patrice Dumas copied from
+       autoconf code base.
+
 2014-02-05  Vitezslav Crhonek  <address@hidden>  (tiny change)

        main: diagnose unsupported --word-regexp
diff --git a/doc/m4.texi b/doc/m4.texi
index 1f14290..2960cff 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}
address@hidden@address@hidden@c
address@hidden@address@hidden
 @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}
address@hidden@var{\varname\} = @address@hidden@c
address@hidden@var{\varname\} = @address@hidden
 @end macro

 @comment %**end of header
-- 
1.9.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]