Re: [PATCH] docs: avoid a footnote, some related rewordings and improvements (was: Re: [Automake-commit] [SCM] GNU Automake branch, maint, updated. v1.11-393-gc1040a7)

[Stefano Lattarini]

On Monday 27 June 2011, Ralf Wildenhues wrote:
> * Stefano Lattarini wrote on Mon, Jun 27, 2011 at 03:35:23PM CEST:
> > On Monday 27 June 2011, Ralf Wildenhues wrote:
> > > > address@hidden The following example should be covered by the test case
> > > > address@hidden 'autodist-config-headers.test'.
> > > 
> > > @c The following example is covered by autodist-config-headers.test.
> 
> > > Maybe even some kind of formatted comment, to allow some checking in the
> > > future?
> > >
> > A nice idea.  Suggestions?
> 
> autoconf.texi uses stuff like:
> 
> @c If you change this example, adjust tests/semantics.at:AC_CHECK_SIZEOF 
> struct.
> 
> > Oh, and I'd keep this for a follow-up, bacause
> > there are already similar testcase-referring comments in the manual, which
> > will have to be adjusted.
> 
> Sure.  Well, do they use some format already?
>
Well, there are only two of them, and both follows this format:

@c The test case for the setup described here is
@c     test/subdircond2.test
@c Try to keep it in sync.

(which is wrongish BTW, as the testsuite subdirectory is `tests/',
not `test/')

I'd go with one of these simple formats:
  @c Keep in sync with subdircond2.test
  @c The following is covered by subdircond2.test
which are short and easy to grep; and I'd document this "idiom" in
tests/README.  I can do that by this evening if nobody beats me.

Regards,
  Stefano