3 # This is included in commands that either have to be run from the toplevel
4 # of the repository, or with GIT_DIR environment variable properly.
5 # If the GIT_DIR does not look like the right correct git-repository,
8 # Having this variable in your environment would break scripts because
9 # you would cause "cd" to be taken to unexpected places. If you
10 # like CDPATH, define it for your interactive shell sessions without
12 # But we protect ourselves from such a user mistake nevertheless.
15 # Similarly for IFS, but some shells (e.g. FreeBSD 7.2) are buggy and
16 # do not equate an unset IFS with IFS with the default, so here is
17 # an explicit SP HT LF.
21 git_broken_path_fix
() {
32 case "$SANE_TOOL_PATH:$elem" in
33 (?
*:/bin | ?
*:/usr
/bin
)
34 path
="$path$sep$SANE_TOOL_PATH"
50 die_with_status
1 "$@"
56 printf >&2 '%s\n' "$*"
63 if test -z "$GIT_QUIET"
71 if test -n "$OPTIONS_SPEC"; then
78 [ -n "$OPTIONS_KEEPDASHDASH" ] &&
79 parseopt_extra
="--keep-dashdash"
82 echo "$OPTIONS_SPEC" |
83 git rev-parse --parseopt $parseopt_extra -- "$@
" ||
87 dashless
=$
(basename "$0" |
sed -e 's/-/ /')
89 die
"usage: $dashless $USAGE"
92 if [ -z "$LONG_USAGE" ]
94 LONG_USAGE
="usage: $dashless $USAGE"
96 LONG_USAGE
="usage: $dashless $USAGE
108 # Set the name of the end-user facing command in the reflog when the
109 # script may update refs. When GIT_REFLOG_ACTION is already set, this
110 # will not overwrite it, so that a scripted Porcelain (e.g. "git
111 # rebase") can set it to its own name (e.g. "rebase") and then call
112 # another scripted Porcelain (e.g. "git am") and a call to this
113 # function in the latter will keep the name of the end-user facing
114 # program (e.g. "rebase") in GIT_REFLOG_ACTION, ensuring whatever it
115 # does will be record as actions done as part of the end-user facing
116 # operation (e.g. "rebase").
118 # NOTE NOTE NOTE: consequently, after assigning a specific message to
119 # GIT_REFLOG_ACTION when calling a "git" command to record a custom
120 # reflog message, do not leave that custom value in GIT_REFLOG_ACTION,
121 # after you are done. Other callers of "git" commands that rely on
122 # writing the default "program name" in reflog expect the variable to
123 # contain the value set by this function.
125 # To use a custom reflog message, do either one of these three:
127 # (a) use a single-shot export form:
128 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz" \
129 # git command-that-updates-a-ref
131 # (b) save the original away and restore:
132 # SAVED_ACTION=$GIT_REFLOG_ACTION
133 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
134 # git command-that-updates-a-ref
135 # GIT_REFLOG_ACITON=$SAVED_ACTION
137 # (c) assign the variable in a subshell:
139 # GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: preparing frotz"
140 # git command-that-updates-a-ref
142 set_reflog_action
() {
143 if [ -z "${GIT_REFLOG_ACTION:+set}" ]
145 GIT_REFLOG_ACTION
="$*"
146 export GIT_REFLOG_ACTION
151 if test -z "${GIT_EDITOR:+set}"
153 GIT_EDITOR
="$(git var GIT_EDITOR)" ||
return $?
156 eval "$GIT_EDITOR" '"$@"'
162 GIT_PAGER
=$
(git var GIT_PAGER
)
169 eval "$GIT_PAGER" '"$@"'
173 GREP_OPTIONS
= LC_ALL
=C
grep "$@"
177 GREP_OPTIONS
= LC_ALL
=C
egrep "$@"
180 is_bare_repository
() {
181 git rev-parse
--is-bare-repository
185 cdup
=$
(git rev-parse
--show-toplevel) &&
187 echo >&2 "Cannot chdir to $cdup, the toplevel of the working tree"
192 require_work_tree_exists
() {
193 if test "z$(git rev-parse --is-bare-repository)" != zfalse
195 die
"fatal: $0 cannot be used without a working tree."
199 require_work_tree
() {
200 test "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = true ||
201 die
"fatal: $0 cannot be used without a working tree."
204 require_clean_work_tree
() {
205 git rev-parse
--verify HEAD
>/dev
/null ||
exit 1
206 git update-index
-q --ignore-submodules --refresh
209 if ! git diff-files
--quiet --ignore-submodules
211 echo >&2 "Cannot $1: You have unstaged changes."
215 if ! git diff-index
--cached --quiet --ignore-submodules HEAD
--
219 echo >&2 "Cannot $1: Your index contains uncommitted changes."
221 echo >&2 "Additionally, your index contains uncommitted changes."
228 test -n "$2" && echo >&2 "$2"
233 # Generate a sed script to parse identities from a commit.
235 # Reads the commit from stdin, which should be in raw format (e.g., from
236 # cat-file or "--pretty=raw").
238 # The first argument specifies the ident line to parse (e.g., "author"), and
239 # the second specifies the environment variable to put it in (e.g., "AUTHOR"
240 # for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and
242 pick_ident_script
() {
251 s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
252 s/.*/GIT_${uid}_NAME='&'/p
255 s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
256 s/.*/GIT_${uid}_EMAIL='&'/p
259 s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
260 s/.*/GIT_${uid}_DATE='&'/p
267 # Create a pick-script as above and feed it to sed. Stdout is suitable for
269 parse_ident_from_commit
() {
270 LANG
=C LC_ALL
=C
sed -ne "$(pick_ident_script "$@
")"
273 # Parse the author from a commit given as an argument. Stdout is suitable for
274 # feeding to eval to set the usual GIT_* ident variables.
275 get_author_ident_from_commit
() {
276 encoding
=$
(git config i18n.commitencoding ||
echo UTF-8
)
277 git show
-s --pretty=raw
--encoding="$encoding" "$1" -- |
278 parse_ident_from_commit author AUTHOR
281 # Clear repo-local GIT_* environment variables. Useful when switching to
282 # another repository (e.g. when entering a submodule). See also the env
283 # list in git_connect()
284 clear_local_git_env
() {
285 unset $
(git rev-parse
--local-env-vars)
288 # Generate a virtual base file for a two-file merge. Uses git apply to
289 # remove lines from $1 that are not in $2, leaving only common lines.
290 create_virtual_base
() {
292 @@DIFF@@
-u -La/"$1" -Lb/"$1" "$1" "$2" | git apply
--no-add
295 # If we do not have enough common material, it is not
296 # worth trying two-file merge using common subsections.
297 expr $sz0 \
< $sz1 \
* 2 >/dev
/null ||
: >"$1"
301 # Platform specific tweaks to work around some commands
304 # Windows has its own (incompatible) sort and find
311 # Let pwd always return the uniqe real windows path
313 is_absolute_path
() {
322 is_absolute_path
() {
331 # Make sure we are in a valid repository of a vintage we understand,
332 # if we require to be in a git repository.
333 if test -z "$NONGIT_OK"
335 GIT_DIR
=$
(git rev-parse
--git-dir) ||
exit
336 if [ -z "$SUBDIRECTORY_OK" ]
338 test -z "$(git rev-parse --show-cdup)" ||
{
340 echo >&2 "You need to run this command from the toplevel of the working tree."
344 test -n "$GIT_DIR" && GIT_DIR
=$
(cd "$GIT_DIR" && pwd) ||
{
345 echo >&2 "Unable to determine absolute path of git directory"
348 : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"}
354 peeltmp
=$
(git rev-parse
--verify "$1") &&
355 git rev-parse
--verify "${peeltmp}^0"
358 git rev-parse
--verify "${1}^0"