Documentation/git-name-rev.txt

   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.
  29
  30 --all::
  31         List all commits reachable from all refs
  32
  33 --stdin::
  34         Transform stdin by substituting all the 40-character SHA-1
  35         hexes (say $hex) with "$hex ($rev_name)".  When used with
  36         --name-only, substitute with "$rev_name", omitting $hex
  37         altogether.  Intended for the scripter's use.
  38
  39 --name-only::
  40         Instead of printing both the SHA-1 and the name, print only
  41         the name.  If given with --tags the usual tag prefix of
  42         "tags/" is also omitted from the name, matching the output
  43         of `git-describe` more closely.
  44
  45 --no-undefined::
  46         Die with error code != 0 when a reference is undefined,
  47         instead of printing `undefined`.
  48
  49 --always::
  50         Show uniquely abbreviated commit object as fallback.
  51
  52 EXAMPLE
  53 -------
  54
  55 Given a commit, find out where it is relative to the local refs. Say somebody
  56 wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
  57 Of course, you look into the commit, but that only tells you what happened, but
  58 not the context.
  59
  60 Enter 'git name-rev':
  61
  62 ------------
  63 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
  64 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99~940
  65 ------------
  66
  67 Now you are wiser, because you know that it happened 940 revisions before v0.99.
  68
  69 Another nice thing you can do is:
  70
  71 ------------
  72 % git log | git name-rev --stdin
  73 ------------
  74
  75 GIT
  76 ---
  77 Part of the linkgit:git[1] suite