Documentation / git-name-rev.txton commit user-manual: use pithier example commit (e2618ff)
   1git-name-rev(1)
   2===============
   3
   4NAME
   5----
   6git-name-rev - Find symbolic names for given revs
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git-name-rev' [--tags] [--refs=<pattern>]
  13               ( --all | --stdin | <committish>... )
  14
  15DESCRIPTION
  16-----------
  17Finds symbolic names suitable for human digestion for revisions given in any
  18format parsable by git-rev-parse.
  19
  20
  21OPTIONS
  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
  37EXAMPLE
  38-------
  39
  40Given a commit, find out where it is relative to the local refs. Say somebody
  41wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
  42Of course, you look into the commit, but that only tells you what happened, but
  43not the context.
  44
  45Enter git-name-rev:
  46
  47------------
  48% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
  4933db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
  50------------
  51
  52Now you are wiser, because you know that it happened 940 revisions before v0.99.
  53
  54Another nice thing you can do is:
  55
  56------------
  57% git log | git name-rev --stdin
  58------------
  59
  60
  61Author
  62------
  63Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
  64
  65Documentation
  66--------------
  67Documentation by Johannes Schindelin.
  68
  69GIT
  70---
  71Part of the gitlink:git[7] suite
  72