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