doc tweak

Eric Blake <[email protected]>
Newsgroups gmane.comp.gnu.m4.patches
Message-ID <[email protected]>
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I noticed an underfull hbox while testing 'make distcheck' with the new
automake.  Committing this to work around it, and make the example a bit
more verbose.

- --
Don't work too hard, make some time for fun as well!

Eric Blake             [email protected]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (Cygwin)
Comment: Public key at home.comcast.net/~ericblake/eblake.gpg
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFHllYY84KuGfSFAYARAkmDAKDU+H57fskf3AqAkKjH4/RB85mWxgCfXfTC
Ea5Nxj+titTO9Gy63lwDdvc=
=z1ZG
-----END PGP SIGNATURE-----

_______________________________________________
M4-patches mailing list
[email protected]
http://lists.gnu.org/mailman/listinfo/m4-patches
m4.patch309 (text/plain, 1.9 KB)
From 28cd2024b5c84141f2c3cf08602141b33eadd85a Mon Sep 17 00:00:00 2001
From: Eric Blake <[email protected]>
Date: Tue, 22 Jan 2008 11:53:46 -0700
Subject: [PATCH] Doc tweak.

* doc/m4.texinfo (Renamesyms): Avoid underfull hbox, and improve
example.

Signed-off-by: Eric Blake <[email protected]>
---
 ChangeLog      |    6 ++++++
 doc/m4.texinfo |   19 ++++++++++++++++---
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 782b475..15589bb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-01-22  Eric Blake  <[email protected]>
+
+	Doc tweak.
+	* doc/m4.texinfo (Renamesyms): Avoid underfull hbox, and improve
+	example.
+
 2008-01-21  Eric Blake  <[email protected]>
 
 	Stage 11: full circle for single argument references.
diff --git a/doc/m4.texinfo b/doc/m4.texinfo
index df08093..5d87489 100644
--- a/doc/m4.texinfo
+++ b/doc/m4.texinfo
@@ -2460,14 +2460,27 @@ The macro @code{renamesyms} is recognized only with parameters.
 This macro was added in M4 2.0.
 @end deffn
 
-Here is an example that starts by performing a similar renaming to the
-@option{--prefix-builtins} option (or @option{-P}).  Where
-@option{--prefix-builtins} only renames M4 builtin macros,
+The following example starts with a rename similar to the
+@option{--prefix-builtins} option (or @option{-P}), prefixing every
+macro with @code{m4_}.  However, note that @option{-P} only renames M4
+builtin macros, even if other macros were defined previously, while
 @code{renamesyms} will rename any macros that match when it runs,
 including text macros.  The rest of the example demonstrates the
 behavior of unanchored regular expressions in symbol renaming.
 
+@comment options: -Dfoo=bar -P
 @example
+$ @kbd{m4 -Dfoo=bar -P}
+foo
+@result{}bar
+m4_foo
+@result{}m4_foo
+m4_defn(`foo')
+@result{}bar
+@end example
+
+@example
+$ @kbd{m4}
 define(`foo', `bar')
 @result{}
 renamesyms(`^.*$', `m4_\&')
-- 
1.5.3.8
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.