From: Christian Couder Date: Mon, 13 Apr 2009 22:36:59 +0000 (+0200) Subject: Documentation: add documentation for "git replace" X-Git-Tag: v1.6.5-rc0~52^2~1 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=0f3a5bfd34bfc9f710d6d7d259ad0a38b37a2334;p=git.git Documentation: add documentation for "git replace" Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano --- diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt new file mode 100644 index 000000000..915cb77b2 --- /dev/null +++ b/Documentation/git-replace.txt @@ -0,0 +1,71 @@ +git-replace(1) +============== + +NAME +---- +git-replace - Create, list, delete refs to replace objects + +SYNOPSIS +-------- +[verse] +'git replace' [-f] +'git replace' -d ... +'git replace' -l [] + +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. + +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 :: + 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] + +Author +------ +Written by Christian Couder and Junio C +Hamano , based on 'git tag' by Kristian Hogsberg + and Carlos Rica . + +Documentation +-------------- +Documentation by Christian Couder and the +git-list , based on 'git tag' documentation. + +GIT +--- +Part of the linkgit:git[1] suite