Merge branch 'jc/reflog-doc'
authorJunio C Hamano <gitster@pobox.com>
Fri, 18 Oct 2013 20:50:12 +0000 (18 13:50 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 18 Oct 2013 20:50:12 +0000 (18 13:50 -0700)
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

1  2 
Documentation/git-sh-setup.txt
Documentation/git.txt
git-sh-setup.sh

Simple merge
@@@ -897,18 -841,16 +897,28 @@@ GIT_LITERAL_PATHSPECS:
        literal paths to Git (e.g., paths previously given to you by
        `git ls-tree`, `--raw` diff output, etc).
  
 +GIT_GLOB_PATHSPECS::
 +      Setting this variable to `1` will cause Git to treat all
 +      pathspecs as glob patterns (aka "glob" magic).
 +
 +GIT_NOGLOB_PATHSPECS::
 +      Setting this variable to `1` will cause Git to treat all
 +      pathspecs as literal (aka "literal" magic).
 +
 +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]]
  ------------------------
diff --cc git-sh-setup.sh
Simple merge