git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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/
Previous: Eric S. RaymondNext: Eric S. Raymond
Message 5 of 8 in “Add documentation on how to integrate commands.”
  1. Add documentation on how to integrate commands.Eric S. Raymond, Nov 24, 2012
  2. Pete WyckoffNov 24, 2012
  3. Eric S. RaymondNov 24, 2012
  4. Eric S. RaymondNov 25, 2012
  5. Michael HaggertyNov 25, 2012
  6. Eric S. RaymondNov 25, 2012
  7. Junio C HamanoNov 26, 2012
  8. Eric S. RaymondNov 26, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.