doc tweak

[Eric Blake]

-----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             address@hidden
-----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-----

>From 28cd2024b5c84141f2c3cf08602141b33eadd85a Mon Sep 17 00:00:00 2001
From: Eric Blake <address@hidden>
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 <address@hidden>
---
 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  <address@hidden>
+
+       Doc tweak.
+       * doc/m4.texinfo (Renamesyms): Avoid underfull hbox, and improve
+       example.
+
 2008-01-21  Eric Blake  <address@hidden>
 
        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
address@hidden option (or @option{-P}).  Where
address@hidden only renames M4 builtin macros,
+The following example starts with a rename similar to the
address@hidden 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.
 
address@hidden options: -Dfoo=bar -P
 @example
+$ @kbd{m4 -Dfoo=bar -P}
+foo
address@hidden
+m4_foo
address@hidden
+m4_defn(`foo')
address@hidden
address@hidden example
+
address@hidden
+$ @kbd{m4}
 define(`foo', `bar')
 @result{}
 renamesyms(`^.*$', `m4_\&')
-- 
1.5.3.8