blame-options.txt: explain that -L <start> and <end> are optional
[git/gitweb.git] / git-sh-setup.sh
blob2f7835941ecaa48be17b6dd64e64fb0df3db37e2
1 #!/bin/sh
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,
6 # it dies.
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
11 # exporting it.
12 # But we protect ourselves from such a user mistake nevertheless.
13 unset CDPATH
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.
18 IFS='
21 git_broken_path_fix () {
22 case ":$PATH:" in
23 *:$1:*) : ok ;;
25 PATH=$(
26 SANE_TOOL_PATH="$1"
27 IFS=: path= sep=
28 set x $PATH
29 shift
30 for elem
32 case "$SANE_TOOL_PATH:$elem" in
33 (?*:/bin | ?*:/usr/bin)
34 path="$path$sep$SANE_TOOL_PATH"
35 sep=:
36 SANE_TOOL_PATH=
37 esac
38 path="$path$sep$elem"
39 sep=:
40 done
41 echo "$path"
44 esac
47 # @@BROKEN_PATH_FIX@@
49 die () {
50 die_with_status 1 "$@"
53 die_with_status () {
54 status=$1
55 shift
56 echo >&2 "$*"
57 exit "$status"
60 GIT_QUIET=
62 say () {
63 if test -z "$GIT_QUIET"
64 then
65 printf '%s\n' "$*"
69 if test -n "$OPTIONS_SPEC"; then
70 usage() {
71 "$0" -h
72 exit 1
75 parseopt_extra=
76 [ -n "$OPTIONS_KEEPDASHDASH" ] &&
77 parseopt_extra="--keep-dashdash"
79 eval "$(
80 echo "$OPTIONS_SPEC" |
81 git rev-parse --parseopt $parseopt_extra -- "$@" ||
82 echo exit $?
84 else
85 dashless=$(basename "$0" | sed -e 's/-/ /')
86 usage() {
87 die "usage: $dashless $USAGE"
90 if [ -z "$LONG_USAGE" ]
91 then
92 LONG_USAGE="usage: $dashless $USAGE"
93 else
94 LONG_USAGE="usage: $dashless $USAGE
96 $LONG_USAGE"
99 case "$1" in
101 echo "$LONG_USAGE"
102 exit
103 esac
106 set_reflog_action() {
107 if [ -z "${GIT_REFLOG_ACTION:+set}" ]
108 then
109 GIT_REFLOG_ACTION="$*"
110 export GIT_REFLOG_ACTION
114 git_editor() {
115 if test -z "${GIT_EDITOR:+set}"
116 then
117 GIT_EDITOR="$(git var GIT_EDITOR)" || return $?
120 eval "$GIT_EDITOR" '"$@"'
123 git_pager() {
124 if test -t 1
125 then
126 GIT_PAGER=$(git var GIT_PAGER)
127 else
128 GIT_PAGER=cat
130 : ${LESS=-FRSX}
131 export LESS
133 eval "$GIT_PAGER" '"$@"'
136 sane_grep () {
137 GREP_OPTIONS= LC_ALL=C grep "$@"
140 sane_egrep () {
141 GREP_OPTIONS= LC_ALL=C egrep "$@"
144 is_bare_repository () {
145 git rev-parse --is-bare-repository
148 cd_to_toplevel () {
149 cdup=$(git rev-parse --show-toplevel) &&
150 cd "$cdup" || {
151 echo >&2 "Cannot chdir to $cdup, the toplevel of the working tree"
152 exit 1
156 require_work_tree_exists () {
157 if test "z$(git rev-parse --is-bare-repository)" != zfalse
158 then
159 die "fatal: $0 cannot be used without a working tree."
163 require_work_tree () {
164 test "$(git rev-parse --is-inside-work-tree 2>/dev/null)" = true ||
165 die "fatal: $0 cannot be used without a working tree."
168 require_clean_work_tree () {
169 git rev-parse --verify HEAD >/dev/null || exit 1
170 git update-index -q --ignore-submodules --refresh
171 err=0
173 if ! git diff-files --quiet --ignore-submodules
174 then
175 echo >&2 "Cannot $1: You have unstaged changes."
176 err=1
179 if ! git diff-index --cached --quiet --ignore-submodules HEAD --
180 then
181 if [ $err = 0 ]
182 then
183 echo >&2 "Cannot $1: Your index contains uncommitted changes."
184 else
185 echo >&2 "Additionally, your index contains uncommitted changes."
187 err=1
190 if [ $err = 1 ]
191 then
192 test -n "$2" && echo >&2 "$2"
193 exit 1
197 # Generate a sed script to parse identities from a commit.
199 # Reads the commit from stdin, which should be in raw format (e.g., from
200 # cat-file or "--pretty=raw").
202 # The first argument specifies the ident line to parse (e.g., "author"), and
203 # the second specifies the environment variable to put it in (e.g., "AUTHOR"
204 # for "GIT_AUTHOR_*"). Multiple pairs can be given to parse author and
205 # committer.
206 pick_ident_script () {
207 while test $# -gt 0
209 lid=$1; shift
210 uid=$1; shift
211 printf '%s' "
212 /^$lid /{
213 s/'/'\\\\''/g
215 s/^$lid "'\([^<]*\) <[^>]*> .*$/\1/'"
216 s/.*/GIT_${uid}_NAME='&'/p
219 s/^$lid "'[^<]* <\([^>]*\)> .*$/\1/'"
220 s/.*/GIT_${uid}_EMAIL='&'/p
223 s/^$lid "'[^<]* <[^>]*> \(.*\)$/@\1/'"
224 s/.*/GIT_${uid}_DATE='&'/p
227 done
228 echo '/^$/q'
231 # Create a pick-script as above and feed it to sed. Stdout is suitable for
232 # feeding to eval.
233 parse_ident_from_commit () {
234 LANG=C LC_ALL=C sed -ne "$(pick_ident_script "$@")"
237 # Parse the author from a commit given as an argument. Stdout is suitable for
238 # feeding to eval to set the usual GIT_* ident variables.
239 get_author_ident_from_commit () {
240 encoding=$(git config i18n.commitencoding || echo UTF-8)
241 git show -s --pretty=raw --encoding="$encoding" "$1" -- |
242 parse_ident_from_commit author AUTHOR
245 # Clear repo-local GIT_* environment variables. Useful when switching to
246 # another repository (e.g. when entering a submodule). See also the env
247 # list in git_connect()
248 clear_local_git_env() {
249 unset $(git rev-parse --local-env-vars)
252 # Generate a virtual base file for a two-file merge. Uses git apply to
253 # remove lines from $1 that are not in $2, leaving only common lines.
254 create_virtual_base() {
255 sz0=$(wc -c <"$1")
256 @@DIFF@@ -u -La/"$1" -Lb/"$1" "$1" "$2" | git apply --no-add
257 sz1=$(wc -c <"$1")
259 # If we do not have enough common material, it is not
260 # worth trying two-file merge using common subsections.
261 expr $sz0 \< $sz1 \* 2 >/dev/null || : >"$1"
265 # Platform specific tweaks to work around some commands
266 case $(uname -s) in
267 *MINGW*)
268 # Windows has its own (incompatible) sort and find
269 sort () {
270 /usr/bin/sort "$@"
272 find () {
273 /usr/bin/find "$@"
275 # git sees Windows-style pwd
276 pwd () {
277 builtin pwd -W
279 is_absolute_path () {
280 case "$1" in
281 [/\\]* | [A-Za-z]:*)
282 return 0 ;;
283 esac
284 return 1
288 is_absolute_path () {
289 case "$1" in
291 return 0 ;;
292 esac
293 return 1
295 esac
297 # Make sure we are in a valid repository of a vintage we understand,
298 # if we require to be in a git repository.
299 if test -z "$NONGIT_OK"
300 then
301 GIT_DIR=$(git rev-parse --git-dir) || exit
302 if [ -z "$SUBDIRECTORY_OK" ]
303 then
304 test -z "$(git rev-parse --show-cdup)" || {
305 exit=$?
306 echo >&2 "You need to run this command from the toplevel of the working tree."
307 exit $exit
310 test -n "$GIT_DIR" && GIT_DIR=$(cd "$GIT_DIR" && pwd) || {
311 echo >&2 "Unable to determine absolute path of git directory"
312 exit 1
314 : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"}