Merge branch 'gj/push-more-verbose-advice' (early part)
[gitweb.git] / Documentation / git-sh-setup.txt
index 5d709d02c39e10ac946c3870a10d959a4c12a5d4..4f67c4cde679cf03e8cc43ac0630a45b5e68aa2d 100644 (file)
@@ -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