aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-10-18 13:50:12 -0700
committerJunio C Hamano <gitster@pobox.com>2013-10-18 13:50:12 -0700
commit6c2bec96a8215bad7745d559c631e45332c5a9ee (patch)
tree23cf1f401779b2052407e42644853beb8f676cc3 /Documentation/git.txt
parentdec034a34e3887beaea9a7a390fd950346806c1e (diff)
parentc3e2d18996e4ef92f37bf56b2fefe2124d26659e (diff)
downloadgit-6c2bec96a8215bad7745d559c631e45332c5a9ee.tar.gz
git-6c2bec96a8215bad7745d559c631e45332c5a9ee.tar.xz
Merge branch 'jc/reflog-doc'
Document rules to use GIT_REFLOG_ACTION variable in the scripted Porcelain. git-rebase--interactive locally violates them, but it is a leaf user that does not call out to or dot-source other scripts, so it does not urgently need to be fixed. * jc/reflog-doc: setup_reflog_action: document the rules for using GIT_REFLOG_ACTION
Diffstat (limited to 'Documentation/git.txt')
-rw-r--r--Documentation/git.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index da7be1fdf..4f7e07f2e 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -909,6 +909,16 @@ GIT_ICASE_PATHSPECS::
Setting this variable to `1` will cause Git to treat all
pathspecs as case-insensitive.
+'GIT_REFLOG_ACTION'::
+ When a ref is updated, reflog entries are created to keep
+ track of the reason why the ref was updated (which is
+ typically the name of the high-level command that updated
+ the ref), in addition to the old and new values of the ref.
+ A scripted Porcelain command can use set_reflog_action
+ helper function in `git-sh-setup` to set its name to this
+ variable when it is invoked as the top level command by the
+ end user, to be recorded in the body of the reflog.
+
Discussion[[Discussion]]
------------------------