Documentation / git-replace.txton commit glossary: update description of "tag" (487b044)
   1git-replace(1)
   2==============
   3
   4NAME
   5----
   6git-replace - Create, list, delete refs to replace objects
   7
   8SYNOPSIS
   9--------
  10[verse]
  11'git replace' [-f] <object> <replacement>
  12'git replace' -d <object>...
  13'git replace' -l [<pattern>]
  14
  15DESCRIPTION
  16-----------
  17Adds a 'replace' reference in `.git/refs/replace/`
  18
  19The name of the 'replace' reference is the SHA1 of the object that is
  20replaced. The content of the 'replace' reference is the SHA1 of the
  21replacement object.
  22
  23Unless `-f` is given, the 'replace' reference must not yet exist in
  24`.git/refs/replace/` directory.
  25
  26Replacement references will be used by default by all git commands
  27except those doing reachability traversal (prune, pack transfer and
  28fsck).
  29
  30It is possible to disable use of replacement references for any
  31command using the `--no-replace-objects` option just after 'git'.
  32
  33For example if commit 'foo' has been replaced by commit 'bar':
  34
  35------------------------------------------------
  36$ git --no-replace-objects cat-file commit foo
  37------------------------------------------------
  38
  39shows information about commit 'foo', while:
  40
  41------------------------------------------------
  42$ git cat-file commit foo
  43------------------------------------------------
  44
  45shows information about commit 'bar'.
  46
  47The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to
  48achieve the same effect as the `--no-replace-objects` option.
  49
  50OPTIONS
  51-------
  52-f::
  53        If an existing replace ref for the same object exists, it will
  54        be overwritten (instead of failing).
  55
  56-d::
  57        Delete existing replace refs for the given objects.
  58
  59-l <pattern>::
  60        List replace refs for objects that match the given pattern (or
  61        all if no pattern is given).
  62        Typing "git replace" without arguments, also lists all replace
  63        refs.
  64
  65BUGS
  66----
  67Comparing blobs or trees that have been replaced with those that
  68replace them will not work properly. And using `git reset --hard` to
  69go back to a replaced commit will move the branch to the replacement
  70commit instead of the replaced commit.
  71
  72There may be other problems when using 'git rev-list' related to
  73pending objects. And of course things may break if an object of one
  74type is replaced by an object of another type (for example a blob
  75replaced by a commit).
  76
  77SEE ALSO
  78--------
  79linkgit:git-tag[1]
  80linkgit:git-branch[1]
  81linkgit:git[1]
  82
  83GIT
  84---
  85Part of the linkgit:git[1] suite