[thirdparty/git.git] / Documentation / git-name-rev.txt

git-name-rev(1)
===============

NAME
----
git-name-rev - Find symbolic names for given revs


SYNOPSIS
--------
[verse]
'git name-rev' [--tags] [--refs=<pattern>]
	       ( --all | --stdin | <committish>... )

DESCRIPTION
-----------
Finds symbolic names suitable for human digestion for revisions given in any
format parsable by 'git rev-parse'.


OPTIONS
-------

--tags::
	Do not use branch names, but only tags to name the commits

--refs=<pattern>::
	Only use refs whose names match a given shell pattern.  The pattern
	can be one of branch name, tag name or fully qualified ref name.

--all::
	List all commits reachable from all refs

--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.

--name-only::
	Instead of printing both the SHA-1 and the name, print only
	the name.  If given with --tags the usual tag prefix of
	"tags/" is also omitted from the name, matching the output
	of `git-describe` more closely.

--no-undefined::
	Die with error code != 0 when a reference is undefined,
	instead of printing `undefined`.

--always::
	Show uniquely abbreviated commit object as fallback.

EXAMPLE
-------

Given a commit, find out where it is relative to the local refs. Say somebody
wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
Of course, you look into the commit, but that only tells you what happened, but
not the context.

Enter 'git name-rev':

------------
% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99~940
------------

Now you are wiser, because you know that it happened 940 revisions before v0.99.

Another nice thing you can do is:

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

GIT
---
Part of the linkgit:git[1] suite
Commit	Line	Data
	1	git-name-rev(1)
	2	===============
	3
	4	NAME
	5	----
	6	git-name-rev - Find symbolic names for given revs
	7
	8
	9	SYNOPSIS
	10	--------
	11	[verse]
	12	'git name-rev' [--tags] [--refs=<pattern>]
	13	( --all \| --stdin \| <committish>... )
	14
	15	DESCRIPTION
	16	-----------
	17	Finds symbolic names suitable for human digestion for revisions given in any
	18	format parsable by 'git rev-parse'.
	19
	20
	21	OPTIONS
	22	-------
	23
	24	--tags::
	25	Do not use branch names, but only tags to name the commits
	26
	27	--refs=<pattern>::
	28	Only use refs whose names match a given shell pattern. The pattern
	29	can be one of branch name, tag name or fully qualified ref name.
	30
	31	--all::
	32	List all commits reachable from all refs
	33
	34	--stdin::
	35	Transform stdin by substituting all the 40-character SHA-1
	36	hexes (say $hex) with "$hex ($rev_name)". When used with
	37	--name-only, substitute with "$rev_name", omitting $hex
	38	altogether. Intended for the scripter's use.
	39
	40	--name-only::
	41	Instead of printing both the SHA-1 and the name, print only
	42	the name. If given with --tags the usual tag prefix of
	43	"tags/" is also omitted from the name, matching the output
	44	of `git-describe` more closely.
	45
	46	--no-undefined::
	47	Die with error code != 0 when a reference is undefined,
	48	instead of printing `undefined`.
	49
	50	--always::
	51	Show uniquely abbreviated commit object as fallback.
	52
	53	EXAMPLE
	54	-------
	55
	56	Given a commit, find out where it is relative to the local refs. Say somebody
	57	wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
	58	Of course, you look into the commit, but that only tells you what happened, but
	59	not the context.
	60
	61	Enter 'git name-rev':
	62
	63	------------
	64	% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
	65	33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99~940
	66	------------
	67
	68	Now you are wiser, because you know that it happened 940 revisions before v0.99.
	69
	70	Another nice thing you can do is:
	71
	72	------------
	73	% git log \| git name-rev --stdin
	74	------------
	75
	76	GIT
	77	---
	78	Part of the linkgit:git[1] suite