Re: [PATCH] Add documentation on how to integrate commands.

From: Pete Wyckoff <pw@padd.com>
Date: Nov 24, 2012, 15:11 UTC
Message-ID: <20121124151127.GA24459@padd.com>
In-Reply-To: <20121124122333.BAD7B4065F@snark.thyrsus.com>

esr@thyrsus.com wrote on Sat, 24 Nov 2012 07:23 -0500:

Show 11 quoted lines

> +== Integrating a command ==
> +
> +Here are the things you need to do when you want to merge a new 
> +subcommand into the git tree.
> +
> +1. Append your command name to one of the variables BUILTIN_OBJS,
> +EXTRA_PROGRAMS, SCRIPT_SH, SCRIPT_PERL or SCRIPT_PYTHON.
> +
> +2. Drop its test in the t directory.
> +
> +That's all there is to it.

Nice start. A few other details; I recently did this for git-p4 (python).

.gitignore: ignore the auto-generated script, e.g. when git-foo.py is built into git-foo.

INSTALL: note language requirements if odd (see python section)

command-list.txt: categorization of commands for git(1) etc.

RelNotes: Junio generally does this.

Also please read Documentation/technical/api-builtin.txt to see how to add a built-in command. It also has comments that are identical for both built-in and stand-alone command. Could be that your text would better go near or with that one, as perhaps api-command.txt.

		-- Pete