Re: [PATCH] name-rev: deprecate --stdin in favor of --annotate-text

From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: Jan 1, 2022, 22:59 UTC
Message-ID: <nycvar.QRO.7.76.6.2201012357040.7076@tvgsbejvaqbjf.bet>
In-Reply-To: <xmqqpmphx1yh.fsf@gitster.g>

Hi Junio,

On Mon, 27 Dec 2021, Junio C Hamano wrote:

> "John Cai via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
> As name-rev is Dscho's brainchild, I think it is benefitial to ask input
> from him, so I added an address to the CC: list.

Thank you!

Show 17 quoted lines

> > From: John Cai <johncai86@gmail.com>
> >
> > Introduce a --annotate-text that is functionally equivalent of --stdin.
> > --stdin does not behave as --stdin in other subcommands, such as
> > pack-objects whereby it takes one argument per line. Since --stdin can
> > be a confusing and misleading name, rename it to --annotate-text.
> >
> > This change adds a warning to --stdin warning that it will be removed in
> > the future.
>
> I know I've suggested the name, but 'text' in --annotate-text is a
> low value word in an option name where every byte is precious.
> "Annotate" is very good to convey what is done to the object of the
> verb, but "text" stresses the wrong thing (we do not annotate
> binary,o we annotate text) without saying where the text comes from
> (i.e.  standard input).  Perhaps "--annotate-stdin" would be a much
> better name.

I agree that `--annotate-stdin` is better, especially since people who might look for a replacement for `--stdin` in the documentation are much more likely to find what they're looking for.

In addition to this, I also agree with Junio on the deprecation needing to be done carefully.

Ciao, Dscho