man1/git-name-rev.1

   1 '\" t
   2 .\"     Title: git-name-rev
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-01
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.46.g406f326d27
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-NAME\-REV" "1" "2024-08-01" "Git 2\&.46\&.0\&.46\&.g406f326" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-name-rev \- Find symbolic names for given revs
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit name\-rev\fR [\-\-tags] [\-\-refs=<pattern>]
  36                ( \-\-all | \-\-annotate\-stdin | <commit\-ish>\&...\: )
  37 .fi
  38 .SH "DESCRIPTION"
  39 .sp
  40 Finds symbolic names suitable for human digestion for revisions given in any format parsable by \fIgit rev\-parse\fR\&.
  41 .SH "OPTIONS"
  42 .PP
  43 \-\-tags
  44 .RS 4
  45 Do not use branch names, but only tags to name the commits
  46 .RE
  47 .PP
  48 \-\-refs=<pattern>
  49 .RS 4
  50 Only use refs whose names match a given shell pattern\&. The pattern can be a branch name, a tag name, or a fully qualified ref name\&. If given multiple times, use refs whose names match any of the given shell patterns\&. Use
  51 \fB\-\-no\-refs\fR
  52 to clear any previous ref patterns given\&.
  53 .RE
  54 .PP
  55 \-\-exclude=<pattern>
  56 .RS 4
  57 Do not use any ref whose name matches a given shell pattern\&. The pattern can be one of branch name, tag name or fully qualified ref name\&. If given multiple times, a ref will be excluded when it matches any of the given patterns\&. When used together with \-\-refs, a ref will be used as a match only when it matches at least one \-\-refs pattern and does not match any \-\-exclude patterns\&. Use
  58 \fB\-\-no\-exclude\fR
  59 to clear the list of exclude patterns\&.
  60 .RE
  61 .PP
  62 \-\-all
  63 .RS 4
  64 List all commits reachable from all refs
  65 .RE
  66 .PP
  67 \-\-annotate\-stdin
  68 .RS 4
  69 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\&. This option was called
  70 \fB\-\-stdin\fR
  71 in older versions of Git\&.
  72 .sp
  73 For example:
  74 .sp
  75 .if n \{\
  76 .RS 4
  77 .\}
  78 .nf
  79 $ cat sample\&.txt
  80
  81 An abbreviated revision 2ae0a9cb82 will not be substituted\&.
  82 The full name after substitution is 2ae0a9cb8298185a94e5998086f380a355dd8907,
  83 while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad
  84
  85 $ git name\-rev \-\-annotate\-stdin <sample\&.txt
  86
  87 An abbreviated revision 2ae0a9cb82 will not be substituted\&.
  88 The full name after substitution is 2ae0a9cb8298185a94e5998086f380a355dd8907 (master),
  89 while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad
  90
  91 $ git name\-rev \-\-name\-only \-\-annotate\-stdin <sample\&.txt
  92
  93 An abbreviated revision 2ae0a9cb82 will not be substituted\&.
  94 The full name after substitution is master,
  95 while its tree object is 70d105cc79e63b81cfdcb08a15297c23e60b07ad
  96 .fi
  97 .if n \{\
  98 .RE
  99 .\}
 100 .RE
 101 .PP
 102 \-\-name\-only
 103 .RS 4
 104 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
 105 \fBgit\-describe\fR
 106 more closely\&.
 107 .RE
 108 .PP
 109 \-\-no\-undefined
 110 .RS 4
 111 Die with error code != 0 when a reference is undefined, instead of printing
 112 \fBundefined\fR\&.
 113 .RE
 114 .PP
 115 \-\-always
 116 .RS 4
 117 Show uniquely abbreviated commit object as fallback\&.
 118 .RE
 119 .SH "EXAMPLES"
 120 .sp
 121 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\&.
 122 .sp
 123 Enter \fIgit name\-rev\fR:
 124 .sp
 125 .if n \{\
 126 .RS 4
 127 .\}
 128 .nf
 129 % git name\-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
 130 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0\&.99~940
 131 .fi
 132 .if n \{\
 133 .RE
 134 .\}
 135 .sp
 136 Now you are wiser, because you know that it happened 940 revisions before v0\&.99\&.
 137 .sp
 138 Another nice thing you can do is:
 139 .sp
 140 .if n \{\
 141 .RS 4
 142 .\}
 143 .nf
 144 % git log | git name\-rev \-\-annotate\-stdin
 145 .fi
 146 .if n \{\
 147 .RE
 148 .\}
 149 .SH "GIT"
 150 .sp
 151 Part of the \fBgit\fR(1) suite