diff options
| author | Junio C Hamano <gitster@pobox.com> | 2013-10-19 00:50:12 +0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-10-19 00:50:12 +0400 |
| commit | 6c2bec96a8215bad7745d559c631e45332c5a9ee (patch) | |
| tree | 23cf1f401779b2052407e42644853beb8f676cc3 /Documentation | |
| parent | dec034a34e3887beaea9a7a390fd950346806c1e (diff) | |
| parent | c3e2d18996e4ef92f37bf56b2fefe2124d26659e (diff) | |
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')
| -rw-r--r-- | Documentation/git-sh-setup.txt | 8 | ||||
| -rw-r--r-- | Documentation/git.txt | 10 |
2 files changed, 15 insertions, 3 deletions
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index 5d709d02c3..4f67c4cde6 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt @@ -41,9 +41,11 @@ usage:: die with the usage message. set_reflog_action:: - set the message that will be recorded to describe the - end-user action in the reflog, when the script updates a - ref. + Set GIT_REFLOG_ACTION environment to a given string (typically + the name of the program) unless it is already set. Whenever + the script runs a `git` command that updates refs, a reflog + entry is created using the value of this string to leave the + record of what command updated the ref. git_editor:: runs an editor of user's choice (GIT_EDITOR, core.editor, VISUAL or diff --git a/Documentation/git.txt b/Documentation/git.txt index da7be1fdf4..4f7e07f2e0 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]] ------------------------ |