name-rev: replace --stdin with --annotate-stdin in synopsis

Commit Message

John Cai Feb. 15, 2022, 8:52 p.m. UTC

From: John Cai <[e-mail]>

d9976b184596 added --annotate-stdin to replace --stdin as a clearer flag
name. Since --stdin is to be deprecated, we should replace --stdin in
the synopsis.

Signed-off-by: John Cai <[e-mail]>
---
    name-rev: replace --stdin with --annotate-stdin in synopsis
    
    There was an oversight when we added --annotate-stdin to
    git-name-rev(1). This patch corrects it by making the appropriate change
    in the synopsis of git-name-rev(1)

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1216%2Fjohn-cai%2Fjc-update-name-rev-synopsis-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1216/john-cai/jc-update-name-rev-synopsis-v1
Pull-Request: https://github.com/git/git/pull/1216

 builtin/name-rev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: b80121027d1247a0754b3cc46897fee75c050b44

Comments

Junio C Hamano Feb. 16, 2022, 1:40 a.m. UTC | #1

"John Cai via GitGitGadget" <[e-mail]> writes:

> From: John Cai <[e-mail]>
>
> d9976b184596 added --annotate-stdin to replace --stdin as a clearer flag
> name. Since --stdin is to be deprecated, we should replace --stdin in
> the synopsis.

Thanks for a careful reading.  d9976b184596 was what merged the
whole series; let's blame the particular step instead.

Here is what I'll queue.

----- >8 --------- >8 --------- >8 --------- >8 --------- >8 -----
From: John Cai <[e-mail]>
Date: Tue, 15 Feb 2022 20:52:07 +0000
Subject: [PATCH] name-rev: replace --stdin with --annotate-stdin in synopsis

34ae3b70 (name-rev: deprecate --stdin in favor of --annotate-stdin,
2022-01-05) added --annotate-stdin to replace --stdin as a clearer
flag name. Since --stdin is to be deprecated, we should replace
--stdin in the output from "git name-rev -h".

Signed-off-by: John Cai <[e-mail]>
Signed-off-by: Junio C Hamano <[e-mail]>
---
 builtin/name-rev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/builtin/name-rev.c b/builtin/name-rev.c
index 138e3c30a2..929591269d 100644
--- a/builtin/name-rev.c
+++ b/builtin/name-rev.c
@@ -473,7 +473,7 @@ static void show_name(const struct object *obj,
 static char const * const name_rev_usage[] = {
 	N_("git name-rev [<options>] <commit>..."),
 	N_("git name-rev [<options>] --all"),
-	N_("git name-rev [<options>] --stdin"),
+	N_("git name-rev [<options>] --annotate-stdin"),
 	NULL
 };

Patch

diff --git a/builtin/name-rev.c b/builtin/name-rev.c
index 138e3c30a2b..929591269dd 100644
--- a/builtin/name-rev.c
+++ b/builtin/name-rev.c
@@ -473,7 +473,7 @@  static void show_name(const struct object *obj,
 static char const * const name_rev_usage[] = {
 	N_("git name-rev [<options>] <commit>..."),
 	N_("git name-rev [<options>] --all"),
-	N_("git name-rev [<options>] --stdin"),
+	N_("git name-rev [<options>] --annotate-stdin"),
 	NULL
 };