[PATCH] t/README: document --root option

[PATCH] t/README: document --root option

[Thomas Rast]

We've had this option since f423ef5 (tests: allow user to specify
trash directory location, 2009-08-09).  Make it easier to look up :-)

Signed-off-by: Thomas Rast <trast@student.ethz.ch>
---
 t/README |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/t/README b/t/README
index dcd3ebb..0470c14 100644
--- a/t/README
+++ b/t/README
@@ -84,6 +84,12 @@ appropriately before running "make".
 	implied by other options like --valgrind and
 	GIT_TEST_INSTALLED.
 
+--root=<directory>::
+	Use <directory> as a trash directory to store all temporary
+	data during testing, instead of the t/ directory itself.
+	Using this option with a RAM-based filesystem (such as tmpfs)
+	can massively speed up the test suite.
+
 You can also set the GIT_TEST_INSTALLED environment variable to
 the bindir of an existing git installation to test that installation.
 You still need to have built this git sandbox, from which various
-- 
1.7.1.553.ga798e

Re: [PATCH] t/README: document --root option

[Jeff King]

On Thu, Jun 10, 2010 at 08:24:46PM +0200, Thomas Rast wrote:

> We've had this option since f423ef5 (tests: allow user to specify
> trash directory location, 2009-08-09).  Make it easier to look up :-)

Acked-by: Jeff King <peff@peff.net>

> +--root=<directory>::
> +	Use <directory> as a trash directory to store all temporary
> +	data during testing, instead of the t/ directory itself.
> +	Using this option with a RAM-based filesystem (such as tmpfs)
> +	can massively speed up the test suite.

Minor nit: <directory> is not the trash directory, but rather the root
of all trash directories. I think anybody with half a clue will
understand what it means, though.

-Peff

Re: [PATCH] t/README: document --root option

[Junio C Hamano]

Jeff King <peff@peff.net> writes:

> On Thu, Jun 10, 2010 at 08:24:46PM +0200, Thomas Rast wrote:
>
>> We've had this option since f423ef5 (tests: allow user to specify
>> trash directory location, 2009-08-09).  Make it easier to look up :-)
>
> Acked-by: Jeff King <peff@peff.net>
>
>> +--root=<directory>::
>> +	Use <directory> as a trash directory to store all temporary
>> +	data during testing, instead of the t/ directory itself.
>> +	Using this option with a RAM-based filesystem (such as tmpfs)
>> +	can massively speed up the test suite.
>
> Minor nit: <directory> is not the trash directory, but rather the root
> of all trash directories. I think anybody with half a clue will
> understand what it means, though.

Then...

	Create "trash" directories used to store all temporary data during
	testing under <directory>, instead of the t/ directory.

perhaps?

Re: [PATCH] t/README: document --root option

[Jeff King]

On Fri, Jun 11, 2010 at 01:48:26PM -0700, Junio C Hamano wrote:

> >> +--root=<directory>::
> >> +	Use <directory> as a trash directory to store all temporary
> >> +	data during testing, instead of the t/ directory itself.
> >> +	Using this option with a RAM-based filesystem (such as tmpfs)
> >> +	can massively speed up the test suite.
> >
> > Minor nit: <directory> is not the trash directory, but rather the root
> > of all trash directories. I think anybody with half a clue will
> > understand what it means, though.
> 
> Then...
> 
> 	Create "trash" directories used to store all temporary data during
> 	testing under <directory>, instead of the t/ directory.

Yeah, that is much better, IMHO.

-Peff

Re: [PATCH] t/README: document --root option

[Thomas Rast]

Jeff King wrote:
> On Fri, Jun 11, 2010 at 01:48:26PM -0700, Junio C Hamano wrote:
> > 
> > Then...
> > 
> > 	Create "trash" directories used to store all temporary data during
> > 	testing under <directory>, instead of the t/ directory.
> 
> Yeah, that is much better, IMHO.

I see you already picked that up.  Thanks!

-- 
Thomas Rast
trast@{inf,student}.ethz.ch