[Top][All Lists]

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

small doc markup cleanups

From: Ralf Wildenhues
Subject: small doc markup cleanups
Date: Thu, 8 Jun 2006 00:27:34 +0200
User-agent: Mutt/1.5.11+cvs20060403

The html target in doc/ currently uses texi2html.
I investigated a bit the HTML that 'makeinfo --html' from CVS
texinfo generates (makeinfo is also used by and
ran that through tidy.  (Some reports to texinfo are due to this.)

The following patch eliminates some of the warnings.  I'd like the
patch to be reviewed (not only but also) because I'm not sure about
all changes.  Esp. the @dvar changes cause changed capitalization in
the info output, although I think this is probably intended; the
expr `|' change looks better IMHO, but may be confusing as the two
parts aren't as stronly connected any more now.

What do you think?

I don't know whether we should keep the HTML generation with
texi2html in the tree now.  Probably a safe bet, so I'm inclined
to leave that as is for now (but still plan on building the online
docs with gendocs, thus makeinfo).


        * doc/autoconf.texi (Installation Directory Variables):
        Drop extra @samp from address@hidden @samp' item.
        (Limitations of Usual Tools): Comment fix.
        Do not nest @samp just to point to other table items.
        (Writing <AT_CHECK>: The second argument to
        address@hidden' is already @samp'ed.
        (Making testsuite Scripts) <AC_CONFIG_TESTDIR>: Likewise,
        do not use @var in the second argument.

Index: doc/autoconf.texi
RCS file: /cvsroot/autoconf/autoconf/doc/autoconf.texi,v
retrieving revision 1.1041
diff -u -r1.1041 autoconf.texi
--- doc/autoconf.texi   6 Jun 2006 01:44:53 -0000       1.1041
+++ doc/autoconf.texi   6 Jun 2006 21:52:45 -0000
@@ -2596,7 +2596,7 @@
 @xref{Limitations of Make}, for details.
address@hidden @samp{$(srcdir)}
address@hidden $(srcdir)
 Be sure to specify the name of the source directory,
 otherwise the package won't support separated builds.
 @end table
@@ -12639,7 +12640,7 @@
 @table @asis
 @item Awk
address@hidden ----------------
address@hidden ------
 @prindex Awk
 Don't leave white space before the opening parenthesis in a user function call.
 Posix does not allow this and @acronym{GNU} Awk rejects it:
@@ -13009,7 +13010,7 @@
 Unfortunately this behaves exactly as the original expression; see the
address@hidden@command{expr} (@samp{|})} entry for more information.
address@hidden (@samp{|}) entry for more information.
 Ancient @command{expr} implementations (e.g., SunOS 4 @command{expr} and
 Solaris 8 @command{/usr/ucb/expr}) have a silly length limit that causes
@@ -17563,7 +17570,7 @@
 expansion.  The contents ought to end with an end of line.
 @end defmac
address@hidden AT_CHECK (@var{commands}, @dvar{status, @samp{0}}, @dvar{stdout, 
@samp{}}, @dvar{stderr, @samp{}}, @ovar{run-if-fail}, @ovar{run-if-pass})
address@hidden AT_CHECK (@var{commands}, @dvar{status, 0}, @dvar{stdout, }, 
@dvar{stderr, }, @ovar{run-if-fail}, @ovar{run-if-pass})
 Execute a test by performing given shell @var{commands}.  These commands
 should normally exit with @var{status}, while producing expected
@@ -17741,7 +17748,7 @@
 Invoke @code{AC_CONFIG_TESTDIR}.
address@hidden AC_CONFIG_TESTDIR (@var{directory}, @dvar{test-path, 
address@hidden AC_CONFIG_TESTDIR (@var{directory}, @dvar{test-path, directory})
 An Autotest test suite is to be configured in @var{directory}.  This
 macro requires the instantiation of @address@hidden/atconfig} from

reply via email to

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