Re: more m4sugar documentation

[Benoit SIGOURE]

Catching up on the backlog...

On Oct 13, 2007, at 12:21 AM, Eric Blake wrote:

> I've been busy documenting quite a few m4sugar macros.  Applied:
>
> From: Eric Blake <address@hidden>
> Date: Thu, 11 Oct 2007 14:17:13 -0600
> Subject: [PATCH] Some more m4sugar documentation.
>
> * lib/m4sugar/m4sugar.m4: Clean up macro order.
> * doc/autoconf.texi (Programming in M4): Lighten the warning on
> using m4sugar; it is stabilizing and useful.
> (Redefined M4 Macros): Touch up wording on M4 builtins; sort.  Add
> m4_divert, m4_undivert, __file__, __line__, __oline__.
> (Diagnostics): New node, documenting m4_assert, m4_errprintn,
> m4_fatal, m4_location, m4_warn.
> (Diversion support): New node, documenting m4_divert_push,
> m4_divert_pop, m4_divert_text, m4_divert_once.
> (Text processing Macros): Sort.  Add m4_flatten, m4_join,
> m4_newline, m4_strip, m4_text_box, m4_text_wrap.
> (Programming in M4sh, Macro Names): Document namespace
> limitations.  Mention that non-Automake macros should not begin
> with `AM_'.
> (Reporting Messages): Mark AC_DIAGNOSE, AC_WARNING, and AC_FATAL
> as obsolescent.
> (Printing Messages): Change cross-reference.
>
> Signed-off-by: Eric Blake <address@hidden>
> ---
>  ChangeLog              |   16 ++
>  NEWS                   |   19 ++-
>  doc/autoconf.texi      |  490 +++++++++++++++++++++++++++++++++++++ 
> ++---------
>  lib/m4sugar/m4sugar.m4 |   93 +++++-----
>  4 files changed, 477 insertions(+), 141 deletions(-)
>
> diff --git a/doc/autoconf.texi b/doc/autoconf.texi
> index 239e56f..4a10316 100644
> --- a/doc/autoconf.texi
> +++ b/doc/autoconf.texi
> @@ -10558,12 +10749,112 @@ list2
[...]
> +
> address@hidden m4_strip (@var{string})
> address@hidden
> +Strip whitespace from @var{string}.  Sequences of space and tab are

s/whitespace/&s/

> +reduced to a single space, then leading and trailing spaces are
> +removed.  The result is still a quoted string.
> address@hidden defmac
> +
> address@hidden m4_text_box (@var{message}, @dvar{frame, -})
> address@hidden
> +Add a text box around @var{message}, using @var{frame} as the border
> +character above and below the message.  The frame correctly  
> accounts for
> +the subsequent expansion of @var{message}.  For example:
> address@hidden
> +m4_define([macro], [abc])dnl
> +m4_text_box([macro])
> address@hidden --- ##
> address@hidden abc ##
> address@hidden --- ##
> address@hidden example
> address@hidden defmac
> +
> address@hidden m4_text_wrap (@var{string}, @ovar{prefix}, @
> +  @dvar{prefix1, @var{prefix}}, @dvar{width, 79})
> address@hidden
> +Break @var{string} into a series of whitespace-separated words, then
> +format those words to wrap within @var{width} columns, and without
> +trailing whitespace.  If given, @var{prefix1} is prepended to the  
> first
> +line, and @var{prefix} is prepended to each continuation line.  As a
> +special case, if @var{prefix1} is longer than @var{prefix}, the first
> +line will consist solely of @var{prefix1}.
> +
> +For some examples:

Sounds weird to me (I'm not a native speaker so I don't know whether  
this is correct).

Great work overall!

--
Benoit Sigoure aka Tsuna
EPITA Research and Development Laboratory

PGP.sig
Description: This is a digitally signed message part