Re: [PATCH] Improve documentation for git-sh-setup.
On Thu, Feb 21, 2008 at 11:01:28PM +0000, Yann Dirson wrote:
> Signed-off-by: Yann Dirson <ydirson@altern.org>
> Cc: Pierre Habouzit <madcoder@debian.org>
> +If the constraints imposed by the use of `git rev-parse` do not fit
> +for a particular tool, `USAGE` (and `LONG_USAGE`, if any) can be used
> +to define message given by `usage()` shell function; no command-line
> +pre-processing occurs, the script has entire control over it.
Actually, new scripts should be written using git rev-parse if
possible, the USAGE/LONG_USAGE were there _before_ and I'd like to call
them the deprecated interface if other git hackers don't mind.
git rev-parse --parseopt gives consistency in how git parses options,
and it's A Good Thing™
That makes me think that git-sh-setup(1) use should be documented in
gitcli(5), maybe even included, and git-sh-setup(1) should *definitely*
link to gitcli(5). We wondered where to link gitcli from, this is
definitely the place !
--
·O· Pierre Habouzit
··O madcoder@debian.org
OOO http://www.madism.org
Pierre Habouzit <madcoder@debian.org>