From: Eric Sunshine <sunshine@sunshineco.com>
To: Philip Oakley <philipoakley@iee.email>
Cc: John Cai via GitGitGadget <gitgitgadget@gmail.com>,
Git List <git@vger.kernel.org>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
John Cai <johncai86@gmail.com>
Subject: Re: [PATCH v3 1/2] name-rev: deprecate --stdin in favor of --annotate-text
Date: Tue, 4 Jan 2022 14:38:46 -0500 [thread overview]
Message-ID: <CAPig+cRUQA_G_sLi4Q_F4ZhHkhEFKT-an4LuOpbTJ9bDuZLjog@mail.gmail.com> (raw)
In-Reply-To: <77e18a78-ddfe-0337-deaf-bb9dfb63a495@iee.email>
On Tue, Jan 4, 2022 at 10:32 AM Philip Oakley <philipoakley@iee.email> wrote:
> On 03/01/2022 14:47, John Cai via GitGitGadget wrote:
> > From: John Cai <johncai86@gmail.com>
> > --stdin::
> > + This option is deprecated in favor of 'git name-rev --annotate-stdin'.
> > + They are functionally equivalent.
> > +
> > +--annotate-stdin::
> > Transform stdin by substituting all the 40-character SHA-1
> > hexes (say $hex) with "$hex ($rev_name)". When used with
> > --name-only, substitute with "$rev_name", omitting $hex
> > - altogether. Intended for the scripter's use.
> > + altogether.
>
> Is there a preferred order for the old/new variant documentation?
>
> It struck me that the docs should offer the new (now 'correct') variant
> first.
>
> I didn't see anything about deprecation in the CodingGuidlines or
> SubmittingPatches (only a quick search though)
In other cases, we've demoted the deprecated option to a tiny blurb at
the end of the description of the option which replaces it so that the
deprecated option is no longer given a place of prominence but can
still be found with a search in case someone runs across it somewhere
and wants to learn about it.
--annotate-stdin::
Transform stdin by substituting all the 40-character SHA-1
hexes (say $hex) with "$hex ($rev_name)". When used with
--name-only, substitute with "$rev_name", omitting $hex
altogether. --stdin is a deprecated synonym.
next prev parent reply other threads:[~2022-01-04 19:38 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-26 4:28 [PATCH] name-rev: deprecate --stdin in favor of --annotate-text John Cai via GitGitGadget
2021-12-27 19:49 ` Junio C Hamano
2021-12-28 5:13 ` John Cai
2021-12-31 8:16 ` Junio C Hamano
2022-01-01 22:59 ` Johannes Schindelin
2021-12-29 6:23 ` [PATCH v2 0/2] name-rev: deprecate --stdin in favor of --anotate-text John Cai via GitGitGadget
2021-12-29 6:23 ` [PATCH v2 1/2] name-rev: deprecate --stdin in favor of --annotate-text John Cai via GitGitGadget
2021-12-30 22:36 ` Junio C Hamano
2021-12-29 6:23 ` [PATCH v2 2/2] name-rev.c: use strbuf_getline instead of limited size buffer John Cai via GitGitGadget
2022-01-03 14:47 ` [PATCH v3 0/2] name-rev: deprecate --stdin in favor of --annotate-stdin John Cai via GitGitGadget
2022-01-03 14:47 ` [PATCH v3 1/2] name-rev: deprecate --stdin in favor of --annotate-text John Cai via GitGitGadget
2022-01-04 2:36 ` Junio C Hamano
2022-01-04 3:16 ` Junio C Hamano
2022-01-04 13:25 ` Philip Oakley
2022-01-04 19:00 ` Junio C Hamano
2022-01-04 19:38 ` Eric Sunshine [this message]
2022-01-03 14:47 ` [PATCH v3 2/2] name-rev.c: use strbuf_getline instead of limited size buffer John Cai via GitGitGadget
2022-01-04 2:16 ` Junio C Hamano
2022-01-04 14:49 ` [PATCH v4 0/2] name-rev: deprecate --stdin in favor of --annotate-stdin John Cai via GitGitGadget
2022-01-04 14:49 ` [PATCH v4 1/2] " John Cai via GitGitGadget
2022-01-04 22:12 ` Junio C Hamano
2022-01-05 11:15 ` Phillip Wood
2022-01-05 19:47 ` Junio C Hamano
2022-01-05 19:52 ` Junio C Hamano
2022-01-04 14:49 ` [PATCH v4 2/2] name-rev.c: use strbuf_getline instead of limited size buffer John Cai via GitGitGadget
2022-01-04 14:54 ` John Cai
2022-01-05 4:20 ` [PATCH v5 0/2] name-rev: deprecate --stdin in favor of --annotate-stdin John Cai via GitGitGadget
2022-01-05 4:20 ` [PATCH v5 1/2] " John Cai via GitGitGadget
2022-01-05 20:07 ` Junio C Hamano
2022-01-05 4:20 ` [PATCH v5 2/2] name-rev.c: use strbuf_getline instead of limited size buffer John Cai via GitGitGadget
2022-01-05 22:59 ` [PATCH v6 0/2] name-rev: deprecate --stdin in favor of --annotate-stdin John Cai via GitGitGadget
2022-01-05 22:59 ` [PATCH v6 1/2] " John Cai via GitGitGadget
2022-01-05 23:00 ` [PATCH v6 2/2] name-rev.c: use strbuf_getline instead of limited size buffer John Cai via GitGitGadget
2022-01-05 23:12 ` [PATCH v6 0/2] name-rev: deprecate --stdin in favor of --annotate-stdin Junio C Hamano
2022-01-05 23:29 ` [PATCH v7 " John Cai via GitGitGadget
2022-01-05 23:29 ` [PATCH v7 1/2] " John Cai via GitGitGadget
2022-01-08 13:47 ` John Cai
2022-01-10 17:38 ` Junio C Hamano
2022-01-10 19:01 ` John Cai
2022-01-10 19:11 ` Junio C Hamano
2022-01-11 11:01 ` Phillip Wood
2022-01-05 23:29 ` [PATCH v7 2/2] name-rev.c: use strbuf_getline instead of limited size buffer John Cai via GitGitGadget
2022-01-18 16:09 ` Ævar Arnfjörð Bjarmason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAPig+cRUQA_G_sLi4Q_F4ZhHkhEFKT-an4LuOpbTJ9bDuZLjog@mail.gmail.com \
--to=sunshine@sunshineco.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=johncai86@gmail.com \
--cc=philipoakley@iee.email \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.