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         Read from stdin, append "(<rev_name>)" to all sha1's of nameable
  35         commits, and pass to stdout
  36
  37 --name-only::
  38         Instead of printing both the SHA-1 and the name, print only
  39         the name.  If given with --tags the usual tag prefix of
  40         "tags/" is also omitted from the name, matching the output
  41         of `git-describe` more closely.  This option
  42         cannot be combined with --stdin.
  43
  44 --no-undefined::
  45         Die with error code != 0 when a reference is undefined,
  46         instead of printing `undefined`.
  47
  48 --always::
  49         Show uniquely abbreviated commit object as fallback.
  50
  51 EXAMPLE
  52 -------
  53
  54 Given a commit, find out where it is relative to the local refs. Say somebody
  55 wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
  56 Of course, you look into the commit, but that only tells you what happened, but
  57 not the context.
  58
  59 Enter `git-name-rev`:
  60
  61 ------------
  62 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
  63 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
  64 ------------
  65
  66 Now you are wiser, because you know that it happened 940 revisions before v0.99.
  67
  68 Another nice thing you can do is:
  69
  70 ------------
  71 % git log | git name-rev --stdin
  72 ------------
  73
  74
  75 Author
  76 ------
  77 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
  78
  79 Documentation
  80 --------------
  81 Documentation by Johannes Schindelin.
  82
  83 GIT
  84 ---
  85 Part of the linkgit:git[1] suite