kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

name-rev: make --stdin hidden 

In 34ae3b70 (name-rev: deprecate --stdin in favor of --annotate-stdin),
we renamed --stdin to --annotate-stdin for the sake of a clearer name
for the option, and added text that indicates --stdin is deprecated. The
next step is to hide --stdin completely.

Make the option hidden. Also, update documentation to remove all
mentions of --stdin.

Signed-off-by: "John Cai" <johncai86@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
John Cai 2023-05-06 04:14:11 +00:00 committed by Junio C Hamano
parent 69c786637d
commit 9019d7dceb
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/git-name-rev.txt
View File

@ -10,7 +10,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git name-rev' [--tags] [--refs=<pattern>] 'git name-rev' [--tags] [--refs=<pattern>]
( --all | --stdin | <commit-ish>... ) ( --all | --annotate-stdin | <commit-ish>... )


DESCRIPTION DESCRIPTION
----------- -----------
@ -46,7 +46,8 @@ OPTIONS
Transform stdin by substituting all the 40-character SHA-1 Transform stdin by substituting all the 40-character SHA-1
hexes (say $hex) with "$hex ($rev_name)". When used with hexes (say $hex) with "$hex ($rev_name)". When used with
--name-only, substitute with "$rev_name", omitting $hex --name-only, substitute with "$rev_name", omitting $hex
altogether. altogether. This option was called `--stdin` in older versions
of Git.
+ +
For example: For example:
+ +
@ -70,10 +71,6 @@ The full name after substitution is master,
while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad
----------- -----------


--stdin::
This option is deprecated in favor of 'git name-rev --annotate-stdin'.
They are functionally equivalent.

--name-only:: --name-only::
Instead of printing both the SHA-1 and the name, print only Instead of printing both the SHA-1 and the name, print only
the name. If given with --tags the usual tag prefix of the name. If given with --tags the usual tag prefix of
@ -107,7 +104,7 @@ Now you are wiser, because you know that it happened 940 revisions before v0.99.
Another nice thing you can do is: Another nice thing you can do is:


------------ ------------
% git log | git name-rev --stdin % git log | git name-rev --annotate-stdin
------------ ------------


GIT GIT

6
builtin/name-rev.c
View File

@ -573,7 +573,11 @@ int cmd_name_rev(int argc, const char **argv, const char *prefix)
N_("ignore refs matching <pattern>")), N_("ignore refs matching <pattern>")),
OPT_GROUP(""), OPT_GROUP(""),
OPT_BOOL(0, "all", &all, N_("list all commits reachable from all refs")), OPT_BOOL(0, "all", &all, N_("list all commits reachable from all refs")),
OPT_BOOL(0, "stdin", &transform_stdin, N_("deprecated: use --annotate-stdin instead")), OPT_BOOL_F(0,
"stdin",
&transform_stdin,
N_("deprecated: use --annotate-stdin instead"),
PARSE_OPT_HIDDEN),
OPT_BOOL(0, "annotate-stdin", &annotate_stdin, N_("annotate text 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, "undefined", &allow_undefined, N_("allow to print `undefined` names (default)")),
OPT_BOOL(0, "always", &always, OPT_BOOL(0, "always", &always,