mirrors/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-28 21:07:52 +01:00
Code Activity

Merge branch 'jc/reflog-doc'

Browse source 
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
This commit is contained in:
Junio C Hamano 2013-10-18 13:50:12 -07:00
commit 6c2bec96a8
3 changed files with 49 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Documentation/git-sh-setup.txt
View 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

10
Documentation/git.txt
View file

@ -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]]
------------------------

34
git-sh-setup.sh
View file

@ -103,6 +103,40 @@ $LONG_USAGE"
esac
fi
# Set the name of the end-user facing command in the reflog when the
# script may update refs. When GIT_REFLOG_ACTION is already set, this
# will not overwrite it, so that a scripted Porcelain (e.g. "git
# rebase") can set it to its own name (e.g. "rebase") and then call
# another scripted Porcelain (e.g. "git am") and a call to this
# function in the latter will keep the name of the end-user facing
# program (e.g. "rebase") in GIT_REFLOG_ACTION, ensuring whatever it
# does will be record as actions done as part of the end-user facing
# operation (e.g. "rebase").
#
# NOTE NOTE NOTE: consequently, after assigning a specific message to
# GIT_REFLOG_ACTION when calling a "git" command to record a custom
# reflog message, do not leave that custom value in GIT_REFLOG_ACTION,
# after you are done. Other callers of "git" commands that rely on
# writing the default "program name" in reflog expect the variable to
# contain the value set by this function.
#
# To use a custom reflog message, do either one of these three:
#
# (a) use a single-shot export form:
# GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \
# git command-that-updates-a-ref
#
# (b) save the original away and restore:
# SAVED_ACTION=$GIT_REFLOG_ACTION
# GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
# git command-that-updates-a-ref
# GIT_REFLOG_ACITON=$SAVED_ACTION
#
# (c) assign the variable in a subshell:
# (
# GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
# git command-that-updates-a-ref
# )
set_reflog_action() {
if [ -z "${GIT_REFLOG_ACTION:+set}" ]
then