Re: [PATCH] maint: mention how to run a single test in HACKING docs

[Pádraig Brady]

Jim Meyering wrote:
> Pádraig Brady <address@hidden> wrote:
> ...
>> diff --git a/HACKING b/HACKING
>> index 6eb0480..c8e85f8 100644
>> --- a/HACKING
>> +++ b/HACKING
>> @@ -288,7 +288,9 @@ Nearly every significant change must be accompanied by a 
>> test suite
>>  addition that exercises it.  If you fix a bug, add at least one test that
>>  fails without the patch, but that succeeds once your patch is applied.
>>  If you add a feature, add tests to exercise as much of the new code
>> -as possible.
>> +as possible. Note to run tests/misc/newtest in isolation you can do:
>> +
>> +  make check -C tests TESTS=newtest VERBOSE=yes
> 
> The name after TESTS= should be the name of the file relative to
> the tests/ directory:
> 
>      make check -C tests TESTS=misc/newtest VERBOSE=yes

Oops right :)
I noticed that the original README said:

  make check -C tests/misc TESTS=newtest VERBOSE=yes

This doesn't work I think because there are no Makefile.am
files in the test subdirectories (there was related info
in tests/README that I didn't follow).

Anyway the attached patch should contain info that currently works.

cheers,
Pádraig.

>From 11dab666a195fa14d4bcb32ad8daef90a85c52a3 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?P=C3=A1draig=20Brady?= <address@hidden>
Date: Thu, 12 Feb 2009 13:51:03 +0000
Subject: [PATCH] maint: mention how to run a single test in HACKING docs

* HACKING: Give an example of how to run a test in isolation.
* README: Change to working example of running a single test.
* README-hacking: Reference the HACKING file.
---
 HACKING        |    4 +++-
 README         |    4 ++--
 README-hacking |    1 +
 3 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/HACKING b/HACKING
index 6eb0480..66415c6 100644
--- a/HACKING
+++ b/HACKING
@@ -288,7 +288,9 @@ Nearly every significant change must be accompanied by a 
test suite
 addition that exercises it.  If you fix a bug, add at least one test that
 fails without the patch, but that succeeds once your patch is applied.
 If you add a feature, add tests to exercise as much of the new code
-as possible.
+as possible. Note to run tests/misc/newtest in isolation you can do:
+
+  make check -C tests TESTS=misc/newtest VERBOSE=yes
 
 There are hundreds of tests in the tests/ directories.  You can use
 tests/sample-test as a template, or one of the various Perl-based ones
diff --git a/README b/README
index 157432e..2770faf 100644
--- a/README
+++ b/README
@@ -164,12 +164,12 @@ in verbose mode for each failing test.  For example,
 if the test that fails is tests/mv/hard-link-1, then you
 would run this command:
 
-  env VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
+  env VERBOSE=yes make check -C tests TESTS=mv/hard-link-1 >> log 2>&1
 
 For some tests, you can get even more detail by including
 DEBUG=yes in the environment:
 
-  env DEBUG=yes VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 
2>&1
+  env DEBUG=yes VERBOSE=yes make check -C tests TESTS=mv/hard-link-1 >> log 
2>&1
 
 and then include the contents of the file `log' in your bug report.
 
diff --git a/README-hacking b/README-hacking
index 8333cd0..7a8b4c4 100644
--- a/README-hacking
+++ b/README-hacking
@@ -2,6 +2,7 @@
 
 These notes intend to help people working on the checked-out sources.
 These requirements do not apply when building from a distribution tarball.
+See also HACKING for more detailed coreutils contribution guidlines.
 
 * Requirements
 
-- 
1.5.3.6