Merge branch 'ds/bloom-cleanup'
[git/raj.git] / contrib / completion / git-completion.bash
blob70ad04e1b2a8c65896c95c8e6bd34e963c74c687
1 # bash/zsh completion support for core Git.
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4 # Conceptually based on gitcompletion (http://gitweb.hawaga.org.uk/).
5 # Distributed under the GNU General Public License, version 2.0.
7 # The contained completion routines provide support for completing:
9 # *) local and remote branch names
10 # *) local and remote tag names
11 # *) .git/remotes file names
12 # *) git 'subcommands'
13 # *) git email aliases for git-send-email
14 # *) tree paths within 'ref:path/to/file' expressions
15 # *) file paths within current working directory and index
16 # *) common --long-options
18 # To use these routines:
20 # 1) Copy this file to somewhere (e.g. ~/.git-completion.bash).
21 # 2) Add the following line to your .bashrc/.zshrc:
22 # source ~/.git-completion.bash
23 # 3) Consider changing your PS1 to also show the current branch,
24 # see git-prompt.sh for details.
26 # If you use complex aliases of form '!f() { ... }; f', you can use the null
27 # command ':' as the first command in the function body to declare the desired
28 # completion style. For example '!f() { : git commit ; ... }; f' will
29 # tell the completion to use commit completion. This also works with aliases
30 # of form "!sh -c '...'". For example, "!sh -c ': git commit ; ... '".
32 # Compatible with bash 3.2.57.
34 # You can set the following environment variables to influence the behavior of
35 # the completion routines:
37 # GIT_COMPLETION_CHECKOUT_NO_GUESS
39 # When set to "1", do not include "DWIM" suggestions in git-checkout
40 # and git-switch completion (e.g., completing "foo" when "origin/foo"
41 # exists).
43 case "$COMP_WORDBREAKS" in
44 *:*) : great ;;
45 *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
46 esac
48 # Discovers the path to the git repository taking any '--git-dir=<path>' and
49 # '-C <path>' options into account and stores it in the $__git_repo_path
50 # variable.
51 __git_find_repo_path ()
53 if [ -n "$__git_repo_path" ]; then
54 # we already know where it is
55 return
58 if [ -n "${__git_C_args-}" ]; then
59 __git_repo_path="$(git "${__git_C_args[@]}" \
60 ${__git_dir:+--git-dir="$__git_dir"} \
61 rev-parse --absolute-git-dir 2>/dev/null)"
62 elif [ -n "${__git_dir-}" ]; then
63 test -d "$__git_dir" &&
64 __git_repo_path="$__git_dir"
65 elif [ -n "${GIT_DIR-}" ]; then
66 test -d "${GIT_DIR-}" &&
67 __git_repo_path="$GIT_DIR"
68 elif [ -d .git ]; then
69 __git_repo_path=.git
70 else
71 __git_repo_path="$(git rev-parse --git-dir 2>/dev/null)"
75 # Deprecated: use __git_find_repo_path() and $__git_repo_path instead
76 # __gitdir accepts 0 or 1 arguments (i.e., location)
77 # returns location of .git repo
78 __gitdir ()
80 if [ -z "${1-}" ]; then
81 __git_find_repo_path || return 1
82 echo "$__git_repo_path"
83 elif [ -d "$1/.git" ]; then
84 echo "$1/.git"
85 else
86 echo "$1"
90 # Runs git with all the options given as argument, respecting any
91 # '--git-dir=<path>' and '-C <path>' options present on the command line
92 __git ()
94 git ${__git_C_args:+"${__git_C_args[@]}"} \
95 ${__git_dir:+--git-dir="$__git_dir"} "$@" 2>/dev/null
98 # Removes backslash escaping, single quotes and double quotes from a word,
99 # stores the result in the variable $dequoted_word.
100 # 1: The word to dequote.
101 __git_dequote ()
103 local rest="$1" len ch
105 dequoted_word=""
107 while test -n "$rest"; do
108 len=${#dequoted_word}
109 dequoted_word="$dequoted_word${rest%%[\\\'\"]*}"
110 rest="${rest:$((${#dequoted_word}-$len))}"
112 case "${rest:0:1}" in
114 ch="${rest:1:1}"
115 case "$ch" in
116 $'\n')
119 dequoted_word="$dequoted_word$ch"
121 esac
122 rest="${rest:2}"
125 rest="${rest:1}"
126 len=${#dequoted_word}
127 dequoted_word="$dequoted_word${rest%%\'*}"
128 rest="${rest:$((${#dequoted_word}-$len+1))}"
131 rest="${rest:1}"
132 while test -n "$rest" ; do
133 len=${#dequoted_word}
134 dequoted_word="$dequoted_word${rest%%[\\\"]*}"
135 rest="${rest:$((${#dequoted_word}-$len))}"
136 case "${rest:0:1}" in
138 ch="${rest:1:1}"
139 case "$ch" in
140 \"|\\|\$|\`)
141 dequoted_word="$dequoted_word$ch"
143 $'\n')
146 dequoted_word="$dequoted_word\\$ch"
148 esac
149 rest="${rest:2}"
152 rest="${rest:1}"
153 break
155 esac
156 done
158 esac
159 done
162 # The following function is based on code from:
164 # bash_completion - programmable completion functions for bash 3.2+
166 # Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
167 # © 2009-2010, Bash Completion Maintainers
168 # <bash-completion-devel@lists.alioth.debian.org>
170 # This program is free software; you can redistribute it and/or modify
171 # it under the terms of the GNU General Public License as published by
172 # the Free Software Foundation; either version 2, or (at your option)
173 # any later version.
175 # This program is distributed in the hope that it will be useful,
176 # but WITHOUT ANY WARRANTY; without even the implied warranty of
177 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
178 # GNU General Public License for more details.
180 # You should have received a copy of the GNU General Public License
181 # along with this program; if not, see <http://www.gnu.org/licenses/>.
183 # The latest version of this software can be obtained here:
185 # http://bash-completion.alioth.debian.org/
187 # RELEASE: 2.x
189 # This function can be used to access a tokenized list of words
190 # on the command line:
192 # __git_reassemble_comp_words_by_ref '=:'
193 # if test "${words_[cword_-1]}" = -w
194 # then
195 # ...
196 # fi
198 # The argument should be a collection of characters from the list of
199 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
200 # characters.
202 # This is roughly equivalent to going back in time and setting
203 # COMP_WORDBREAKS to exclude those characters. The intent is to
204 # make option types like --date=<type> and <rev>:<path> easy to
205 # recognize by treating each shell word as a single token.
207 # It is best not to set COMP_WORDBREAKS directly because the value is
208 # shared with other completion scripts. By the time the completion
209 # function gets called, COMP_WORDS has already been populated so local
210 # changes to COMP_WORDBREAKS have no effect.
212 # Output: words_, cword_, cur_.
214 __git_reassemble_comp_words_by_ref()
216 local exclude i j first
217 # Which word separators to exclude?
218 exclude="${1//[^$COMP_WORDBREAKS]}"
219 cword_=$COMP_CWORD
220 if [ -z "$exclude" ]; then
221 words_=("${COMP_WORDS[@]}")
222 return
224 # List of word completion separators has shrunk;
225 # re-assemble words to complete.
226 for ((i=0, j=0; i < ${#COMP_WORDS[@]}; i++, j++)); do
227 # Append each nonempty word consisting of just
228 # word separator characters to the current word.
229 first=t
230 while
231 [ $i -gt 0 ] &&
232 [ -n "${COMP_WORDS[$i]}" ] &&
233 # word consists of excluded word separators
234 [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
236 # Attach to the previous token,
237 # unless the previous token is the command name.
238 if [ $j -ge 2 ] && [ -n "$first" ]; then
239 ((j--))
241 first=
242 words_[$j]=${words_[j]}${COMP_WORDS[i]}
243 if [ $i = $COMP_CWORD ]; then
244 cword_=$j
246 if (($i < ${#COMP_WORDS[@]} - 1)); then
247 ((i++))
248 else
249 # Done.
250 return
252 done
253 words_[$j]=${words_[j]}${COMP_WORDS[i]}
254 if [ $i = $COMP_CWORD ]; then
255 cword_=$j
257 done
260 if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
261 _get_comp_words_by_ref ()
263 local exclude cur_ words_ cword_
264 if [ "$1" = "-n" ]; then
265 exclude=$2
266 shift 2
268 __git_reassemble_comp_words_by_ref "$exclude"
269 cur_=${words_[cword_]}
270 while [ $# -gt 0 ]; do
271 case "$1" in
272 cur)
273 cur=$cur_
275 prev)
276 prev=${words_[$cword_-1]}
278 words)
279 words=("${words_[@]}")
281 cword)
282 cword=$cword_
284 esac
285 shift
286 done
290 # Fills the COMPREPLY array with prefiltered words without any additional
291 # processing.
292 # Callers must take care of providing only words that match the current word
293 # to be completed and adding any prefix and/or suffix (trailing space!), if
294 # necessary.
295 # 1: List of newline-separated matching completion words, complete with
296 # prefix and suffix.
297 __gitcomp_direct ()
299 local IFS=$'\n'
301 COMPREPLY=($1)
304 __gitcompappend ()
306 local x i=${#COMPREPLY[@]}
307 for x in $1; do
308 if [[ "$x" == "$3"* ]]; then
309 COMPREPLY[i++]="$2$x$4"
311 done
314 __gitcompadd ()
316 COMPREPLY=()
317 __gitcompappend "$@"
320 # Generates completion reply, appending a space to possible completion words,
321 # if necessary.
322 # It accepts 1 to 4 arguments:
323 # 1: List of possible completion words.
324 # 2: A prefix to be added to each possible completion word (optional).
325 # 3: Generate possible completion matches for this word (optional).
326 # 4: A suffix to be appended to each possible completion word (optional).
327 __gitcomp ()
329 local cur_="${3-$cur}"
331 case "$cur_" in
332 --*=)
334 --no-*)
335 local c i=0 IFS=$' \t\n'
336 for c in $1; do
337 if [[ $c == "--" ]]; then
338 continue
340 c="$c${4-}"
341 if [[ $c == "$cur_"* ]]; then
342 case $c in
343 --*=|*.) ;;
344 *) c="$c " ;;
345 esac
346 COMPREPLY[i++]="${2-}$c"
348 done
351 local c i=0 IFS=$' \t\n'
352 for c in $1; do
353 if [[ $c == "--" ]]; then
354 c="--no-...${4-}"
355 if [[ $c == "$cur_"* ]]; then
356 COMPREPLY[i++]="${2-}$c "
358 break
360 c="$c${4-}"
361 if [[ $c == "$cur_"* ]]; then
362 case $c in
363 *=|*.) ;;
364 *) c="$c " ;;
365 esac
366 COMPREPLY[i++]="${2-}$c"
368 done
370 esac
373 # Clear the variables caching builtins' options when (re-)sourcing
374 # the completion script.
375 if [[ -n ${ZSH_VERSION-} ]]; then
376 unset $(set |sed -ne 's/^\(__gitcomp_builtin_[a-zA-Z0-9_][a-zA-Z0-9_]*\)=.*/\1/p') 2>/dev/null
377 else
378 unset $(compgen -v __gitcomp_builtin_)
381 # This function is equivalent to
383 # __gitcomp "$(git xxx --git-completion-helper) ..."
385 # except that the output is cached. Accept 1-3 arguments:
386 # 1: the git command to execute, this is also the cache key
387 # 2: extra options to be added on top (e.g. negative forms)
388 # 3: options to be excluded
389 __gitcomp_builtin ()
391 # spaces must be replaced with underscore for multi-word
392 # commands, e.g. "git remote add" becomes remote_add.
393 local cmd="$1"
394 local incl="$2"
395 local excl="$3"
397 local var=__gitcomp_builtin_"${cmd/-/_}"
398 local options
399 eval "options=\$$var"
401 if [ -z "$options" ]; then
402 # leading and trailing spaces are significant to make
403 # option removal work correctly.
404 options=" $incl $(__git ${cmd/_/ } --git-completion-helper) " || return
406 for i in $excl; do
407 options="${options/ $i / }"
408 done
409 eval "$var=\"$options\""
412 __gitcomp "$options"
415 # Variation of __gitcomp_nl () that appends to the existing list of
416 # completion candidates, COMPREPLY.
417 __gitcomp_nl_append ()
419 local IFS=$'\n'
420 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
423 # Generates completion reply from newline-separated possible completion words
424 # by appending a space to all of them.
425 # It accepts 1 to 4 arguments:
426 # 1: List of possible completion words, separated by a single newline.
427 # 2: A prefix to be added to each possible completion word (optional).
428 # 3: Generate possible completion matches for this word (optional).
429 # 4: A suffix to be appended to each possible completion word instead of
430 # the default space (optional). If specified but empty, nothing is
431 # appended.
432 __gitcomp_nl ()
434 COMPREPLY=()
435 __gitcomp_nl_append "$@"
438 # Fills the COMPREPLY array with prefiltered paths without any additional
439 # processing.
440 # Callers must take care of providing only paths that match the current path
441 # to be completed and adding any prefix path components, if necessary.
442 # 1: List of newline-separated matching paths, complete with all prefix
443 # path components.
444 __gitcomp_file_direct ()
446 local IFS=$'\n'
448 COMPREPLY=($1)
450 # use a hack to enable file mode in bash < 4
451 compopt -o filenames +o nospace 2>/dev/null ||
452 compgen -f /non-existing-dir/ >/dev/null ||
453 true
456 # Generates completion reply with compgen from newline-separated possible
457 # completion filenames.
458 # It accepts 1 to 3 arguments:
459 # 1: List of possible completion filenames, separated by a single newline.
460 # 2: A directory prefix to be added to each possible completion filename
461 # (optional).
462 # 3: Generate possible completion matches for this word (optional).
463 __gitcomp_file ()
465 local IFS=$'\n'
467 # XXX does not work when the directory prefix contains a tilde,
468 # since tilde expansion is not applied.
469 # This means that COMPREPLY will be empty and Bash default
470 # completion will be used.
471 __gitcompadd "$1" "${2-}" "${3-$cur}" ""
473 # use a hack to enable file mode in bash < 4
474 compopt -o filenames +o nospace 2>/dev/null ||
475 compgen -f /non-existing-dir/ >/dev/null ||
476 true
479 # Execute 'git ls-files', unless the --committable option is specified, in
480 # which case it runs 'git diff-index' to find out the files that can be
481 # committed. It return paths relative to the directory specified in the first
482 # argument, and using the options specified in the second argument.
483 __git_ls_files_helper ()
485 if [ "$2" == "--committable" ]; then
486 __git -C "$1" -c core.quotePath=false diff-index \
487 --name-only --relative HEAD -- "${3//\\/\\\\}*"
488 else
489 # NOTE: $2 is not quoted in order to support multiple options
490 __git -C "$1" -c core.quotePath=false ls-files \
491 --exclude-standard $2 -- "${3//\\/\\\\}*"
496 # __git_index_files accepts 1 or 2 arguments:
497 # 1: Options to pass to ls-files (required).
498 # 2: A directory path (optional).
499 # If provided, only files within the specified directory are listed.
500 # Sub directories are never recursed. Path must have a trailing
501 # slash.
502 # 3: List only paths matching this path component (optional).
503 __git_index_files ()
505 local root="$2" match="$3"
507 __git_ls_files_helper "$root" "$1" "${match:-?}" |
508 awk -F / -v pfx="${2//\\/\\\\}" '{
509 paths[$1] = 1
511 END {
512 for (p in paths) {
513 if (substr(p, 1, 1) != "\"") {
514 # No special characters, easy!
515 print pfx p
516 continue
519 # The path is quoted.
520 p = dequote(p)
521 if (p == "")
522 continue
524 # Even when a directory name itself does not contain
525 # any special characters, it will still be quoted if
526 # any of its (stripped) trailing path components do.
527 # Because of this we may have seen the same directory
528 # both quoted and unquoted.
529 if (p in paths)
530 # We have seen the same directory unquoted,
531 # skip it.
532 continue
533 else
534 print pfx p
537 function dequote(p, bs_idx, out, esc, esc_idx, dec) {
538 # Skip opening double quote.
539 p = substr(p, 2)
541 # Interpret backslash escape sequences.
542 while ((bs_idx = index(p, "\\")) != 0) {
543 out = out substr(p, 1, bs_idx - 1)
544 esc = substr(p, bs_idx + 1, 1)
545 p = substr(p, bs_idx + 2)
547 if ((esc_idx = index("abtvfr\"\\", esc)) != 0) {
548 # C-style one-character escape sequence.
549 out = out substr("\a\b\t\v\f\r\"\\",
550 esc_idx, 1)
551 } else if (esc == "n") {
552 # Uh-oh, a newline character.
553 # We cannot reliably put a pathname
554 # containing a newline into COMPREPLY,
555 # and the newline would create a mess.
556 # Skip this path.
557 return ""
558 } else {
559 # Must be a \nnn octal value, then.
560 dec = esc * 64 + \
561 substr(p, 1, 1) * 8 + \
562 substr(p, 2, 1)
563 out = out sprintf("%c", dec)
564 p = substr(p, 3)
567 # Drop closing double quote, if there is one.
568 # (There is not any if this is a directory, as it was
569 # already stripped with the trailing path components.)
570 if (substr(p, length(p), 1) == "\"")
571 out = out substr(p, 1, length(p) - 1)
572 else
573 out = out p
575 return out
579 # __git_complete_index_file requires 1 argument:
580 # 1: the options to pass to ls-file
582 # The exception is --committable, which finds the files appropriate commit.
583 __git_complete_index_file ()
585 local dequoted_word pfx="" cur_
587 __git_dequote "$cur"
589 case "$dequoted_word" in
590 ?*/*)
591 pfx="${dequoted_word%/*}/"
592 cur_="${dequoted_word##*/}"
595 cur_="$dequoted_word"
596 esac
598 __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
601 # Lists branches from the local repository.
602 # 1: A prefix to be added to each listed branch (optional).
603 # 2: List only branches matching this word (optional; list all branches if
604 # unset or empty).
605 # 3: A suffix to be appended to each listed branch (optional).
606 __git_heads ()
608 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
610 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
611 "refs/heads/$cur_*" "refs/heads/$cur_*/**"
614 # Lists tags from the local repository.
615 # Accepts the same positional parameters as __git_heads() above.
616 __git_tags ()
618 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
620 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
621 "refs/tags/$cur_*" "refs/tags/$cur_*/**"
624 # Lists refs from the local (by default) or from a remote repository.
625 # It accepts 0, 1 or 2 arguments:
626 # 1: The remote to list refs from (optional; ignored, if set but empty).
627 # Can be the name of a configured remote, a path, or a URL.
628 # 2: In addition to local refs, list unique branches from refs/remotes/ for
629 # 'git checkout's tracking DWIMery (optional; ignored, if set but empty).
630 # 3: A prefix to be added to each listed ref (optional).
631 # 4: List only refs matching this word (optional; list all refs if unset or
632 # empty).
633 # 5: A suffix to be appended to each listed ref (optional; ignored, if set
634 # but empty).
636 # Use __git_complete_refs() instead.
637 __git_refs ()
639 local i hash dir track="${2-}"
640 local list_refs_from=path remote="${1-}"
641 local format refs
642 local pfx="${3-}" cur_="${4-$cur}" sfx="${5-}"
643 local match="${4-}"
644 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
646 __git_find_repo_path
647 dir="$__git_repo_path"
649 if [ -z "$remote" ]; then
650 if [ -z "$dir" ]; then
651 return
653 else
654 if __git_is_configured_remote "$remote"; then
655 # configured remote takes precedence over a
656 # local directory with the same name
657 list_refs_from=remote
658 elif [ -d "$remote/.git" ]; then
659 dir="$remote/.git"
660 elif [ -d "$remote" ]; then
661 dir="$remote"
662 else
663 list_refs_from=url
667 if [ "$list_refs_from" = path ]; then
668 if [[ "$cur_" == ^* ]]; then
669 pfx="$pfx^"
670 fer_pfx="$fer_pfx^"
671 cur_=${cur_#^}
672 match=${match#^}
674 case "$cur_" in
675 refs|refs/*)
676 format="refname"
677 refs=("$match*" "$match*/**")
678 track=""
681 for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD REBASE_HEAD; do
682 case "$i" in
683 $match*)
684 if [ -e "$dir/$i" ]; then
685 echo "$pfx$i$sfx"
688 esac
689 done
690 format="refname:strip=2"
691 refs=("refs/tags/$match*" "refs/tags/$match*/**"
692 "refs/heads/$match*" "refs/heads/$match*/**"
693 "refs/remotes/$match*" "refs/remotes/$match*/**")
695 esac
696 __git_dir="$dir" __git for-each-ref --format="$fer_pfx%($format)$sfx" \
697 "${refs[@]}"
698 if [ -n "$track" ]; then
699 # employ the heuristic used by git checkout
700 # Try to find a remote branch that matches the completion word
701 # but only output if the branch name is unique
702 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
703 --sort="refname:strip=3" \
704 "refs/remotes/*/$match*" "refs/remotes/*/$match*/**" | \
705 uniq -u
707 return
709 case "$cur_" in
710 refs|refs/*)
711 __git ls-remote "$remote" "$match*" | \
712 while read -r hash i; do
713 case "$i" in
714 *^{}) ;;
715 *) echo "$pfx$i$sfx" ;;
716 esac
717 done
720 if [ "$list_refs_from" = remote ]; then
721 case "HEAD" in
722 $match*) echo "${pfx}HEAD$sfx" ;;
723 esac
724 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
725 "refs/remotes/$remote/$match*" \
726 "refs/remotes/$remote/$match*/**"
727 else
728 local query_symref
729 case "HEAD" in
730 $match*) query_symref="HEAD" ;;
731 esac
732 __git ls-remote "$remote" $query_symref \
733 "refs/tags/$match*" "refs/heads/$match*" \
734 "refs/remotes/$match*" |
735 while read -r hash i; do
736 case "$i" in
737 *^{}) ;;
738 refs/*) echo "$pfx${i#refs/*/}$sfx" ;;
739 *) echo "$pfx$i$sfx" ;; # symbolic refs
740 esac
741 done
744 esac
747 # Completes refs, short and long, local and remote, symbolic and pseudo.
749 # Usage: __git_complete_refs [<option>]...
750 # --remote=<remote>: The remote to list refs from, can be the name of a
751 # configured remote, a path, or a URL.
752 # --track: List unique remote branches for 'git checkout's tracking DWIMery.
753 # --pfx=<prefix>: A prefix to be added to each ref.
754 # --cur=<word>: The current ref to be completed. Defaults to the current
755 # word to be completed.
756 # --sfx=<suffix>: A suffix to be appended to each ref instead of the default
757 # space.
758 __git_complete_refs ()
760 local remote track pfx cur_="$cur" sfx=" "
762 while test $# != 0; do
763 case "$1" in
764 --remote=*) remote="${1##--remote=}" ;;
765 --track) track="yes" ;;
766 --pfx=*) pfx="${1##--pfx=}" ;;
767 --cur=*) cur_="${1##--cur=}" ;;
768 --sfx=*) sfx="${1##--sfx=}" ;;
769 *) return 1 ;;
770 esac
771 shift
772 done
774 __gitcomp_direct "$(__git_refs "$remote" "$track" "$pfx" "$cur_" "$sfx")"
777 # __git_refs2 requires 1 argument (to pass to __git_refs)
778 # Deprecated: use __git_complete_fetch_refspecs() instead.
779 __git_refs2 ()
781 local i
782 for i in $(__git_refs "$1"); do
783 echo "$i:$i"
784 done
787 # Completes refspecs for fetching from a remote repository.
788 # 1: The remote repository.
789 # 2: A prefix to be added to each listed refspec (optional).
790 # 3: The ref to be completed as a refspec instead of the current word to be
791 # completed (optional)
792 # 4: A suffix to be appended to each listed refspec instead of the default
793 # space (optional).
794 __git_complete_fetch_refspecs ()
796 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
798 __gitcomp_direct "$(
799 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
800 echo "$pfx$i:$i$sfx"
801 done
805 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
806 __git_refs_remotes ()
808 local i hash
809 __git ls-remote "$1" 'refs/heads/*' | \
810 while read -r hash i; do
811 echo "$i:refs/remotes/$1/${i#refs/heads/}"
812 done
815 __git_remotes ()
817 __git_find_repo_path
818 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
819 __git remote
822 # Returns true if $1 matches the name of a configured remote, false otherwise.
823 __git_is_configured_remote ()
825 local remote
826 for remote in $(__git_remotes); do
827 if [ "$remote" = "$1" ]; then
828 return 0
830 done
831 return 1
834 __git_list_merge_strategies ()
836 LANG=C LC_ALL=C git merge -s help 2>&1 |
837 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
838 s/\.$//
839 s/.*://
840 s/^[ ]*//
841 s/[ ]*$//
846 __git_merge_strategies=
847 # 'git merge -s help' (and thus detection of the merge strategy
848 # list) fails, unfortunately, if run outside of any git working
849 # tree. __git_merge_strategies is set to the empty string in
850 # that case, and the detection will be repeated the next time it
851 # is needed.
852 __git_compute_merge_strategies ()
854 test -n "$__git_merge_strategies" ||
855 __git_merge_strategies=$(__git_list_merge_strategies)
858 __git_merge_strategy_options="ours theirs subtree subtree= patience
859 histogram diff-algorithm= ignore-space-change ignore-all-space
860 ignore-space-at-eol renormalize no-renormalize no-renames
861 find-renames find-renames= rename-threshold="
863 __git_complete_revlist_file ()
865 local dequoted_word pfx ls ref cur_="$cur"
866 case "$cur_" in
867 *..?*:*)
868 return
870 ?*:*)
871 ref="${cur_%%:*}"
872 cur_="${cur_#*:}"
874 __git_dequote "$cur_"
876 case "$dequoted_word" in
877 ?*/*)
878 pfx="${dequoted_word%/*}"
879 cur_="${dequoted_word##*/}"
880 ls="$ref:$pfx"
881 pfx="$pfx/"
884 cur_="$dequoted_word"
885 ls="$ref"
887 esac
889 case "$COMP_WORDBREAKS" in
890 *:*) : great ;;
891 *) pfx="$ref:$pfx" ;;
892 esac
894 __gitcomp_file "$(__git ls-tree "$ls" \
895 | sed 's/^.* //
896 s/$//')" \
897 "$pfx" "$cur_"
899 *...*)
900 pfx="${cur_%...*}..."
901 cur_="${cur_#*...}"
902 __git_complete_refs --pfx="$pfx" --cur="$cur_"
904 *..*)
905 pfx="${cur_%..*}.."
906 cur_="${cur_#*..}"
907 __git_complete_refs --pfx="$pfx" --cur="$cur_"
910 __git_complete_refs
912 esac
915 __git_complete_file ()
917 __git_complete_revlist_file
920 __git_complete_revlist ()
922 __git_complete_revlist_file
925 __git_complete_remote_or_refspec ()
927 local cur_="$cur" cmd="${words[1]}"
928 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
929 if [ "$cmd" = "remote" ]; then
930 ((c++))
932 while [ $c -lt $cword ]; do
933 i="${words[c]}"
934 case "$i" in
935 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
936 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
937 --all)
938 case "$cmd" in
939 push) no_complete_refspec=1 ;;
940 fetch)
941 return
943 *) ;;
944 esac
946 --multiple) no_complete_refspec=1; break ;;
947 -*) ;;
948 *) remote="$i"; break ;;
949 esac
950 ((c++))
951 done
952 if [ -z "$remote" ]; then
953 __gitcomp_nl "$(__git_remotes)"
954 return
956 if [ $no_complete_refspec = 1 ]; then
957 return
959 [ "$remote" = "." ] && remote=
960 case "$cur_" in
961 *:*)
962 case "$COMP_WORDBREAKS" in
963 *:*) : great ;;
964 *) pfx="${cur_%%:*}:" ;;
965 esac
966 cur_="${cur_#*:}"
967 lhs=0
970 pfx="+"
971 cur_="${cur_#+}"
973 esac
974 case "$cmd" in
975 fetch)
976 if [ $lhs = 1 ]; then
977 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
978 else
979 __git_complete_refs --pfx="$pfx" --cur="$cur_"
982 pull|remote)
983 if [ $lhs = 1 ]; then
984 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
985 else
986 __git_complete_refs --pfx="$pfx" --cur="$cur_"
989 push)
990 if [ $lhs = 1 ]; then
991 __git_complete_refs --pfx="$pfx" --cur="$cur_"
992 else
993 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
996 esac
999 __git_complete_strategy ()
1001 __git_compute_merge_strategies
1002 case "$prev" in
1003 -s|--strategy)
1004 __gitcomp "$__git_merge_strategies"
1005 return 0
1008 __gitcomp "$__git_merge_strategy_options"
1009 return 0
1011 esac
1012 case "$cur" in
1013 --strategy=*)
1014 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1015 return 0
1017 --strategy-option=*)
1018 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1019 return 0
1021 esac
1022 return 1
1025 __git_all_commands=
1026 __git_compute_all_commands ()
1028 test -n "$__git_all_commands" ||
1029 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1032 # Lists all set config variables starting with the given section prefix,
1033 # with the prefix removed.
1034 __git_get_config_variables ()
1036 local section="$1" i IFS=$'\n'
1037 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1038 echo "${i#$section.}"
1039 done
1042 __git_pretty_aliases ()
1044 __git_get_config_variables "pretty"
1047 # __git_aliased_command requires 1 argument
1048 __git_aliased_command ()
1050 local word cmdline=$(__git config --get "alias.$1")
1051 for word in $cmdline; do
1052 case "$word" in
1053 \!gitk|gitk)
1054 echo "gitk"
1055 return
1057 \!*) : shell command alias ;;
1058 -*) : option ;;
1059 *=*) : setting env ;;
1060 git) : git itself ;;
1061 \(\)) : skip parens of shell function definition ;;
1062 {) : skip start of shell helper function ;;
1063 :) : skip null command ;;
1064 \'*) : skip opening quote after sh -c ;;
1066 echo "$word"
1067 return
1068 esac
1069 done
1072 # Check whether one of the given words is present on the command line,
1073 # and print the first word found.
1075 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1076 # --show-idx: Optionally show the index of the found word in the $words array.
1077 __git_find_on_cmdline ()
1079 local word c=1 show_idx
1081 while test $# -gt 1; do
1082 case "$1" in
1083 --show-idx) show_idx=y ;;
1084 *) return 1 ;;
1085 esac
1086 shift
1087 done
1088 local wordlist="$1"
1090 while [ $c -lt $cword ]; do
1091 for word in $wordlist; do
1092 if [ "$word" = "${words[c]}" ]; then
1093 if [ -n "$show_idx" ]; then
1094 echo "$c $word"
1095 else
1096 echo "$word"
1098 return
1100 done
1101 ((c++))
1102 done
1105 # Echo the value of an option set on the command line or config
1107 # $1: short option name
1108 # $2: long option name including =
1109 # $3: list of possible values
1110 # $4: config string (optional)
1112 # example:
1113 # result="$(__git_get_option_value "-d" "--do-something=" \
1114 # "yes no" "core.doSomething")"
1116 # result is then either empty (no option set) or "yes" or "no"
1118 # __git_get_option_value requires 3 arguments
1119 __git_get_option_value ()
1121 local c short_opt long_opt val
1122 local result= values config_key word
1124 short_opt="$1"
1125 long_opt="$2"
1126 values="$3"
1127 config_key="$4"
1129 ((c = $cword - 1))
1130 while [ $c -ge 0 ]; do
1131 word="${words[c]}"
1132 for val in $values; do
1133 if [ "$short_opt$val" = "$word" ] ||
1134 [ "$long_opt$val" = "$word" ]; then
1135 result="$val"
1136 break 2
1138 done
1139 ((c--))
1140 done
1142 if [ -n "$config_key" ] && [ -z "$result" ]; then
1143 result="$(__git config "$config_key")"
1146 echo "$result"
1149 __git_has_doubledash ()
1151 local c=1
1152 while [ $c -lt $cword ]; do
1153 if [ "--" = "${words[c]}" ]; then
1154 return 0
1156 ((c++))
1157 done
1158 return 1
1161 # Try to count non option arguments passed on the command line for the
1162 # specified git command.
1163 # When options are used, it is necessary to use the special -- option to
1164 # tell the implementation were non option arguments begin.
1165 # XXX this can not be improved, since options can appear everywhere, as
1166 # an example:
1167 # git mv x -n y
1169 # __git_count_arguments requires 1 argument: the git command executed.
1170 __git_count_arguments ()
1172 local word i c=0
1174 # Skip "git" (first argument)
1175 for ((i=1; i < ${#words[@]}; i++)); do
1176 word="${words[i]}"
1178 case "$word" in
1180 # Good; we can assume that the following are only non
1181 # option arguments.
1182 ((c = 0))
1184 "$1")
1185 # Skip the specified git command and discard git
1186 # main options
1187 ((c = 0))
1190 ((c++))
1192 esac
1193 done
1195 printf "%d" $c
1198 __git_whitespacelist="nowarn warn error error-all fix"
1199 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1200 __git_showcurrentpatch="diff raw"
1201 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1203 _git_am ()
1205 __git_find_repo_path
1206 if [ -d "$__git_repo_path"/rebase-apply ]; then
1207 __gitcomp "$__git_am_inprogress_options"
1208 return
1210 case "$cur" in
1211 --whitespace=*)
1212 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1213 return
1215 --patch-format=*)
1216 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1217 return
1219 --show-current-patch=*)
1220 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1221 return
1223 --*)
1224 __gitcomp_builtin am "" \
1225 "$__git_am_inprogress_options"
1226 return
1227 esac
1230 _git_apply ()
1232 case "$cur" in
1233 --whitespace=*)
1234 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1235 return
1237 --*)
1238 __gitcomp_builtin apply
1239 return
1240 esac
1243 _git_add ()
1245 case "$cur" in
1246 --chmod=*)
1247 __gitcomp "+x -x" "" "${cur##--chmod=}"
1248 return
1250 --*)
1251 __gitcomp_builtin add
1252 return
1253 esac
1255 local complete_opt="--others --modified --directory --no-empty-directory"
1256 if test -n "$(__git_find_on_cmdline "-u --update")"
1257 then
1258 complete_opt="--modified"
1260 __git_complete_index_file "$complete_opt"
1263 _git_archive ()
1265 case "$cur" in
1266 --format=*)
1267 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1268 return
1270 --remote=*)
1271 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1272 return
1274 --*)
1275 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1276 return
1278 esac
1279 __git_complete_file
1282 _git_bisect ()
1284 __git_has_doubledash && return
1286 local subcommands="start bad good skip reset visualize replay log run"
1287 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1288 if [ -z "$subcommand" ]; then
1289 __git_find_repo_path
1290 if [ -f "$__git_repo_path"/BISECT_START ]; then
1291 __gitcomp "$subcommands"
1292 else
1293 __gitcomp "replay start"
1295 return
1298 case "$subcommand" in
1299 bad|good|reset|skip|start)
1300 __git_complete_refs
1304 esac
1307 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1309 _git_branch ()
1311 local i c=1 only_local_ref="n" has_r="n"
1313 while [ $c -lt $cword ]; do
1314 i="${words[c]}"
1315 case "$i" in
1316 -d|--delete|-m|--move) only_local_ref="y" ;;
1317 -r|--remotes) has_r="y" ;;
1318 esac
1319 ((c++))
1320 done
1322 case "$cur" in
1323 --set-upstream-to=*)
1324 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1326 --*)
1327 __gitcomp_builtin branch
1330 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1331 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1332 else
1333 __git_complete_refs
1336 esac
1339 _git_bundle ()
1341 local cmd="${words[2]}"
1342 case "$cword" in
1344 __gitcomp "create list-heads verify unbundle"
1347 # looking for a file
1350 case "$cmd" in
1351 create)
1352 __git_complete_revlist
1354 esac
1356 esac
1359 _git_checkout ()
1361 __git_has_doubledash && return
1363 case "$cur" in
1364 --conflict=*)
1365 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1367 --*)
1368 __gitcomp_builtin checkout
1371 # check if --track, --no-track, or --no-guess was specified
1372 # if so, disable DWIM mode
1373 local flags="--track --no-track --no-guess" track_opt="--track"
1374 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
1375 [ -n "$(__git_find_on_cmdline "$flags")" ]; then
1376 track_opt=''
1378 __git_complete_refs $track_opt
1380 esac
1383 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1385 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1387 _git_cherry_pick ()
1389 __git_find_repo_path
1390 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1391 __gitcomp "$__git_cherry_pick_inprogress_options"
1392 return
1395 __git_complete_strategy && return
1397 case "$cur" in
1398 --*)
1399 __gitcomp_builtin cherry-pick "" \
1400 "$__git_cherry_pick_inprogress_options"
1403 __git_complete_refs
1405 esac
1408 _git_clean ()
1410 case "$cur" in
1411 --*)
1412 __gitcomp_builtin clean
1413 return
1415 esac
1417 # XXX should we check for -x option ?
1418 __git_complete_index_file "--others --directory"
1421 _git_clone ()
1423 case "$prev" in
1424 -c|--config)
1425 __git_complete_config_variable_name_and_value
1426 return
1428 esac
1429 case "$cur" in
1430 --config=*)
1431 __git_complete_config_variable_name_and_value \
1432 --cur="${cur##--config=}"
1433 return
1435 --*)
1436 __gitcomp_builtin clone
1437 return
1439 esac
1442 __git_untracked_file_modes="all no normal"
1444 _git_commit ()
1446 case "$prev" in
1447 -c|-C)
1448 __git_complete_refs
1449 return
1451 esac
1453 case "$cur" in
1454 --cleanup=*)
1455 __gitcomp "default scissors strip verbatim whitespace
1456 " "" "${cur##--cleanup=}"
1457 return
1459 --reuse-message=*|--reedit-message=*|\
1460 --fixup=*|--squash=*)
1461 __git_complete_refs --cur="${cur#*=}"
1462 return
1464 --untracked-files=*)
1465 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1466 return
1468 --*)
1469 __gitcomp_builtin commit
1470 return
1471 esac
1473 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1474 __git_complete_index_file "--committable"
1475 else
1476 # This is the first commit
1477 __git_complete_index_file "--cached"
1481 _git_describe ()
1483 case "$cur" in
1484 --*)
1485 __gitcomp_builtin describe
1486 return
1487 esac
1488 __git_complete_refs
1491 __git_diff_algorithms="myers minimal patience histogram"
1493 __git_diff_submodule_formats="diff log short"
1495 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1497 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1498 ignore-all-space allow-indentation-change"
1500 __git_diff_common_options="--stat --numstat --shortstat --summary
1501 --patch-with-stat --name-only --name-status --color
1502 --no-color --color-words --no-renames --check
1503 --color-moved --color-moved= --no-color-moved
1504 --color-moved-ws= --no-color-moved-ws
1505 --full-index --binary --abbrev --diff-filter=
1506 --find-copies-harder --ignore-cr-at-eol
1507 --text --ignore-space-at-eol --ignore-space-change
1508 --ignore-all-space --ignore-blank-lines --exit-code
1509 --quiet --ext-diff --no-ext-diff
1510 --no-prefix --src-prefix= --dst-prefix=
1511 --inter-hunk-context=
1512 --patience --histogram --minimal
1513 --raw --word-diff --word-diff-regex=
1514 --dirstat --dirstat= --dirstat-by-file
1515 --dirstat-by-file= --cumulative
1516 --diff-algorithm=
1517 --submodule --submodule= --ignore-submodules
1518 --indent-heuristic --no-indent-heuristic
1519 --textconv --no-textconv
1522 _git_diff ()
1524 __git_has_doubledash && return
1526 case "$cur" in
1527 --diff-algorithm=*)
1528 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1529 return
1531 --submodule=*)
1532 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1533 return
1535 --color-moved=*)
1536 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1537 return
1539 --color-moved-ws=*)
1540 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1541 return
1543 --*)
1544 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1545 --base --ours --theirs --no-index
1546 $__git_diff_common_options
1548 return
1550 esac
1551 __git_complete_revlist_file
1554 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1555 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc
1556 codecompare smerge
1559 _git_difftool ()
1561 __git_has_doubledash && return
1563 case "$cur" in
1564 --tool=*)
1565 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1566 return
1568 --*)
1569 __gitcomp_builtin difftool "$__git_diff_common_options
1570 --base --cached --ours --theirs
1571 --pickaxe-all --pickaxe-regex
1572 --relative --staged
1574 return
1576 esac
1577 __git_complete_revlist_file
1580 __git_fetch_recurse_submodules="yes on-demand no"
1582 _git_fetch ()
1584 case "$cur" in
1585 --recurse-submodules=*)
1586 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1587 return
1589 --filter=*)
1590 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1591 return
1593 --*)
1594 __gitcomp_builtin fetch
1595 return
1597 esac
1598 __git_complete_remote_or_refspec
1601 __git_format_patch_extra_options="
1602 --full-index --not --all --no-prefix --src-prefix=
1603 --dst-prefix= --notes
1606 _git_format_patch ()
1608 case "$cur" in
1609 --thread=*)
1610 __gitcomp "
1611 deep shallow
1612 " "" "${cur##--thread=}"
1613 return
1615 --*)
1616 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1617 return
1619 esac
1620 __git_complete_revlist
1623 _git_fsck ()
1625 case "$cur" in
1626 --*)
1627 __gitcomp_builtin fsck
1628 return
1630 esac
1633 _git_gitk ()
1635 _gitk
1638 # Lists matching symbol names from a tag (as in ctags) file.
1639 # 1: List symbol names matching this word.
1640 # 2: The tag file to list symbol names from.
1641 # 3: A prefix to be added to each listed symbol name (optional).
1642 # 4: A suffix to be appended to each listed symbol name (optional).
1643 __git_match_ctag () {
1644 awk -v pfx="${3-}" -v sfx="${4-}" "
1645 /^${1//\//\\/}/ { print pfx \$1 sfx }
1646 " "$2"
1649 # Complete symbol names from a tag file.
1650 # Usage: __git_complete_symbol [<option>]...
1651 # --tags=<file>: The tag file to list symbol names from instead of the
1652 # default "tags".
1653 # --pfx=<prefix>: A prefix to be added to each symbol name.
1654 # --cur=<word>: The current symbol name to be completed. Defaults to
1655 # the current word to be completed.
1656 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1657 # of the default space.
1658 __git_complete_symbol () {
1659 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1661 while test $# != 0; do
1662 case "$1" in
1663 --tags=*) tags="${1##--tags=}" ;;
1664 --pfx=*) pfx="${1##--pfx=}" ;;
1665 --cur=*) cur_="${1##--cur=}" ;;
1666 --sfx=*) sfx="${1##--sfx=}" ;;
1667 *) return 1 ;;
1668 esac
1669 shift
1670 done
1672 if test -r "$tags"; then
1673 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1677 _git_grep ()
1679 __git_has_doubledash && return
1681 case "$cur" in
1682 --*)
1683 __gitcomp_builtin grep
1684 return
1686 esac
1688 case "$cword,$prev" in
1689 2,*|*,-*)
1690 __git_complete_symbol && return
1692 esac
1694 __git_complete_refs
1697 _git_help ()
1699 case "$cur" in
1700 --*)
1701 __gitcomp_builtin help
1702 return
1704 esac
1705 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1706 then
1707 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1708 else
1709 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1713 _git_init ()
1715 case "$cur" in
1716 --shared=*)
1717 __gitcomp "
1718 false true umask group all world everybody
1719 " "" "${cur##--shared=}"
1720 return
1722 --*)
1723 __gitcomp_builtin init
1724 return
1726 esac
1729 _git_ls_files ()
1731 case "$cur" in
1732 --*)
1733 __gitcomp_builtin ls-files
1734 return
1736 esac
1738 # XXX ignore options like --modified and always suggest all cached
1739 # files.
1740 __git_complete_index_file "--cached"
1743 _git_ls_remote ()
1745 case "$cur" in
1746 --*)
1747 __gitcomp_builtin ls-remote
1748 return
1750 esac
1751 __gitcomp_nl "$(__git_remotes)"
1754 _git_ls_tree ()
1756 case "$cur" in
1757 --*)
1758 __gitcomp_builtin ls-tree
1759 return
1761 esac
1763 __git_complete_file
1766 # Options that go well for log, shortlog and gitk
1767 __git_log_common_options="
1768 --not --all
1769 --branches --tags --remotes
1770 --first-parent --merges --no-merges
1771 --max-count=
1772 --max-age= --since= --after=
1773 --min-age= --until= --before=
1774 --min-parents= --max-parents=
1775 --no-min-parents --no-max-parents
1777 # Options that go well for log and gitk (not shortlog)
1778 __git_log_gitk_options="
1779 --dense --sparse --full-history
1780 --simplify-merges --simplify-by-decoration
1781 --left-right --notes --no-notes
1783 # Options that go well for log and shortlog (not gitk)
1784 __git_log_shortlog_options="
1785 --author= --committer= --grep=
1786 --all-match --invert-grep
1789 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1790 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1792 _git_log ()
1794 __git_has_doubledash && return
1795 __git_find_repo_path
1797 local merge=""
1798 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1799 merge="--merge"
1801 case "$prev,$cur" in
1802 -L,:*:*)
1803 return # fall back to Bash filename completion
1805 -L,:*)
1806 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1807 return
1809 -G,*|-S,*)
1810 __git_complete_symbol
1811 return
1813 esac
1814 case "$cur" in
1815 --pretty=*|--format=*)
1816 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1817 " "" "${cur#*=}"
1818 return
1820 --date=*)
1821 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1822 return
1824 --decorate=*)
1825 __gitcomp "full short no" "" "${cur##--decorate=}"
1826 return
1828 --diff-algorithm=*)
1829 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1830 return
1832 --submodule=*)
1833 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1834 return
1836 --no-walk=*)
1837 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
1838 return
1840 --*)
1841 __gitcomp "
1842 $__git_log_common_options
1843 $__git_log_shortlog_options
1844 $__git_log_gitk_options
1845 --root --topo-order --date-order --reverse
1846 --follow --full-diff
1847 --abbrev-commit --no-abbrev-commit --abbrev=
1848 --relative-date --date=
1849 --pretty= --format= --oneline
1850 --show-signature
1851 --cherry-mark
1852 --cherry-pick
1853 --graph
1854 --decorate --decorate= --no-decorate
1855 --walk-reflogs
1856 --no-walk --no-walk= --do-walk
1857 --parents --children
1858 --expand-tabs --expand-tabs= --no-expand-tabs
1859 --patch
1860 $merge
1861 $__git_diff_common_options
1862 --pickaxe-all --pickaxe-regex
1863 --patch --no-patch
1865 return
1867 -L:*:*)
1868 return # fall back to Bash filename completion
1870 -L:*)
1871 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
1872 return
1874 -G*)
1875 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
1876 return
1878 -S*)
1879 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
1880 return
1882 esac
1883 __git_complete_revlist
1886 _git_merge ()
1888 __git_complete_strategy && return
1890 case "$cur" in
1891 --*)
1892 __gitcomp_builtin merge
1893 return
1894 esac
1895 __git_complete_refs
1898 _git_mergetool ()
1900 case "$cur" in
1901 --tool=*)
1902 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
1903 return
1905 --*)
1906 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
1907 return
1909 esac
1912 _git_merge_base ()
1914 case "$cur" in
1915 --*)
1916 __gitcomp_builtin merge-base
1917 return
1919 esac
1920 __git_complete_refs
1923 _git_mv ()
1925 case "$cur" in
1926 --*)
1927 __gitcomp_builtin mv
1928 return
1930 esac
1932 if [ $(__git_count_arguments "mv") -gt 0 ]; then
1933 # We need to show both cached and untracked files (including
1934 # empty directories) since this may not be the last argument.
1935 __git_complete_index_file "--cached --others --directory"
1936 else
1937 __git_complete_index_file "--cached"
1941 _git_notes ()
1943 local subcommands='add append copy edit get-ref list merge prune remove show'
1944 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1946 case "$subcommand,$cur" in
1947 ,--*)
1948 __gitcomp_builtin notes
1951 case "$prev" in
1952 --ref)
1953 __git_complete_refs
1956 __gitcomp "$subcommands --ref"
1958 esac
1960 *,--reuse-message=*|*,--reedit-message=*)
1961 __git_complete_refs --cur="${cur#*=}"
1963 *,--*)
1964 __gitcomp_builtin notes_$subcommand
1966 prune,*|get-ref,*)
1967 # this command does not take a ref, do not complete it
1970 case "$prev" in
1971 -m|-F)
1974 __git_complete_refs
1976 esac
1978 esac
1981 _git_pull ()
1983 __git_complete_strategy && return
1985 case "$cur" in
1986 --recurse-submodules=*)
1987 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1988 return
1990 --*)
1991 __gitcomp_builtin pull
1993 return
1995 esac
1996 __git_complete_remote_or_refspec
1999 __git_push_recurse_submodules="check on-demand only"
2001 __git_complete_force_with_lease ()
2003 local cur_=$1
2005 case "$cur_" in
2006 --*=)
2008 *:*)
2009 __git_complete_refs --cur="${cur_#*:}"
2012 __git_complete_refs --cur="$cur_"
2014 esac
2017 _git_push ()
2019 case "$prev" in
2020 --repo)
2021 __gitcomp_nl "$(__git_remotes)"
2022 return
2024 --recurse-submodules)
2025 __gitcomp "$__git_push_recurse_submodules"
2026 return
2028 esac
2029 case "$cur" in
2030 --repo=*)
2031 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2032 return
2034 --recurse-submodules=*)
2035 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2036 return
2038 --force-with-lease=*)
2039 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2040 return
2042 --*)
2043 __gitcomp_builtin push
2044 return
2046 esac
2047 __git_complete_remote_or_refspec
2050 _git_range_diff ()
2052 case "$cur" in
2053 --*)
2054 __gitcomp "
2055 --creation-factor= --no-dual-color
2056 $__git_diff_common_options
2058 return
2060 esac
2061 __git_complete_revlist
2064 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2065 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2067 _git_rebase ()
2069 __git_find_repo_path
2070 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2071 __gitcomp "$__git_rebase_interactive_inprogress_options"
2072 return
2073 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2074 [ -d "$__git_repo_path"/rebase-merge ]; then
2075 __gitcomp "$__git_rebase_inprogress_options"
2076 return
2078 __git_complete_strategy && return
2079 case "$cur" in
2080 --whitespace=*)
2081 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2082 return
2084 --onto=*)
2085 __git_complete_refs --cur="${cur##--onto=}"
2086 return
2088 --*)
2089 __gitcomp_builtin rebase "" \
2090 "$__git_rebase_interactive_inprogress_options"
2092 return
2093 esac
2094 __git_complete_refs
2097 _git_reflog ()
2099 local subcommands="show delete expire"
2100 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2102 if [ -z "$subcommand" ]; then
2103 __gitcomp "$subcommands"
2104 else
2105 __git_complete_refs
2109 __git_send_email_confirm_options="always never auto cc compose"
2110 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2112 _git_send_email ()
2114 case "$prev" in
2115 --to|--cc|--bcc|--from)
2116 __gitcomp "$(__git send-email --dump-aliases)"
2117 return
2119 esac
2121 case "$cur" in
2122 --confirm=*)
2123 __gitcomp "
2124 $__git_send_email_confirm_options
2125 " "" "${cur##--confirm=}"
2126 return
2128 --suppress-cc=*)
2129 __gitcomp "
2130 $__git_send_email_suppresscc_options
2131 " "" "${cur##--suppress-cc=}"
2133 return
2135 --smtp-encryption=*)
2136 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2137 return
2139 --thread=*)
2140 __gitcomp "
2141 deep shallow
2142 " "" "${cur##--thread=}"
2143 return
2145 --to=*|--cc=*|--bcc=*|--from=*)
2146 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2147 return
2149 --*)
2150 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2151 --compose --confirm= --dry-run --envelope-sender
2152 --from --identity
2153 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2154 --no-suppress-from --no-thread --quiet --reply-to
2155 --signed-off-by-cc --smtp-pass --smtp-server
2156 --smtp-server-port --smtp-encryption= --smtp-user
2157 --subject --suppress-cc= --suppress-from --thread --to
2158 --validate --no-validate
2159 $__git_format_patch_extra_options"
2160 return
2162 esac
2163 __git_complete_revlist
2166 _git_stage ()
2168 _git_add
2171 _git_status ()
2173 local complete_opt
2174 local untracked_state
2176 case "$cur" in
2177 --ignore-submodules=*)
2178 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2179 return
2181 --untracked-files=*)
2182 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2183 return
2185 --column=*)
2186 __gitcomp "
2187 always never auto column row plain dense nodense
2188 " "" "${cur##--column=}"
2189 return
2191 --*)
2192 __gitcomp_builtin status
2193 return
2195 esac
2197 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2198 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2200 case "$untracked_state" in
2202 # --ignored option does not matter
2203 complete_opt=
2205 all|normal|*)
2206 complete_opt="--cached --directory --no-empty-directory --others"
2208 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2209 complete_opt="$complete_opt --ignored --exclude=*"
2212 esac
2214 __git_complete_index_file "$complete_opt"
2217 _git_switch ()
2219 case "$cur" in
2220 --conflict=*)
2221 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2223 --*)
2224 __gitcomp_builtin switch
2227 # check if --track, --no-track, or --no-guess was specified
2228 # if so, disable DWIM mode
2229 local track_opt="--track" only_local_ref=n
2230 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
2231 [ -n "$(__git_find_on_cmdline "--track --no-track --no-guess")" ]; then
2232 track_opt=''
2234 # explicit --guess enables DWIM mode regardless of
2235 # $GIT_COMPLETION_CHECKOUT_NO_GUESS
2236 if [ -n "$(__git_find_on_cmdline "--guess")" ]; then
2237 track_opt='--track'
2239 if [ -z "$(__git_find_on_cmdline "-d --detach")" ]; then
2240 only_local_ref=y
2241 else
2242 # --guess --detach is invalid combination, no
2243 # dwim will be done when --detach is specified
2244 track_opt=
2246 if [ $only_local_ref = y -a -z "$track_opt" ]; then
2247 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
2248 else
2249 __git_complete_refs $track_opt
2252 esac
2255 __git_config_get_set_variables ()
2257 local prevword word config_file= c=$cword
2258 while [ $c -gt 1 ]; do
2259 word="${words[c]}"
2260 case "$word" in
2261 --system|--global|--local|--file=*)
2262 config_file="$word"
2263 break
2265 -f|--file)
2266 config_file="$word $prevword"
2267 break
2269 esac
2270 prevword=$word
2271 c=$((--c))
2272 done
2274 __git config $config_file --name-only --list
2277 __git_config_vars=
2278 __git_compute_config_vars ()
2280 test -n "$__git_config_vars" ||
2281 __git_config_vars="$(git help --config-for-completion | sort -u)"
2284 # Completes possible values of various configuration variables.
2286 # Usage: __git_complete_config_variable_value [<option>]...
2287 # --varname=<word>: The name of the configuration variable whose value is
2288 # to be completed. Defaults to the previous word on the
2289 # command line.
2290 # --cur=<word>: The current value to be completed. Defaults to the current
2291 # word to be completed.
2292 __git_complete_config_variable_value ()
2294 local varname="$prev" cur_="$cur"
2296 while test $# != 0; do
2297 case "$1" in
2298 --varname=*) varname="${1##--varname=}" ;;
2299 --cur=*) cur_="${1##--cur=}" ;;
2300 *) return 1 ;;
2301 esac
2302 shift
2303 done
2305 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2306 varname="${varname,,}"
2307 else
2308 varname="$(echo "$varname" |tr A-Z a-z)"
2311 case "$varname" in
2312 branch.*.remote|branch.*.pushremote)
2313 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2314 return
2316 branch.*.merge)
2317 __git_complete_refs --cur="$cur_"
2318 return
2320 branch.*.rebase)
2321 __gitcomp "false true merges preserve interactive" "" "$cur_"
2322 return
2324 remote.pushdefault)
2325 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2326 return
2328 remote.*.fetch)
2329 local remote="${varname#remote.}"
2330 remote="${remote%.fetch}"
2331 if [ -z "$cur_" ]; then
2332 __gitcomp_nl "refs/heads/" "" "" ""
2333 return
2335 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2336 return
2338 remote.*.push)
2339 local remote="${varname#remote.}"
2340 remote="${remote%.push}"
2341 __gitcomp_nl "$(__git for-each-ref \
2342 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2343 return
2345 pull.twohead|pull.octopus)
2346 __git_compute_merge_strategies
2347 __gitcomp "$__git_merge_strategies" "" "$cur_"
2348 return
2350 color.pager)
2351 __gitcomp "false true" "" "$cur_"
2352 return
2354 color.*.*)
2355 __gitcomp "
2356 normal black red green yellow blue magenta cyan white
2357 bold dim ul blink reverse
2358 " "" "$cur_"
2359 return
2361 color.*)
2362 __gitcomp "false true always never auto" "" "$cur_"
2363 return
2365 diff.submodule)
2366 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2367 return
2369 help.format)
2370 __gitcomp "man info web html" "" "$cur_"
2371 return
2373 log.date)
2374 __gitcomp "$__git_log_date_formats" "" "$cur_"
2375 return
2377 sendemail.aliasfiletype)
2378 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2379 return
2381 sendemail.confirm)
2382 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2383 return
2385 sendemail.suppresscc)
2386 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2387 return
2389 sendemail.transferencoding)
2390 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2391 return
2393 *.*)
2394 return
2396 esac
2399 # Completes configuration sections, subsections, variable names.
2401 # Usage: __git_complete_config_variable_name [<option>]...
2402 # --cur=<word>: The current configuration section/variable name to be
2403 # completed. Defaults to the current word to be completed.
2404 # --sfx=<suffix>: A suffix to be appended to each fully completed
2405 # configuration variable name (but not to sections or
2406 # subsections) instead of the default space.
2407 __git_complete_config_variable_name ()
2409 local cur_="$cur" sfx
2411 while test $# != 0; do
2412 case "$1" in
2413 --cur=*) cur_="${1##--cur=}" ;;
2414 --sfx=*) sfx="${1##--sfx=}" ;;
2415 *) return 1 ;;
2416 esac
2417 shift
2418 done
2420 case "$cur_" in
2421 branch.*.*)
2422 local pfx="${cur_%.*}."
2423 cur_="${cur_##*.}"
2424 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2425 return
2427 branch.*)
2428 local pfx="${cur%.*}."
2429 cur_="${cur#*.}"
2430 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2431 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2432 return
2434 guitool.*.*)
2435 local pfx="${cur_%.*}."
2436 cur_="${cur_##*.}"
2437 __gitcomp "
2438 argPrompt cmd confirm needsFile noConsole noRescan
2439 prompt revPrompt revUnmerged title
2440 " "$pfx" "$cur_" "$sfx"
2441 return
2443 difftool.*.*)
2444 local pfx="${cur_%.*}."
2445 cur_="${cur_##*.}"
2446 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2447 return
2449 man.*.*)
2450 local pfx="${cur_%.*}."
2451 cur_="${cur_##*.}"
2452 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2453 return
2455 mergetool.*.*)
2456 local pfx="${cur_%.*}."
2457 cur_="${cur_##*.}"
2458 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2459 return
2461 pager.*)
2462 local pfx="${cur_%.*}."
2463 cur_="${cur_#*.}"
2464 __git_compute_all_commands
2465 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2466 return
2468 remote.*.*)
2469 local pfx="${cur_%.*}."
2470 cur_="${cur_##*.}"
2471 __gitcomp "
2472 url proxy fetch push mirror skipDefaultUpdate
2473 receivepack uploadpack tagOpt pushurl
2474 " "$pfx" "$cur_" "$sfx"
2475 return
2477 remote.*)
2478 local pfx="${cur_%.*}."
2479 cur_="${cur_#*.}"
2480 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2481 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2482 return
2484 url.*.*)
2485 local pfx="${cur_%.*}."
2486 cur_="${cur_##*.}"
2487 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2488 return
2490 *.*)
2491 __git_compute_config_vars
2492 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2495 __git_compute_config_vars
2496 __gitcomp "$(echo "$__git_config_vars" |
2497 awk -F . '{
2498 sections[$1] = 1
2500 END {
2501 for (s in sections)
2502 print s "."
2504 ')" "" "$cur_"
2506 esac
2509 # Completes '='-separated configuration sections/variable names and values
2510 # for 'git -c section.name=value'.
2512 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2513 # --cur=<word>: The current configuration section/variable name/value to be
2514 # completed. Defaults to the current word to be completed.
2515 __git_complete_config_variable_name_and_value ()
2517 local cur_="$cur"
2519 while test $# != 0; do
2520 case "$1" in
2521 --cur=*) cur_="${1##--cur=}" ;;
2522 *) return 1 ;;
2523 esac
2524 shift
2525 done
2527 case "$cur_" in
2528 *=*)
2529 __git_complete_config_variable_value \
2530 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2533 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2535 esac
2538 _git_config ()
2540 case "$prev" in
2541 --get|--get-all|--unset|--unset-all)
2542 __gitcomp_nl "$(__git_config_get_set_variables)"
2543 return
2545 *.*)
2546 __git_complete_config_variable_value
2547 return
2549 esac
2550 case "$cur" in
2551 --*)
2552 __gitcomp_builtin config
2555 __git_complete_config_variable_name
2557 esac
2560 _git_remote ()
2562 local subcommands="
2563 add rename remove set-head set-branches
2564 get-url set-url show prune update
2566 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2567 if [ -z "$subcommand" ]; then
2568 case "$cur" in
2569 --*)
2570 __gitcomp_builtin remote
2573 __gitcomp "$subcommands"
2575 esac
2576 return
2579 case "$subcommand,$cur" in
2580 add,--*)
2581 __gitcomp_builtin remote_add
2583 add,*)
2585 set-head,--*)
2586 __gitcomp_builtin remote_set-head
2588 set-branches,--*)
2589 __gitcomp_builtin remote_set-branches
2591 set-head,*|set-branches,*)
2592 __git_complete_remote_or_refspec
2594 update,--*)
2595 __gitcomp_builtin remote_update
2597 update,*)
2598 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2600 set-url,--*)
2601 __gitcomp_builtin remote_set-url
2603 get-url,--*)
2604 __gitcomp_builtin remote_get-url
2606 prune,--*)
2607 __gitcomp_builtin remote_prune
2610 __gitcomp_nl "$(__git_remotes)"
2612 esac
2615 _git_replace ()
2617 case "$cur" in
2618 --format=*)
2619 __gitcomp "short medium long" "" "${cur##--format=}"
2620 return
2622 --*)
2623 __gitcomp_builtin replace
2624 return
2626 esac
2627 __git_complete_refs
2630 _git_rerere ()
2632 local subcommands="clear forget diff remaining status gc"
2633 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2634 if test -z "$subcommand"
2635 then
2636 __gitcomp "$subcommands"
2637 return
2641 _git_reset ()
2643 __git_has_doubledash && return
2645 case "$cur" in
2646 --*)
2647 __gitcomp_builtin reset
2648 return
2650 esac
2651 __git_complete_refs
2654 _git_restore ()
2656 case "$cur" in
2657 --conflict=*)
2658 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2660 --source=*)
2661 __git_complete_refs --cur="${cur##--source=}"
2663 --*)
2664 __gitcomp_builtin restore
2666 esac
2669 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2671 _git_revert ()
2673 __git_find_repo_path
2674 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2675 __gitcomp "$__git_revert_inprogress_options"
2676 return
2678 __git_complete_strategy && return
2679 case "$cur" in
2680 --*)
2681 __gitcomp_builtin revert "" \
2682 "$__git_revert_inprogress_options"
2683 return
2685 esac
2686 __git_complete_refs
2689 _git_rm ()
2691 case "$cur" in
2692 --*)
2693 __gitcomp_builtin rm
2694 return
2696 esac
2698 __git_complete_index_file "--cached"
2701 _git_shortlog ()
2703 __git_has_doubledash && return
2705 case "$cur" in
2706 --*)
2707 __gitcomp "
2708 $__git_log_common_options
2709 $__git_log_shortlog_options
2710 --numbered --summary --email
2712 return
2714 esac
2715 __git_complete_revlist
2718 _git_show ()
2720 __git_has_doubledash && return
2722 case "$cur" in
2723 --pretty=*|--format=*)
2724 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2725 " "" "${cur#*=}"
2726 return
2728 --diff-algorithm=*)
2729 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2730 return
2732 --submodule=*)
2733 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2734 return
2736 --*)
2737 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2738 --oneline --show-signature --patch
2739 --expand-tabs --expand-tabs= --no-expand-tabs
2740 $__git_diff_common_options
2742 return
2744 esac
2745 __git_complete_revlist_file
2748 _git_show_branch ()
2750 case "$cur" in
2751 --*)
2752 __gitcomp_builtin show-branch
2753 return
2755 esac
2756 __git_complete_revlist
2759 _git_sparse_checkout ()
2761 local subcommands="list init set disable"
2762 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2763 if [ -z "$subcommand" ]; then
2764 __gitcomp "$subcommands"
2765 return
2768 case "$subcommand,$cur" in
2769 init,--*)
2770 __gitcomp "--cone"
2772 set,--*)
2773 __gitcomp "--stdin"
2777 esac
2780 _git_stash ()
2782 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2783 local subcommands='push list show apply clear drop pop create branch'
2784 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2785 if [ -n "$(__git_find_on_cmdline "-p")" ]; then
2786 subcommand="push"
2788 if [ -z "$subcommand" ]; then
2789 case "$cur" in
2790 --*)
2791 __gitcomp "$save_opts"
2793 sa*)
2794 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2795 __gitcomp "save"
2799 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2800 __gitcomp "$subcommands"
2803 esac
2804 else
2805 case "$subcommand,$cur" in
2806 push,--*)
2807 __gitcomp "$save_opts --message"
2809 save,--*)
2810 __gitcomp "$save_opts"
2812 apply,--*|pop,--*)
2813 __gitcomp "--index --quiet"
2815 drop,--*)
2816 __gitcomp "--quiet"
2818 list,--*)
2819 __gitcomp "--name-status --oneline --patch-with-stat"
2821 show,--*|branch,--*)
2823 branch,*)
2824 if [ $cword -eq 3 ]; then
2825 __git_complete_refs
2826 else
2827 __gitcomp_nl "$(__git stash list \
2828 | sed -n -e 's/:.*//p')"
2831 show,*|apply,*|drop,*|pop,*)
2832 __gitcomp_nl "$(__git stash list \
2833 | sed -n -e 's/:.*//p')"
2837 esac
2841 _git_submodule ()
2843 __git_has_doubledash && return
2845 local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
2846 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2847 if [ -z "$subcommand" ]; then
2848 case "$cur" in
2849 --*)
2850 __gitcomp "--quiet"
2853 __gitcomp "$subcommands"
2855 esac
2856 return
2859 case "$subcommand,$cur" in
2860 add,--*)
2861 __gitcomp "--branch --force --name --reference --depth"
2863 status,--*)
2864 __gitcomp "--cached --recursive"
2866 deinit,--*)
2867 __gitcomp "--force --all"
2869 update,--*)
2870 __gitcomp "
2871 --init --remote --no-fetch
2872 --recommend-shallow --no-recommend-shallow
2873 --force --rebase --merge --reference --depth --recursive --jobs
2876 set-branch,--*)
2877 __gitcomp "--default --branch"
2879 summary,--*)
2880 __gitcomp "--cached --files --summary-limit"
2882 foreach,--*|sync,--*)
2883 __gitcomp "--recursive"
2887 esac
2890 _git_svn ()
2892 local subcommands="
2893 init fetch clone rebase dcommit log find-rev
2894 set-tree commit-diff info create-ignore propget
2895 proplist show-ignore show-externals branch tag blame
2896 migrate mkdirs reset gc
2898 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2899 if [ -z "$subcommand" ]; then
2900 __gitcomp "$subcommands"
2901 else
2902 local remote_opts="--username= --config-dir= --no-auth-cache"
2903 local fc_opts="
2904 --follow-parent --authors-file= --repack=
2905 --no-metadata --use-svm-props --use-svnsync-props
2906 --log-window-size= --no-checkout --quiet
2907 --repack-flags --use-log-author --localtime
2908 --add-author-from
2909 --recursive
2910 --ignore-paths= --include-paths= $remote_opts
2912 local init_opts="
2913 --template= --shared= --trunk= --tags=
2914 --branches= --stdlayout --minimize-url
2915 --no-metadata --use-svm-props --use-svnsync-props
2916 --rewrite-root= --prefix= $remote_opts
2918 local cmt_opts="
2919 --edit --rmdir --find-copies-harder --copy-similarity=
2922 case "$subcommand,$cur" in
2923 fetch,--*)
2924 __gitcomp "--revision= --fetch-all $fc_opts"
2926 clone,--*)
2927 __gitcomp "--revision= $fc_opts $init_opts"
2929 init,--*)
2930 __gitcomp "$init_opts"
2932 dcommit,--*)
2933 __gitcomp "
2934 --merge --strategy= --verbose --dry-run
2935 --fetch-all --no-rebase --commit-url
2936 --revision --interactive $cmt_opts $fc_opts
2939 set-tree,--*)
2940 __gitcomp "--stdin $cmt_opts $fc_opts"
2942 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
2943 show-externals,--*|mkdirs,--*)
2944 __gitcomp "--revision="
2946 log,--*)
2947 __gitcomp "
2948 --limit= --revision= --verbose --incremental
2949 --oneline --show-commit --non-recursive
2950 --authors-file= --color
2953 rebase,--*)
2954 __gitcomp "
2955 --merge --verbose --strategy= --local
2956 --fetch-all --dry-run $fc_opts
2959 commit-diff,--*)
2960 __gitcomp "--message= --file= --revision= $cmt_opts"
2962 info,--*)
2963 __gitcomp "--url"
2965 branch,--*)
2966 __gitcomp "--dry-run --message --tag"
2968 tag,--*)
2969 __gitcomp "--dry-run --message"
2971 blame,--*)
2972 __gitcomp "--git-format"
2974 migrate,--*)
2975 __gitcomp "
2976 --config-dir= --ignore-paths= --minimize
2977 --no-auth-cache --username=
2980 reset,--*)
2981 __gitcomp "--revision= --parent"
2985 esac
2989 _git_tag ()
2991 local i c=1 f=0
2992 while [ $c -lt $cword ]; do
2993 i="${words[c]}"
2994 case "$i" in
2995 -d|--delete|-v|--verify)
2996 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
2997 return
3002 esac
3003 ((c++))
3004 done
3006 case "$prev" in
3007 -m|-F)
3009 -*|tag)
3010 if [ $f = 1 ]; then
3011 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3015 __git_complete_refs
3017 esac
3019 case "$cur" in
3020 --*)
3021 __gitcomp_builtin tag
3023 esac
3026 _git_whatchanged ()
3028 _git_log
3031 __git_complete_worktree_paths ()
3033 local IFS=$'\n'
3034 __gitcomp_nl "$(git worktree list --porcelain |
3035 # Skip the first entry: it's the path of the main worktree,
3036 # which can't be moved, removed, locked, etc.
3037 sed -n -e '2,$ s/^worktree //p')"
3040 _git_worktree ()
3042 local subcommands="add list lock move prune remove unlock"
3043 local subcommand subcommand_idx
3045 subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3046 subcommand_idx="${subcommand% *}"
3047 subcommand="${subcommand#* }"
3049 case "$subcommand,$cur" in
3051 __gitcomp "$subcommands"
3053 *,--*)
3054 __gitcomp_builtin worktree_$subcommand
3056 add,*) # usage: git worktree add [<options>] <path> [<commit-ish>]
3057 # Here we are not completing an --option, it's either the
3058 # path or a ref.
3059 case "$prev" in
3060 -b|-B) # Complete refs for branch to be created/reseted.
3061 __git_complete_refs
3063 -*) # The previous word is an -o|--option without an
3064 # unstuck argument: have to complete the path for
3065 # the new worktree, so don't list anything, but let
3066 # Bash fall back to filename completion.
3068 *) # The previous word is not an --option, so it must
3069 # be either the 'add' subcommand, the unstuck
3070 # argument of an option (e.g. branch for -b|-B), or
3071 # the path for the new worktree.
3072 if [ $cword -eq $((subcommand_idx+1)) ]; then
3073 # Right after the 'add' subcommand: have to
3074 # complete the path, so fall back to Bash
3075 # filename completion.
3077 else
3078 case "${words[cword-2]}" in
3079 -b|-B) # After '-b <branch>': have to
3080 # complete the path, so fall back
3081 # to Bash filename completion.
3083 *) # After the path: have to complete
3084 # the ref to be checked out.
3085 __git_complete_refs
3087 esac
3090 esac
3092 lock,*|remove,*|unlock,*)
3093 __git_complete_worktree_paths
3095 move,*)
3096 if [ $cword -eq $((subcommand_idx+1)) ]; then
3097 # The first parameter must be an existing working
3098 # tree to be moved.
3099 __git_complete_worktree_paths
3100 else
3101 # The second parameter is the destination: it could
3102 # be any path, so don't list anything, but let Bash
3103 # fall back to filename completion.
3107 esac
3110 __git_complete_common () {
3111 local command="$1"
3113 case "$cur" in
3114 --*)
3115 __gitcomp_builtin "$command"
3117 esac
3120 __git_cmds_with_parseopt_helper=
3121 __git_support_parseopt_helper () {
3122 test -n "$__git_cmds_with_parseopt_helper" ||
3123 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3125 case " $__git_cmds_with_parseopt_helper " in
3126 *" $1 "*)
3127 return 0
3130 return 1
3132 esac
3135 __git_complete_command () {
3136 local command="$1"
3137 local completion_func="_git_${command//-/_}"
3138 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3139 declare -f _completion_loader >/dev/null 2>/dev/null
3140 then
3141 _completion_loader "git-$command"
3143 if declare -f $completion_func >/dev/null 2>/dev/null
3144 then
3145 $completion_func
3146 return 0
3147 elif __git_support_parseopt_helper "$command"
3148 then
3149 __git_complete_common "$command"
3150 return 0
3151 else
3152 return 1
3156 __git_main ()
3158 local i c=1 command __git_dir __git_repo_path
3159 local __git_C_args C_args_count=0
3161 while [ $c -lt $cword ]; do
3162 i="${words[c]}"
3163 case "$i" in
3164 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3165 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3166 --bare) __git_dir="." ;;
3167 --help) command="help"; break ;;
3168 -c|--work-tree|--namespace) ((c++)) ;;
3169 -C) __git_C_args[C_args_count++]=-C
3170 ((c++))
3171 __git_C_args[C_args_count++]="${words[c]}"
3173 -*) ;;
3174 *) command="$i"; break ;;
3175 esac
3176 ((c++))
3177 done
3179 if [ -z "$command" ]; then
3180 case "$prev" in
3181 --git-dir|-C|--work-tree)
3182 # these need a path argument, let's fall back to
3183 # Bash filename completion
3184 return
3187 __git_complete_config_variable_name_and_value
3188 return
3190 --namespace)
3191 # we don't support completing these options' arguments
3192 return
3194 esac
3195 case "$cur" in
3196 --*) __gitcomp "
3197 --paginate
3198 --no-pager
3199 --git-dir=
3200 --bare
3201 --version
3202 --exec-path
3203 --exec-path=
3204 --html-path
3205 --man-path
3206 --info-path
3207 --work-tree=
3208 --namespace=
3209 --no-replace-objects
3210 --help
3214 if test -n "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3215 then
3216 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3217 else
3218 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3221 esac
3222 return
3225 __git_complete_command "$command" && return
3227 local expansion=$(__git_aliased_command "$command")
3228 if [ -n "$expansion" ]; then
3229 words[1]=$expansion
3230 __git_complete_command "$expansion"
3234 __gitk_main ()
3236 __git_has_doubledash && return
3238 local __git_repo_path
3239 __git_find_repo_path
3241 local merge=""
3242 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3243 merge="--merge"
3245 case "$cur" in
3246 --*)
3247 __gitcomp "
3248 $__git_log_common_options
3249 $__git_log_gitk_options
3250 $merge
3252 return
3254 esac
3255 __git_complete_revlist
3258 if [[ -n ${ZSH_VERSION-} ]] &&
3259 # Don't define these functions when sourced from 'git-completion.zsh',
3260 # it has its own implementations.
3261 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3262 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3264 autoload -U +X compinit && compinit
3266 __gitcomp ()
3268 emulate -L zsh
3270 local cur_="${3-$cur}"
3272 case "$cur_" in
3273 --*=)
3276 local c IFS=$' \t\n'
3277 local -a array
3278 for c in ${=1}; do
3279 c="$c${4-}"
3280 case $c in
3281 --*=*|*.) ;;
3282 *) c="$c " ;;
3283 esac
3284 array[${#array[@]}+1]="$c"
3285 done
3286 compset -P '*[=:]'
3287 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3289 esac
3292 __gitcomp_direct ()
3294 emulate -L zsh
3296 local IFS=$'\n'
3297 compset -P '*[=:]'
3298 compadd -Q -- ${=1} && _ret=0
3301 __gitcomp_nl ()
3303 emulate -L zsh
3305 local IFS=$'\n'
3306 compset -P '*[=:]'
3307 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3310 __gitcomp_file_direct ()
3312 emulate -L zsh
3314 local IFS=$'\n'
3315 compset -P '*[=:]'
3316 compadd -f -- ${=1} && _ret=0
3319 __gitcomp_file ()
3321 emulate -L zsh
3323 local IFS=$'\n'
3324 compset -P '*[=:]'
3325 compadd -p "${2-}" -f -- ${=1} && _ret=0
3328 _git ()
3330 local _ret=1 cur cword prev
3331 cur=${words[CURRENT]}
3332 prev=${words[CURRENT-1]}
3333 let cword=CURRENT-1
3334 emulate ksh -c __${service}_main
3335 let _ret && _default && _ret=0
3336 return _ret
3339 compdef _git git gitk
3340 return
3343 __git_func_wrap ()
3345 local cur words cword prev
3346 _get_comp_words_by_ref -n =: cur words cword prev
3350 # Setup completion for certain functions defined above by setting common
3351 # variables and workarounds.
3352 # This is NOT a public function; use at your own risk.
3353 __git_complete ()
3355 local wrapper="__git_wrap${2}"
3356 eval "$wrapper () { __git_func_wrap $2 ; }"
3357 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3358 || complete -o default -o nospace -F $wrapper $1
3361 # wrapper for backwards compatibility
3362 _git ()
3364 __git_wrap__git_main
3367 # wrapper for backwards compatibility
3368 _gitk ()
3370 __git_wrap__gitk_main
3373 __git_complete git __git_main
3374 __git_complete gitk __gitk_main
3376 # The following are necessary only for Cygwin, and only are needed
3377 # when the user has tab-completed the executable name and consequently
3378 # included the '.exe' suffix.
3380 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3381 __git_complete git.exe __git_main