Re: [PATCH] Add documentation on how to integrate commands.
- From
Michael Haggerty <mhagger@alum.mit.edu>
- Date
- Nov 25, 2012, 07:12 UTC
- Message-ID
- <50B1C4E3.9070500@alum.mit.edu>
- In-Reply-To
- <20121124122333.BAD7B4065F@snark.thyrsus.com>
On 11/24/2012 01:23 PM, Eric S. Raymond wrote:
Show 27 quoted lines
> --- > Documentation/CommandIntegration | 69 ++++++++++++++++++++++++++++++++++++++ > 1 file changed, 69 insertions(+) > create mode 100644 Documentation/CommandIntegration > > diff --git a/Documentation/CommandIntegration b/Documentation/CommandIntegration > new file mode 100644 > index 0000000..be248f7 > --- /dev/null > +++ b/Documentation/CommandIntegration > @@ -0,0 +1,69 @@ > [...] > +You must have a test, written to report in TAP (Test Anything Protocol). > +Tests are executables (usually shell scripts) that live in the 't' > +subdirectory of the tree. Each test name begins with 't' and a sequence > +number that controls where in the test sequence it will be executed; > +conventionally the rest of the name stem is that of the command > +being tested. > + > +If your test requires an example repository, create it yourself in the > +test script. There is a test library of shell functions that assists > +wit this; when you use it, the environment is set in a predictable way > +so the author, committer and timestamps are all set to a single well > +known value, allowing git to create a commit that is reproducible on > +all platforms. A test_tick function is used in the scripts to move the > +clock, allowing different times to be used. For an example see > +t7502-commit.sh, or really any script in that directory.
I think that here a reference to the file t/README would help (and perhaps make part of your text redundant).
Michael
-- Michael Haggerty mhagger@alum.mit.edu http://softwareswirl.blogspot.com/