Documentation / git-name-rev.txton commit GIT-VERSION-GEN: do not fail if a 'HEAD' file exists in the working copy (935e247)
   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
  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 linkgit:git-describe[1] 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
  51EXAMPLE
  52-------
  53
  54Given a commit, find out where it is relative to the local refs. Say somebody
  55wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
  56Of course, you look into the commit, but that only tells you what happened, but
  57not the context.
  58
  59Enter git-name-rev:
  60
  61------------
  62% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
  6333db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
  64------------
  65
  66Now you are wiser, because you know that it happened 940 revisions before v0.99.
  67
  68Another nice thing you can do is:
  69
  70------------
  71% git log | git name-rev --stdin
  72------------
  73
  74
  75Author
  76------
  77Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
  78
  79Documentation
  80--------------
  81Documentation by Johannes Schindelin.
  82
  83GIT
  84---
  85Part of the linkgit:git[1] suite