From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS53758 23.128.96.0/24 X-Spam-Status: No, score=-5.6 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,NICE_REPLY_A, SPF_HELO_PASS,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by dcvr.yhbt.net (Postfix) with ESMTP id 344271F953 for ; Tue, 4 Jan 2022 13:25:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233452AbiADNZQ (ORCPT ); Tue, 4 Jan 2022 08:25:16 -0500 Received: from smtp.hosts.co.uk ([85.233.160.19]:44147 "EHLO smtp.hosts.co.uk" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232029AbiADNZP (ORCPT ); Tue, 4 Jan 2022 08:25:15 -0500 Received: from host-92-7-140-211.as13285.net ([92.7.140.211] helo=[192.168.1.37]) by smtp.hosts.co.uk with esmtpa (Exim) (envelope-from ) id 1n4joP-0009XT-5u; Tue, 04 Jan 2022 13:25:14 +0000 Message-ID: <77e18a78-ddfe-0337-deaf-bb9dfb63a495@iee.email> Date: Tue, 4 Jan 2022 13:25:12 +0000 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.4.1 Subject: Re: [PATCH v3 1/2] name-rev: deprecate --stdin in favor of --annotate-text Content-Language: en-GB To: John Cai via GitGitGadget , git@vger.kernel.org Cc: Johannes Schindelin , John Cai References: <55ec2a5fa3e748b7e5f9ef871214563ba2b28adf.1641221261.git.gitgitgadget@gmail.com> From: Philip Oakley In-Reply-To: <55ec2a5fa3e748b7e5f9ef871214563ba2b28adf.1641221261.git.gitgitgadget@gmail.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org On 03/01/2022 14:47, John Cai via GitGitGadget wrote: > From: John Cai > > 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. > > Signed-off-by: "John Cai" > --- > Documentation/git-name-rev.txt | 29 +++++++++++++++++++++++++++- > builtin/name-rev.c | 19 +++++++++++++----- > t/t3412-rebase-root.sh | 2 +- > t/t4202-log.sh | 2 +- > t/t6007-rev-list-cherry-pick-file.sh | 26 ++++++++++++------------- > t/t6012-rev-list-simplify.sh | 2 +- > t/t6111-rev-list-treesame.sh | 3 ++- > t/t6120-describe.sh | 9 +++++++-- > 8 files changed, 67 insertions(+), 25 deletions(-) > > diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt > index 5cb0eb0855f..ee11b2ca9e7 100644 > --- a/Documentation/git-name-rev.txt > +++ b/Documentation/git-name-rev.txt > @@ -43,10 +43,37 @@ OPTIONS > List all commits reachable from all refs > > --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) -- Philip > + > + For example: > ++ > +---------- > +$ cat sample.txt > + > +An abbreviated revision 2ae0a9cb82 will not be substituted. > +The full name after substitution is 2ae0a9cb8298185a94e5998086f380a355dd8907, > +while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad > + > +$ git name-rev --annotate-stdin + > +An abbreviated revision 2ae0a9cb82 will not be substituted. > +The full name after substitution is 2ae0a9cb8298185a94e5998086f380a355dd8907 > +(master), > +while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad > + > +$ git name-rev --name-only --annotate-stdin + > +An abbreviated revision 2ae0a9cb82 will not be substituted. > +The full name is master, > +while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad > +---------- > > --name-only:: > Instead of printing both the SHA-1 and the name, print only > diff --git a/builtin/name-rev.c b/builtin/name-rev.c > index 27f60153a6c..21370afdaf9 100644 > --- a/builtin/name-rev.c > +++ b/builtin/name-rev.c > @@ -527,7 +527,7 @@ static void name_rev_line(char *p, struct name_ref_data *data) > int cmd_name_rev(int argc, const char **argv, const char *prefix) > { > struct object_array revs = OBJECT_ARRAY_INIT; > - int all = 0, transform_stdin = 0, allow_undefined = 1, always = 0, peel_tag = 0; > + int all = 0, annotate_stdin = 0, transform_stdin = 0, allow_undefined = 1, always = 0, peel_tag = 0; > struct name_ref_data data = { 0, 0, STRING_LIST_INIT_NODUP, STRING_LIST_INIT_NODUP }; > struct option opts[] = { > OPT_BOOL(0, "name-only", &data.name_only, N_("print only ref-based names (no object names)")), > @@ -539,6 +539,7 @@ int cmd_name_rev(int argc, const char **argv, const char *prefix) > OPT_GROUP(""), > OPT_BOOL(0, "all", &all, N_("list all commits reachable from all refs")), > OPT_BOOL(0, "stdin", &transform_stdin, N_("read from stdin")), > + OPT_BOOL(0, "annotate-stdin", &annotate_stdin, N_("annotate text from stdin")), > OPT_BOOL(0, "undefined", &allow_undefined, N_("allow to print `undefined` names (default)")), > OPT_BOOL(0, "always", &always, > N_("show abbreviated commit object as fallback")), > @@ -554,11 +555,19 @@ int cmd_name_rev(int argc, const char **argv, const char *prefix) > init_commit_rev_name(&rev_names); > git_config(git_default_config, NULL); > argc = parse_options(argc, argv, prefix, opts, name_rev_usage, 0); > - if (all + transform_stdin + !!argc > 1) { > + > + if (transform_stdin) { > + warning("--stdin is deprecated. Please use --annotate-stdin instead, " > + "which is functionally equivalent.\n" > + "This option will be removed in a future release."); > + annotate_stdin = 1; > + } > + > + if (all + annotate_stdin + !!argc > 1) { > error("Specify either a list, or --all, not both!"); > usage_with_options(name_rev_usage, opts); > } > - if (all || transform_stdin) > + if (all || annotate_stdin) > cutoff = 0; > > for (; argc; argc--, argv++) { > @@ -613,8 +622,8 @@ int cmd_name_rev(int argc, const char **argv, const char *prefix) > for_each_ref(name_ref, &data); > name_tips(); > > - if (transform_stdin) { > - char buffer[2048]; > + if (annotate_stdin) { > + struct strbuf sb = STRBUF_INIT; > > while (!feof(stdin)) { > char *p = fgets(buffer, sizeof(buffer), stdin); > diff --git a/t/t3412-rebase-root.sh b/t/t3412-rebase-root.sh > index 19c6f4acbf6..1e9f7833dd6 100755 > --- a/t/t3412-rebase-root.sh > +++ b/t/t3412-rebase-root.sh > @@ -11,7 +11,7 @@ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME > > log_with_names () { > git rev-list --topo-order --parents --pretty="tformat:%s" HEAD | > - git name-rev --stdin --name-only --refs=refs/heads/$1 > + git name-rev --annotate-stdin --name-only --refs=refs/heads/$1 > } > > > diff --git a/t/t4202-log.sh b/t/t4202-log.sh > index 50495598619..dc884107de4 100755 > --- a/t/t4202-log.sh > +++ b/t/t4202-log.sh > @@ -659,7 +659,7 @@ EOF > > test_expect_success 'log --graph with full output' ' > git log --graph --date-order --pretty=short | > - git name-rev --name-only --stdin | > + git name-rev --name-only --annotate-stdin | > sed "s/Merge:.*/Merge: A B/;s/ *\$//" >actual && > test_cmp expect actual > ' > diff --git a/t/t6007-rev-list-cherry-pick-file.sh b/t/t6007-rev-list-cherry-pick-file.sh > index aebe4b69e13..6f3e5439771 100755 > --- a/t/t6007-rev-list-cherry-pick-file.sh > +++ b/t/t6007-rev-list-cherry-pick-file.sh > @@ -58,7 +58,7 @@ EOF > > test_expect_success '--left-right' ' > git rev-list --left-right B...C > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > @@ -78,14 +78,14 @@ EOF > > test_expect_success '--cherry-pick bar does not come up empty' ' > git rev-list --left-right --cherry-pick B...C -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > > test_expect_success 'bar does not come up empty' ' > git rev-list --left-right B...C -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > @@ -97,14 +97,14 @@ EOF > > test_expect_success '--cherry-pick bar does not come up empty (II)' ' > git rev-list --left-right --cherry-pick F...E -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > > test_expect_success 'name-rev multiple --refs combine inclusive' ' > git rev-list --left-right --cherry-pick F...E -- bar >actual && > - git name-rev --stdin --name-only --refs="*tags/F" --refs="*tags/E" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/F" --refs="*tags/E" \ > actual.named && > test_cmp expect actual.named > ' > @@ -116,7 +116,7 @@ EOF > test_expect_success 'name-rev --refs excludes non-matched patterns' ' > git rev-list --left-right --right-only --cherry-pick F...E -- bar >>expect && > git rev-list --left-right --cherry-pick F...E -- bar >actual && > - git name-rev --stdin --name-only --refs="*tags/F" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/F" \ > actual.named && > test_cmp expect actual.named > ' > @@ -128,14 +128,14 @@ EOF > test_expect_success 'name-rev --exclude excludes matched patterns' ' > git rev-list --left-right --right-only --cherry-pick F...E -- bar >>expect && > git rev-list --left-right --cherry-pick F...E -- bar >actual && > - git name-rev --stdin --name-only --refs="*tags/*" --exclude="*E" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" --exclude="*E" \ > actual.named && > test_cmp expect actual.named > ' > > test_expect_success 'name-rev --no-refs clears the refs list' ' > git rev-list --left-right --cherry-pick F...E -- bar >expect && > - git name-rev --stdin --name-only --refs="*tags/F" --refs="*tags/E" --no-refs --refs="*tags/G" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/F" --refs="*tags/E" --no-refs --refs="*tags/G" \ > actual && > test_cmp expect actual > ' > @@ -149,7 +149,7 @@ EOF > > test_expect_success '--cherry-mark' ' > git rev-list --cherry-mark F...E -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > @@ -163,7 +163,7 @@ EOF > > test_expect_success '--cherry-mark --left-right' ' > git rev-list --cherry-mark --left-right F...E -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > @@ -174,14 +174,14 @@ EOF > > test_expect_success '--cherry-pick --right-only' ' > git rev-list --cherry-pick --right-only F...E -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > > test_expect_success '--cherry-pick --left-only' ' > git rev-list --cherry-pick --left-only E...F -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > @@ -193,7 +193,7 @@ EOF > > test_expect_success '--cherry' ' > git rev-list --cherry F...E -- bar > actual && > - git name-rev --stdin --name-only --refs="*tags/*" \ > + git name-rev --annotate-stdin --name-only --refs="*tags/*" \ > < actual > actual.named && > test_cmp expect actual.named > ' > diff --git a/t/t6012-rev-list-simplify.sh b/t/t6012-rev-list-simplify.sh > index 4f7fa8b6c03..4fedc614fa6 100755 > --- a/t/t6012-rev-list-simplify.sh > +++ b/t/t6012-rev-list-simplify.sh > @@ -12,7 +12,7 @@ note () { > } > > unnote () { > - git name-rev --tags --stdin | sed -e "s|$OID_REGEX (tags/\([^)]*\)) |\1 |g" > + git name-rev --tags --annotate-stdin | sed -e "s|$OID_REGEX (tags/\([^)]*\)) |\1 |g" > } > > # > diff --git a/t/t6111-rev-list-treesame.sh b/t/t6111-rev-list-treesame.sh > index e07b6070e0e..90ff1416400 100755 > --- a/t/t6111-rev-list-treesame.sh > +++ b/t/t6111-rev-list-treesame.sh > @@ -23,7 +23,8 @@ note () { > } > > unnote () { > - git name-rev --tags --stdin | sed -e "s|$OID_REGEX (tags/\([^)]*\))\([ ]\)|\1\2|g" > + git name-rev --tags --annotate-stdin | \ > + sed -e "s|$OID_REGEX (tags/\([^)]*\))\([ ]\)|\1\2|g" > } > > test_expect_success setup ' > diff --git a/t/t6120-describe.sh b/t/t6120-describe.sh > index d8af2bb9d2b..9781b92aedd 100755 > --- a/t/t6120-describe.sh > +++ b/t/t6120-describe.sh > @@ -270,7 +270,7 @@ test_expect_success 'name-rev --all' ' > test_cmp expect actual > ' > > -test_expect_success 'name-rev --stdin' ' > +test_expect_success 'name-rev --annotate-stdin' ' > >expect.unsorted && > for rev in $(git rev-list --all) > do > @@ -278,11 +278,16 @@ test_expect_success 'name-rev --stdin' ' > echo "$rev ($name)" >>expect.unsorted || return 1 > done && > sort expect && > - git rev-list --all | git name-rev --stdin >actual.unsorted && > + git rev-list --all | git name-rev --annotate-stdin >actual.unsorted && > sort actual && > test_cmp expect actual > ' > > +test_expect_success 'name-rev --stdin deprecated' " > + git rev-list --all | git name-rev --stdin 2>actual && > + grep -E 'warning: --stdin is deprecated' actual > +" > + > test_expect_success 'describe --contains with the exact tags' ' > echo "A^0" >expect && > tag_object=$(git rev-parse refs/tags/A) &&