Re: Cross-test documentation

["Carlos O'Donell" <carlos at systemhalted dot org>]

On Tue, Oct 30, 2012 at 7:30 PM, Joseph S. Myers
<joseph@codesourcery.com> wrote:
> On Tue, 30 Oct 2012, Andreas Schwab wrote:
>
>> "Joseph S. Myers" <joseph@codesourcery.com> writes:
>>
>> > @@ -233,6 +233,17 @@ the newly built binaries of @theglibc{}.  The source and build
>> >  directories must be visible at the same locations on both the build
>> >  system and @var{hostname}.
>> >
>> > +In general, @samp{test-wrapper} may be set when testing @theglibc{} to
>> > +the name and arguments of any program to run newly built binaries.
>>
>> IMHO it'd be better to move "@samp{test-wrapper} may be set" after "when
>> testing @theglibc{}".
>
> This version makes that change (but not any other change to ascribe a
> purpose to the use of such wrappers).
>
> 2012-10-30  Joseph Myers  <joseph@codesourcery.com>
>
>         * manual/install.texi (Configuring and compiling): Document
>         general use of test-wrapper and test-wrapper-env.
>         * INSTALL: Regenerated.

OK.

I would still however prefer a patch that ascribed a purpose to the
wrapper if only to help orient the reader. As a neophyte I'd be asking
myself "What purpose does this functionality serve?"

e.g.
~~~
...
In general, when testing the GNU C Library, `test-wrapper' may be set
to the name and arguments of any program to run newly built binaries.
+ The purpose of `test-wrapper' is to provide a level of indirection
+ that allows the test to run on any system, including remote targets
+ or simulators.
This program must preserve the arguments to the binary being run, its
...
~~~

Cheers,
Carlos.