Re: [Alt. PATCH] ls-remote: deprecate -h as short for --heads

From: Jeff King <peff@peff.net>
Date: Oct 19, 2017, 20:32 UTC
Message-ID: <20171019203249.76uu3b6ferquitcr@sigill.intra.peff.net>
In-Reply-To: <26112a15-f02c-a910-c8bb-794ca84dc1e5@web.de>

On Thu, Oct 19, 2017 at 08:26:47PM +0200, René Scharfe wrote:

Show 11 quoted lines

> diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
> index 5f2628c8f8..82622e7fbc 100644
> --- a/Documentation/git-ls-remote.txt
> +++ b/Documentation/git-ls-remote.txt
> @@ -29,6 +29,9 @@ OPTIONS
>  	These options are _not_ mutually exclusive; when given
>  	both, references stored in refs/heads and refs/tags are
>  	displayed.
> ++
> +*NOTE*: -h without any other parameters shows a short help text instead
> +of any refs.

Yuck. This "we only treat -h as special in certain cases" rule is sufficiently magical that I don't think we want to advertise and lock ourselves into it.

-Peff