Documentation/git-replace.txt

   1 git-replace(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 git-replace - Create, list, delete refs to replace objects
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git replace' [-f] <object> <replacement>
  12 'git replace' -d <object>...
  13 'git replace' -l [<pattern>]
  14
  15 DESCRIPTION
  16 -----------
  17 Adds a 'replace' reference in `.git/refs/replace/`
  18
  19 The name of the 'replace' reference is the SHA1 of the object that is
  20 replaced. The content of the 'replace' reference is the SHA1 of the
  21 replacement object.
  22
  23 Unless `-f` is given, the 'replace' reference must not yet exist in
  24 `.git/refs/replace/` directory.
  25
  26 Replacement references will be used by default by all git commands
  27 except those doing reachability traversal (prune, pack transfer and
  28 fsck).
  29
  30 It is possible to disable use of replacement references for any
  31 command using the `--no-replace-objects` option just after 'git'.
  32
  33 For example if commit 'foo' has been replaced by commit 'bar':
  34
  35 ------------------------------------------------
  36 $ git --no-replace-objects cat-file commit foo
  37 ------------------------------------------------
  38
  39 shows information about commit 'foo', while:
  40
  41 ------------------------------------------------
  42 $ git cat-file commit foo
  43 ------------------------------------------------
  44
  45 shows information about commit 'bar'.
  46
  47 The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to
  48 achieve the same effect as the `--no-replace-objects` option.
  49
  50 OPTIONS
  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
  65 BUGS
  66 ----
  67 Comparing blobs or trees that have been replaced with those that
  68 replace them will not work properly. And using 'git reset --hard' to
  69 go back to a replaced commit will move the branch to the replacement
  70 commit instead of the replaced commit.
  71
  72 There may be other problems when using 'git rev-list' related to
  73 pending objects. And of course things may break if an object of one
  74 type is replaced by an object of another type (for example a blob
  75 replaced by a commit).
  76
  77 SEE ALSO
  78 --------
  79 linkgit:git-tag[1]
  80 linkgit:git-branch[1]
  81 linkgit:git[1]
  82
  83 Author
  84 ------
  85 Written by Christian Couder <chriscool@tuxfamily.org> and Junio C
  86 Hamano <gitster@pobox.com>, based on 'git tag' by Kristian Hogsberg
  87 <krh@redhat.com> and Carlos Rica <jasampler@gmail.com>.
  88
  89 Documentation
  90 --------------
  91 Documentation by Christian Couder <chriscool@tuxfamily.org> and the
  92 git-list <git@vger.kernel.org>, based on 'git tag' documentation.
  93
  94 GIT
  95 ---
  96 Part of the linkgit:git[1] suite