1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-31 14:27:54 +01:00
git/Documentation/git-replace.txt
Christian Couder b0fa7ab51b git: add --no-replace-objects option to disable replacing
Commit dae556b (environment: add global variable to disable replacement)
adds a variable to enable/disable replacement, and it is enabled by
default for most commands.

So there is no way to disable it for some commands, which is annoying
when we want to get information about a commit that has been replaced.

For example:

$ git cat-file -p N

would output information about the replacement commit if commit N is
replaced.

With the "--no-replace-objects" option that this patch adds it is
possible to get information about the original commit using:

$ git --no-replace-objects cat-file -p N

While at it, let's add some documentation about this new option in the
"git replace" man page too.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-10-13 01:07:29 -07:00

92 lines
2.5 KiB
Text

git-replace(1)
==============
NAME
----
git-replace - Create, list, delete refs to replace objects
SYNOPSIS
--------
[verse]
'git replace' [-f] <object> <replacement>
'git replace' -d <object>...
'git replace' -l [<pattern>]
DESCRIPTION
-----------
Adds a 'replace' reference in `.git/refs/replace/`
The name of the 'replace' reference is the SHA1 of the object that is
replaced. The content of the replace reference is the SHA1 of the
replacement object.
Unless `-f` is given, the replace reference must not yet exist in
`.git/refs/replace/` directory.
Replace references will be used by default by all git commands except
those doing reachability traversal (prune, pack transfer and fsck).
It is possible to disable use of replacement refs for any command
using the --no-replace-objects option just after "git".
For example if commit "foo" has been replaced by commit "bar":
------------------------------------------------
$ git --no-replace-object cat-file commit foo
------------------------------------------------
show information about commit "foo", while:
------------------------------------------------
$ git cat-file commit foo
------------------------------------------------
show information about commit "bar".
OPTIONS
-------
-f::
If an existing replace ref for the same object exists, it will
be overwritten (instead of failing).
-d::
Delete existing replace refs for the given objects.
-l <pattern>::
List replace refs for objects that match the given pattern (or
all if no pattern is given).
Typing "git replace" without arguments, also lists all replace
refs.
BUGS
----
Comparing blobs or trees that have been replaced with those that
replace them will not work properly. And using 'git reset --hard' to
go back to a replaced commit will move the branch to the replacement
commit instead of the replaced commit.
There may be other problems when using 'git rev-list' related to
pending objects. And of course things may break if an object of one
type is replaced by an object of another type (for example a blob
replaced by a commit).
SEE ALSO
--------
linkgit:git-tag[1]
linkgit:git-branch[1]
linkgit:git[1]
Author
------
Written by Christian Couder <chriscool@tuxfamily.org> and Junio C
Hamano <gitster@pobox.com>, based on 'git tag' by Kristian Hogsberg
<krh@redhat.com> and Carlos Rica <jasampler@gmail.com>.
Documentation
--------------
Documentation by Christian Couder <chriscool@tuxfamily.org> and the
git-list <git@vger.kernel.org>, based on 'git tag' documentation.
GIT
---
Part of the linkgit:git[1] suite