Merge branch 'fc/completion-updates' into maint
[git/debian.git] / contrib / completion / git-completion.bash
blob8108eda1e8614728063c67f5658bccdc0e1d8ec0
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 # If you have a command that is not part of git, but you would still
33 # like completion, you can use __git_complete:
35 # __git_complete gl git_log
37 # Or if it's a main command (i.e. git or gitk):
39 # __git_complete gk gitk
41 # Compatible with bash 3.2.57.
43 # You can set the following environment variables to influence the behavior of
44 # the completion routines:
46 # GIT_COMPLETION_CHECKOUT_NO_GUESS
48 # When set to "1", do not include "DWIM" suggestions in git-checkout
49 # and git-switch completion (e.g., completing "foo" when "origin/foo"
50 # exists).
52 # GIT_COMPLETION_SHOW_ALL
54 # When set to "1" suggest all options, including options which are
55 # typically hidden (e.g. '--allow-empty' for 'git commit').
57 case "$COMP_WORDBREAKS" in
58 *:*) : great ;;
59 *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
60 esac
62 # Discovers the path to the git repository taking any '--git-dir=<path>' and
63 # '-C <path>' options into account and stores it in the $__git_repo_path
64 # variable.
65 __git_find_repo_path ()
67 if [ -n "${__git_repo_path-}" ]; then
68 # we already know where it is
69 return
72 if [ -n "${__git_C_args-}" ]; then
73 __git_repo_path="$(git "${__git_C_args[@]}" \
74 ${__git_dir:+--git-dir="$__git_dir"} \
75 rev-parse --absolute-git-dir 2>/dev/null)"
76 elif [ -n "${__git_dir-}" ]; then
77 test -d "$__git_dir" &&
78 __git_repo_path="$__git_dir"
79 elif [ -n "${GIT_DIR-}" ]; then
80 test -d "$GIT_DIR" &&
81 __git_repo_path="$GIT_DIR"
82 elif [ -d .git ]; then
83 __git_repo_path=.git
84 else
85 __git_repo_path="$(git rev-parse --git-dir 2>/dev/null)"
89 # Deprecated: use __git_find_repo_path() and $__git_repo_path instead
90 # __gitdir accepts 0 or 1 arguments (i.e., location)
91 # returns location of .git repo
92 __gitdir ()
94 if [ -z "${1-}" ]; then
95 __git_find_repo_path || return 1
96 echo "$__git_repo_path"
97 elif [ -d "$1/.git" ]; then
98 echo "$1/.git"
99 else
100 echo "$1"
104 # Runs git with all the options given as argument, respecting any
105 # '--git-dir=<path>' and '-C <path>' options present on the command line
106 __git ()
108 git ${__git_C_args:+"${__git_C_args[@]}"} \
109 ${__git_dir:+--git-dir="$__git_dir"} "$@" 2>/dev/null
112 # Removes backslash escaping, single quotes and double quotes from a word,
113 # stores the result in the variable $dequoted_word.
114 # 1: The word to dequote.
115 __git_dequote ()
117 local rest="$1" len ch
119 dequoted_word=""
121 while test -n "$rest"; do
122 len=${#dequoted_word}
123 dequoted_word="$dequoted_word${rest%%[\\\'\"]*}"
124 rest="${rest:$((${#dequoted_word}-$len))}"
126 case "${rest:0:1}" in
128 ch="${rest:1:1}"
129 case "$ch" in
130 $'\n')
133 dequoted_word="$dequoted_word$ch"
135 esac
136 rest="${rest:2}"
139 rest="${rest:1}"
140 len=${#dequoted_word}
141 dequoted_word="$dequoted_word${rest%%\'*}"
142 rest="${rest:$((${#dequoted_word}-$len+1))}"
145 rest="${rest:1}"
146 while test -n "$rest" ; do
147 len=${#dequoted_word}
148 dequoted_word="$dequoted_word${rest%%[\\\"]*}"
149 rest="${rest:$((${#dequoted_word}-$len))}"
150 case "${rest:0:1}" in
152 ch="${rest:1:1}"
153 case "$ch" in
154 \"|\\|\$|\`)
155 dequoted_word="$dequoted_word$ch"
157 $'\n')
160 dequoted_word="$dequoted_word\\$ch"
162 esac
163 rest="${rest:2}"
166 rest="${rest:1}"
167 break
169 esac
170 done
172 esac
173 done
176 # The following function is based on code from:
178 # bash_completion - programmable completion functions for bash 3.2+
180 # Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
181 # © 2009-2010, Bash Completion Maintainers
182 # <bash-completion-devel@lists.alioth.debian.org>
184 # This program is free software; you can redistribute it and/or modify
185 # it under the terms of the GNU General Public License as published by
186 # the Free Software Foundation; either version 2, or (at your option)
187 # any later version.
189 # This program is distributed in the hope that it will be useful,
190 # but WITHOUT ANY WARRANTY; without even the implied warranty of
191 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
192 # GNU General Public License for more details.
194 # You should have received a copy of the GNU General Public License
195 # along with this program; if not, see <http://www.gnu.org/licenses/>.
197 # The latest version of this software can be obtained here:
199 # http://bash-completion.alioth.debian.org/
201 # RELEASE: 2.x
203 # This function can be used to access a tokenized list of words
204 # on the command line:
206 # __git_reassemble_comp_words_by_ref '=:'
207 # if test "${words_[cword_-1]}" = -w
208 # then
209 # ...
210 # fi
212 # The argument should be a collection of characters from the list of
213 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
214 # characters.
216 # This is roughly equivalent to going back in time and setting
217 # COMP_WORDBREAKS to exclude those characters. The intent is to
218 # make option types like --date=<type> and <rev>:<path> easy to
219 # recognize by treating each shell word as a single token.
221 # It is best not to set COMP_WORDBREAKS directly because the value is
222 # shared with other completion scripts. By the time the completion
223 # function gets called, COMP_WORDS has already been populated so local
224 # changes to COMP_WORDBREAKS have no effect.
226 # Output: words_, cword_, cur_.
228 __git_reassemble_comp_words_by_ref()
230 local exclude i j first
231 # Which word separators to exclude?
232 exclude="${1//[^$COMP_WORDBREAKS]}"
233 cword_=$COMP_CWORD
234 if [ -z "$exclude" ]; then
235 words_=("${COMP_WORDS[@]}")
236 return
238 # List of word completion separators has shrunk;
239 # re-assemble words to complete.
240 for ((i=0, j=0; i < ${#COMP_WORDS[@]}; i++, j++)); do
241 # Append each nonempty word consisting of just
242 # word separator characters to the current word.
243 first=t
244 while
245 [ $i -gt 0 ] &&
246 [ -n "${COMP_WORDS[$i]}" ] &&
247 # word consists of excluded word separators
248 [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
250 # Attach to the previous token,
251 # unless the previous token is the command name.
252 if [ $j -ge 2 ] && [ -n "$first" ]; then
253 ((j--))
255 first=
256 words_[$j]=${words_[j]}${COMP_WORDS[i]}
257 if [ $i = $COMP_CWORD ]; then
258 cword_=$j
260 if (($i < ${#COMP_WORDS[@]} - 1)); then
261 ((i++))
262 else
263 # Done.
264 return
266 done
267 words_[$j]=${words_[j]}${COMP_WORDS[i]}
268 if [ $i = $COMP_CWORD ]; then
269 cword_=$j
271 done
274 if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
275 _get_comp_words_by_ref ()
277 local exclude cur_ words_ cword_
278 if [ "$1" = "-n" ]; then
279 exclude=$2
280 shift 2
282 __git_reassemble_comp_words_by_ref "$exclude"
283 cur_=${words_[cword_]}
284 while [ $# -gt 0 ]; do
285 case "$1" in
286 cur)
287 cur=$cur_
289 prev)
290 prev=${words_[$cword_-1]}
292 words)
293 words=("${words_[@]}")
295 cword)
296 cword=$cword_
298 esac
299 shift
300 done
304 # Fills the COMPREPLY array with prefiltered words without any additional
305 # processing.
306 # Callers must take care of providing only words that match the current word
307 # to be completed and adding any prefix and/or suffix (trailing space!), if
308 # necessary.
309 # 1: List of newline-separated matching completion words, complete with
310 # prefix and suffix.
311 __gitcomp_direct ()
313 local IFS=$'\n'
315 COMPREPLY=($1)
318 # Similar to __gitcomp_direct, but appends to COMPREPLY instead.
319 # Callers must take care of providing only words that match the current word
320 # to be completed and adding any prefix and/or suffix (trailing space!), if
321 # necessary.
322 # 1: List of newline-separated matching completion words, complete with
323 # prefix and suffix.
324 __gitcomp_direct_append ()
326 local IFS=$'\n'
328 COMPREPLY+=($1)
331 __gitcompappend ()
333 local x i=${#COMPREPLY[@]}
334 for x in $1; do
335 if [[ "$x" == "$3"* ]]; then
336 COMPREPLY[i++]="$2$x$4"
338 done
341 __gitcompadd ()
343 COMPREPLY=()
344 __gitcompappend "$@"
347 # Generates completion reply, appending a space to possible completion words,
348 # if necessary.
349 # It accepts 1 to 4 arguments:
350 # 1: List of possible completion words.
351 # 2: A prefix to be added to each possible completion word (optional).
352 # 3: Generate possible completion matches for this word (optional).
353 # 4: A suffix to be appended to each possible completion word (optional).
354 __gitcomp ()
356 local cur_="${3-$cur}"
358 case "$cur_" in
361 --no-*)
362 local c i=0 IFS=$' \t\n'
363 for c in $1; do
364 if [[ $c == "--" ]]; then
365 continue
367 c="$c${4-}"
368 if [[ $c == "$cur_"* ]]; then
369 case $c in
370 --*=|*.) ;;
371 *) c="$c " ;;
372 esac
373 COMPREPLY[i++]="${2-}$c"
375 done
378 local c i=0 IFS=$' \t\n'
379 for c in $1; do
380 if [[ $c == "--" ]]; then
381 c="--no-...${4-}"
382 if [[ $c == "$cur_"* ]]; then
383 COMPREPLY[i++]="${2-}$c "
385 break
387 c="$c${4-}"
388 if [[ $c == "$cur_"* ]]; then
389 case $c in
390 *=|*.) ;;
391 *) c="$c " ;;
392 esac
393 COMPREPLY[i++]="${2-}$c"
395 done
397 esac
400 # Clear the variables caching builtins' options when (re-)sourcing
401 # the completion script.
402 if [[ -n ${ZSH_VERSION-} ]]; then
403 unset ${(M)${(k)parameters[@]}:#__gitcomp_builtin_*} 2>/dev/null
404 else
405 unset $(compgen -v __gitcomp_builtin_)
408 # This function is equivalent to
410 # __gitcomp "$(git xxx --git-completion-helper) ..."
412 # except that the output is cached. Accept 1-3 arguments:
413 # 1: the git command to execute, this is also the cache key
414 # 2: extra options to be added on top (e.g. negative forms)
415 # 3: options to be excluded
416 __gitcomp_builtin ()
418 # spaces must be replaced with underscore for multi-word
419 # commands, e.g. "git remote add" becomes remote_add.
420 local cmd="$1"
421 local incl="${2-}"
422 local excl="${3-}"
424 local var=__gitcomp_builtin_"${cmd//-/_}"
425 local options
426 eval "options=\${$var-}"
428 if [ -z "$options" ]; then
429 local completion_helper
430 if [ "${GIT_COMPLETION_SHOW_ALL-}" = "1" ]; then
431 completion_helper="--git-completion-helper-all"
432 else
433 completion_helper="--git-completion-helper"
435 # leading and trailing spaces are significant to make
436 # option removal work correctly.
437 options=" $incl $(__git ${cmd/_/ } $completion_helper) " || return
439 for i in $excl; do
440 options="${options/ $i / }"
441 done
442 eval "$var=\"$options\""
445 __gitcomp "$options"
448 # Variation of __gitcomp_nl () that appends to the existing list of
449 # completion candidates, COMPREPLY.
450 __gitcomp_nl_append ()
452 local IFS=$'\n'
453 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
456 # Generates completion reply from newline-separated possible completion words
457 # by appending a space to all of them.
458 # It accepts 1 to 4 arguments:
459 # 1: List of possible completion words, separated by a single newline.
460 # 2: A prefix to be added to each possible completion word (optional).
461 # 3: Generate possible completion matches for this word (optional).
462 # 4: A suffix to be appended to each possible completion word instead of
463 # the default space (optional). If specified but empty, nothing is
464 # appended.
465 __gitcomp_nl ()
467 COMPREPLY=()
468 __gitcomp_nl_append "$@"
471 # Fills the COMPREPLY array with prefiltered paths without any additional
472 # processing.
473 # Callers must take care of providing only paths that match the current path
474 # to be completed and adding any prefix path components, if necessary.
475 # 1: List of newline-separated matching paths, complete with all prefix
476 # path components.
477 __gitcomp_file_direct ()
479 local IFS=$'\n'
481 COMPREPLY=($1)
483 # use a hack to enable file mode in bash < 4
484 compopt -o filenames +o nospace 2>/dev/null ||
485 compgen -f /non-existing-dir/ >/dev/null ||
486 true
489 # Generates completion reply with compgen from newline-separated possible
490 # completion filenames.
491 # It accepts 1 to 3 arguments:
492 # 1: List of possible completion filenames, separated by a single newline.
493 # 2: A directory prefix to be added to each possible completion filename
494 # (optional).
495 # 3: Generate possible completion matches for this word (optional).
496 __gitcomp_file ()
498 local IFS=$'\n'
500 # XXX does not work when the directory prefix contains a tilde,
501 # since tilde expansion is not applied.
502 # This means that COMPREPLY will be empty and Bash default
503 # completion will be used.
504 __gitcompadd "$1" "${2-}" "${3-$cur}" ""
506 # use a hack to enable file mode in bash < 4
507 compopt -o filenames +o nospace 2>/dev/null ||
508 compgen -f /non-existing-dir/ >/dev/null ||
509 true
512 # Execute 'git ls-files', unless the --committable option is specified, in
513 # which case it runs 'git diff-index' to find out the files that can be
514 # committed. It return paths relative to the directory specified in the first
515 # argument, and using the options specified in the second argument.
516 __git_ls_files_helper ()
518 if [ "$2" == "--committable" ]; then
519 __git -C "$1" -c core.quotePath=false diff-index \
520 --name-only --relative HEAD -- "${3//\\/\\\\}*"
521 else
522 # NOTE: $2 is not quoted in order to support multiple options
523 __git -C "$1" -c core.quotePath=false ls-files \
524 --exclude-standard $2 -- "${3//\\/\\\\}*"
529 # __git_index_files accepts 1 or 2 arguments:
530 # 1: Options to pass to ls-files (required).
531 # 2: A directory path (optional).
532 # If provided, only files within the specified directory are listed.
533 # Sub directories are never recursed. Path must have a trailing
534 # slash.
535 # 3: List only paths matching this path component (optional).
536 __git_index_files ()
538 local root="$2" match="$3"
540 __git_ls_files_helper "$root" "$1" "${match:-?}" |
541 awk -F / -v pfx="${2//\\/\\\\}" '{
542 paths[$1] = 1
544 END {
545 for (p in paths) {
546 if (substr(p, 1, 1) != "\"") {
547 # No special characters, easy!
548 print pfx p
549 continue
552 # The path is quoted.
553 p = dequote(p)
554 if (p == "")
555 continue
557 # Even when a directory name itself does not contain
558 # any special characters, it will still be quoted if
559 # any of its (stripped) trailing path components do.
560 # Because of this we may have seen the same directory
561 # both quoted and unquoted.
562 if (p in paths)
563 # We have seen the same directory unquoted,
564 # skip it.
565 continue
566 else
567 print pfx p
570 function dequote(p, bs_idx, out, esc, esc_idx, dec) {
571 # Skip opening double quote.
572 p = substr(p, 2)
574 # Interpret backslash escape sequences.
575 while ((bs_idx = index(p, "\\")) != 0) {
576 out = out substr(p, 1, bs_idx - 1)
577 esc = substr(p, bs_idx + 1, 1)
578 p = substr(p, bs_idx + 2)
580 if ((esc_idx = index("abtvfr\"\\", esc)) != 0) {
581 # C-style one-character escape sequence.
582 out = out substr("\a\b\t\v\f\r\"\\",
583 esc_idx, 1)
584 } else if (esc == "n") {
585 # Uh-oh, a newline character.
586 # We cannot reliably put a pathname
587 # containing a newline into COMPREPLY,
588 # and the newline would create a mess.
589 # Skip this path.
590 return ""
591 } else {
592 # Must be a \nnn octal value, then.
593 dec = esc * 64 + \
594 substr(p, 1, 1) * 8 + \
595 substr(p, 2, 1)
596 out = out sprintf("%c", dec)
597 p = substr(p, 3)
600 # Drop closing double quote, if there is one.
601 # (There is not any if this is a directory, as it was
602 # already stripped with the trailing path components.)
603 if (substr(p, length(p), 1) == "\"")
604 out = out substr(p, 1, length(p) - 1)
605 else
606 out = out p
608 return out
612 # __git_complete_index_file requires 1 argument:
613 # 1: the options to pass to ls-file
615 # The exception is --committable, which finds the files appropriate commit.
616 __git_complete_index_file ()
618 local dequoted_word pfx="" cur_
620 __git_dequote "$cur"
622 case "$dequoted_word" in
623 ?*/*)
624 pfx="${dequoted_word%/*}/"
625 cur_="${dequoted_word##*/}"
628 cur_="$dequoted_word"
629 esac
631 __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
634 # Lists branches from the local repository.
635 # 1: A prefix to be added to each listed branch (optional).
636 # 2: List only branches matching this word (optional; list all branches if
637 # unset or empty).
638 # 3: A suffix to be appended to each listed branch (optional).
639 __git_heads ()
641 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
643 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
644 "refs/heads/$cur_*" "refs/heads/$cur_*/**"
647 # Lists branches from remote repositories.
648 # 1: A prefix to be added to each listed branch (optional).
649 # 2: List only branches matching this word (optional; list all branches if
650 # unset or empty).
651 # 3: A suffix to be appended to each listed branch (optional).
652 __git_remote_heads ()
654 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
656 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
657 "refs/remotes/$cur_*" "refs/remotes/$cur_*/**"
660 # Lists tags from the local repository.
661 # Accepts the same positional parameters as __git_heads() above.
662 __git_tags ()
664 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
666 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
667 "refs/tags/$cur_*" "refs/tags/$cur_*/**"
670 # List unique branches from refs/remotes used for 'git checkout' and 'git
671 # switch' tracking DWIMery.
672 # 1: A prefix to be added to each listed branch (optional)
673 # 2: List only branches matching this word (optional; list all branches if
674 # unset or empty).
675 # 3: A suffix to be appended to each listed branch (optional).
676 __git_dwim_remote_heads ()
678 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
679 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
681 # employ the heuristic used by git checkout and git switch
682 # Try to find a remote branch that cur_es the completion word
683 # but only output if the branch name is unique
684 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
685 --sort="refname:strip=3" \
686 "refs/remotes/*/$cur_*" "refs/remotes/*/$cur_*/**" | \
687 uniq -u
690 # Lists refs from the local (by default) or from a remote repository.
691 # It accepts 0, 1 or 2 arguments:
692 # 1: The remote to list refs from (optional; ignored, if set but empty).
693 # Can be the name of a configured remote, a path, or a URL.
694 # 2: In addition to local refs, list unique branches from refs/remotes/ for
695 # 'git checkout's tracking DWIMery (optional; ignored, if set but empty).
696 # 3: A prefix to be added to each listed ref (optional).
697 # 4: List only refs matching this word (optional; list all refs if unset or
698 # empty).
699 # 5: A suffix to be appended to each listed ref (optional; ignored, if set
700 # but empty).
702 # Use __git_complete_refs() instead.
703 __git_refs ()
705 local i hash dir track="${2-}"
706 local list_refs_from=path remote="${1-}"
707 local format refs
708 local pfx="${3-}" cur_="${4-$cur}" sfx="${5-}"
709 local match="${4-}"
710 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
712 __git_find_repo_path
713 dir="$__git_repo_path"
715 if [ -z "$remote" ]; then
716 if [ -z "$dir" ]; then
717 return
719 else
720 if __git_is_configured_remote "$remote"; then
721 # configured remote takes precedence over a
722 # local directory with the same name
723 list_refs_from=remote
724 elif [ -d "$remote/.git" ]; then
725 dir="$remote/.git"
726 elif [ -d "$remote" ]; then
727 dir="$remote"
728 else
729 list_refs_from=url
733 if [ "$list_refs_from" = path ]; then
734 if [[ "$cur_" == ^* ]]; then
735 pfx="$pfx^"
736 fer_pfx="$fer_pfx^"
737 cur_=${cur_#^}
738 match=${match#^}
740 case "$cur_" in
741 refs|refs/*)
742 format="refname"
743 refs=("$match*" "$match*/**")
744 track=""
747 for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD REBASE_HEAD CHERRY_PICK_HEAD; do
748 case "$i" in
749 $match*)
750 if [ -e "$dir/$i" ]; then
751 echo "$pfx$i$sfx"
754 esac
755 done
756 format="refname:strip=2"
757 refs=("refs/tags/$match*" "refs/tags/$match*/**"
758 "refs/heads/$match*" "refs/heads/$match*/**"
759 "refs/remotes/$match*" "refs/remotes/$match*/**")
761 esac
762 __git_dir="$dir" __git for-each-ref --format="$fer_pfx%($format)$sfx" \
763 "${refs[@]}"
764 if [ -n "$track" ]; then
765 __git_dwim_remote_heads "$pfx" "$match" "$sfx"
767 return
769 case "$cur_" in
770 refs|refs/*)
771 __git ls-remote "$remote" "$match*" | \
772 while read -r hash i; do
773 case "$i" in
774 *^{}) ;;
775 *) echo "$pfx$i$sfx" ;;
776 esac
777 done
780 if [ "$list_refs_from" = remote ]; then
781 case "HEAD" in
782 $match*) echo "${pfx}HEAD$sfx" ;;
783 esac
784 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
785 "refs/remotes/$remote/$match*" \
786 "refs/remotes/$remote/$match*/**"
787 else
788 local query_symref
789 case "HEAD" in
790 $match*) query_symref="HEAD" ;;
791 esac
792 __git ls-remote "$remote" $query_symref \
793 "refs/tags/$match*" "refs/heads/$match*" \
794 "refs/remotes/$match*" |
795 while read -r hash i; do
796 case "$i" in
797 *^{}) ;;
798 refs/*) echo "$pfx${i#refs/*/}$sfx" ;;
799 *) echo "$pfx$i$sfx" ;; # symbolic refs
800 esac
801 done
804 esac
807 # Completes refs, short and long, local and remote, symbolic and pseudo.
809 # Usage: __git_complete_refs [<option>]...
810 # --remote=<remote>: The remote to list refs from, can be the name of a
811 # configured remote, a path, or a URL.
812 # --dwim: List unique remote branches for 'git switch's tracking DWIMery.
813 # --pfx=<prefix>: A prefix to be added to each ref.
814 # --cur=<word>: The current ref to be completed. Defaults to the current
815 # word to be completed.
816 # --sfx=<suffix>: A suffix to be appended to each ref instead of the default
817 # space.
818 # --mode=<mode>: What set of refs to complete, one of 'refs' (the default) to
819 # complete all refs, 'heads' to complete only branches, or
820 # 'remote-heads' to complete only remote branches. Note that
821 # --remote is only compatible with --mode=refs.
822 __git_complete_refs ()
824 local remote= dwim= pfx= cur_="$cur" sfx=" " mode="refs"
826 while test $# != 0; do
827 case "$1" in
828 --remote=*) remote="${1##--remote=}" ;;
829 --dwim) dwim="yes" ;;
830 # --track is an old spelling of --dwim
831 --track) dwim="yes" ;;
832 --pfx=*) pfx="${1##--pfx=}" ;;
833 --cur=*) cur_="${1##--cur=}" ;;
834 --sfx=*) sfx="${1##--sfx=}" ;;
835 --mode=*) mode="${1##--mode=}" ;;
836 *) return 1 ;;
837 esac
838 shift
839 done
841 # complete references based on the specified mode
842 case "$mode" in
843 refs)
844 __gitcomp_direct "$(__git_refs "$remote" "" "$pfx" "$cur_" "$sfx")" ;;
845 heads)
846 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" "$sfx")" ;;
847 remote-heads)
848 __gitcomp_direct "$(__git_remote_heads "$pfx" "$cur_" "$sfx")" ;;
850 return 1 ;;
851 esac
853 # Append DWIM remote branch names if requested
854 if [ "$dwim" = "yes" ]; then
855 __gitcomp_direct_append "$(__git_dwim_remote_heads "$pfx" "$cur_" "$sfx")"
859 # __git_refs2 requires 1 argument (to pass to __git_refs)
860 # Deprecated: use __git_complete_fetch_refspecs() instead.
861 __git_refs2 ()
863 local i
864 for i in $(__git_refs "$1"); do
865 echo "$i:$i"
866 done
869 # Completes refspecs for fetching from a remote repository.
870 # 1: The remote repository.
871 # 2: A prefix to be added to each listed refspec (optional).
872 # 3: The ref to be completed as a refspec instead of the current word to be
873 # completed (optional)
874 # 4: A suffix to be appended to each listed refspec instead of the default
875 # space (optional).
876 __git_complete_fetch_refspecs ()
878 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
880 __gitcomp_direct "$(
881 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
882 echo "$pfx$i:$i$sfx"
883 done
887 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
888 __git_refs_remotes ()
890 local i hash
891 __git ls-remote "$1" 'refs/heads/*' | \
892 while read -r hash i; do
893 echo "$i:refs/remotes/$1/${i#refs/heads/}"
894 done
897 __git_remotes ()
899 __git_find_repo_path
900 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
901 __git remote
904 # Returns true if $1 matches the name of a configured remote, false otherwise.
905 __git_is_configured_remote ()
907 local remote
908 for remote in $(__git_remotes); do
909 if [ "$remote" = "$1" ]; then
910 return 0
912 done
913 return 1
916 __git_list_merge_strategies ()
918 LANG=C LC_ALL=C git merge -s help 2>&1 |
919 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
920 s/\.$//
921 s/.*://
922 s/^[ ]*//
923 s/[ ]*$//
928 __git_merge_strategies=
929 # 'git merge -s help' (and thus detection of the merge strategy
930 # list) fails, unfortunately, if run outside of any git working
931 # tree. __git_merge_strategies is set to the empty string in
932 # that case, and the detection will be repeated the next time it
933 # is needed.
934 __git_compute_merge_strategies ()
936 test -n "$__git_merge_strategies" ||
937 __git_merge_strategies=$(__git_list_merge_strategies)
940 __git_merge_strategy_options="ours theirs subtree subtree= patience
941 histogram diff-algorithm= ignore-space-change ignore-all-space
942 ignore-space-at-eol renormalize no-renormalize no-renames
943 find-renames find-renames= rename-threshold="
945 __git_complete_revlist_file ()
947 local dequoted_word pfx ls ref cur_="$cur"
948 case "$cur_" in
949 *..?*:*)
950 return
952 ?*:*)
953 ref="${cur_%%:*}"
954 cur_="${cur_#*:}"
956 __git_dequote "$cur_"
958 case "$dequoted_word" in
959 ?*/*)
960 pfx="${dequoted_word%/*}"
961 cur_="${dequoted_word##*/}"
962 ls="$ref:$pfx"
963 pfx="$pfx/"
966 cur_="$dequoted_word"
967 ls="$ref"
969 esac
971 case "$COMP_WORDBREAKS" in
972 *:*) : great ;;
973 *) pfx="$ref:$pfx" ;;
974 esac
976 __gitcomp_file "$(__git ls-tree "$ls" \
977 | sed 's/^.* //
978 s/$//')" \
979 "$pfx" "$cur_"
981 *...*)
982 pfx="${cur_%...*}..."
983 cur_="${cur_#*...}"
984 __git_complete_refs --pfx="$pfx" --cur="$cur_"
986 *..*)
987 pfx="${cur_%..*}.."
988 cur_="${cur_#*..}"
989 __git_complete_refs --pfx="$pfx" --cur="$cur_"
992 __git_complete_refs
994 esac
997 __git_complete_file ()
999 __git_complete_revlist_file
1002 __git_complete_revlist ()
1004 __git_complete_revlist_file
1007 __git_complete_remote_or_refspec ()
1009 local cur_="$cur" cmd="${words[__git_cmd_idx]}"
1010 local i c=$((__git_cmd_idx+1)) remote="" pfx="" lhs=1 no_complete_refspec=0
1011 if [ "$cmd" = "remote" ]; then
1012 ((c++))
1014 while [ $c -lt $cword ]; do
1015 i="${words[c]}"
1016 case "$i" in
1017 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
1018 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
1019 --all)
1020 case "$cmd" in
1021 push) no_complete_refspec=1 ;;
1022 fetch)
1023 return
1025 *) ;;
1026 esac
1028 --multiple) no_complete_refspec=1; break ;;
1029 -*) ;;
1030 *) remote="$i"; break ;;
1031 esac
1032 ((c++))
1033 done
1034 if [ -z "$remote" ]; then
1035 __gitcomp_nl "$(__git_remotes)"
1036 return
1038 if [ $no_complete_refspec = 1 ]; then
1039 return
1041 [ "$remote" = "." ] && remote=
1042 case "$cur_" in
1043 *:*)
1044 case "$COMP_WORDBREAKS" in
1045 *:*) : great ;;
1046 *) pfx="${cur_%%:*}:" ;;
1047 esac
1048 cur_="${cur_#*:}"
1049 lhs=0
1052 pfx="+"
1053 cur_="${cur_#+}"
1055 esac
1056 case "$cmd" in
1057 fetch)
1058 if [ $lhs = 1 ]; then
1059 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
1060 else
1061 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1064 pull|remote)
1065 if [ $lhs = 1 ]; then
1066 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1067 else
1068 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1071 push)
1072 if [ $lhs = 1 ]; then
1073 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1074 else
1075 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1078 esac
1081 __git_complete_strategy ()
1083 __git_compute_merge_strategies
1084 case "$prev" in
1085 -s|--strategy)
1086 __gitcomp "$__git_merge_strategies"
1087 return 0
1090 __gitcomp "$__git_merge_strategy_options"
1091 return 0
1093 esac
1094 case "$cur" in
1095 --strategy=*)
1096 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1097 return 0
1099 --strategy-option=*)
1100 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1101 return 0
1103 esac
1104 return 1
1107 __git_all_commands=
1108 __git_compute_all_commands ()
1110 test -n "$__git_all_commands" ||
1111 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1114 # Lists all set config variables starting with the given section prefix,
1115 # with the prefix removed.
1116 __git_get_config_variables ()
1118 local section="$1" i IFS=$'\n'
1119 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1120 echo "${i#$section.}"
1121 done
1124 __git_pretty_aliases ()
1126 __git_get_config_variables "pretty"
1129 # __git_aliased_command requires 1 argument
1130 __git_aliased_command ()
1132 local cur=$1 last list= word cmdline
1134 while [[ -n "$cur" ]]; do
1135 if [[ "$list" == *" $cur "* ]]; then
1136 # loop detected
1137 return
1140 cmdline=$(__git config --get "alias.$cur")
1141 list=" $cur $list"
1142 last=$cur
1143 cur=
1145 for word in $cmdline; do
1146 case "$word" in
1147 \!gitk|gitk)
1148 cur="gitk"
1149 break
1151 \!*) : shell command alias ;;
1152 -*) : option ;;
1153 *=*) : setting env ;;
1154 git) : git itself ;;
1155 \(\)) : skip parens of shell function definition ;;
1156 {) : skip start of shell helper function ;;
1157 :) : skip null command ;;
1158 \'*) : skip opening quote after sh -c ;;
1160 cur="$word"
1161 break
1162 esac
1163 done
1164 done
1166 cur=$last
1167 if [[ "$cur" != "$1" ]]; then
1168 echo "$cur"
1172 # Check whether one of the given words is present on the command line,
1173 # and print the first word found.
1175 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1176 # --show-idx: Optionally show the index of the found word in the $words array.
1177 __git_find_on_cmdline ()
1179 local word c="$__git_cmd_idx" show_idx
1181 while test $# -gt 1; do
1182 case "$1" in
1183 --show-idx) show_idx=y ;;
1184 *) return 1 ;;
1185 esac
1186 shift
1187 done
1188 local wordlist="$1"
1190 while [ $c -lt $cword ]; do
1191 for word in $wordlist; do
1192 if [ "$word" = "${words[c]}" ]; then
1193 if [ -n "${show_idx-}" ]; then
1194 echo "$c $word"
1195 else
1196 echo "$word"
1198 return
1200 done
1201 ((c++))
1202 done
1205 # Similar to __git_find_on_cmdline, except that it loops backwards and thus
1206 # prints the *last* word found. Useful for finding which of two options that
1207 # supersede each other came last, such as "--guess" and "--no-guess".
1209 # Usage: __git_find_last_on_cmdline [<option>]... "<wordlist>"
1210 # --show-idx: Optionally show the index of the found word in the $words array.
1211 __git_find_last_on_cmdline ()
1213 local word c=$cword show_idx
1215 while test $# -gt 1; do
1216 case "$1" in
1217 --show-idx) show_idx=y ;;
1218 *) return 1 ;;
1219 esac
1220 shift
1221 done
1222 local wordlist="$1"
1224 while [ $c -gt "$__git_cmd_idx" ]; do
1225 ((c--))
1226 for word in $wordlist; do
1227 if [ "$word" = "${words[c]}" ]; then
1228 if [ -n "$show_idx" ]; then
1229 echo "$c $word"
1230 else
1231 echo "$word"
1233 return
1235 done
1236 done
1239 # Echo the value of an option set on the command line or config
1241 # $1: short option name
1242 # $2: long option name including =
1243 # $3: list of possible values
1244 # $4: config string (optional)
1246 # example:
1247 # result="$(__git_get_option_value "-d" "--do-something=" \
1248 # "yes no" "core.doSomething")"
1250 # result is then either empty (no option set) or "yes" or "no"
1252 # __git_get_option_value requires 3 arguments
1253 __git_get_option_value ()
1255 local c short_opt long_opt val
1256 local result= values config_key word
1258 short_opt="$1"
1259 long_opt="$2"
1260 values="$3"
1261 config_key="$4"
1263 ((c = $cword - 1))
1264 while [ $c -ge 0 ]; do
1265 word="${words[c]}"
1266 for val in $values; do
1267 if [ "$short_opt$val" = "$word" ] ||
1268 [ "$long_opt$val" = "$word" ]; then
1269 result="$val"
1270 break 2
1272 done
1273 ((c--))
1274 done
1276 if [ -n "$config_key" ] && [ -z "$result" ]; then
1277 result="$(__git config "$config_key")"
1280 echo "$result"
1283 __git_has_doubledash ()
1285 local c=1
1286 while [ $c -lt $cword ]; do
1287 if [ "--" = "${words[c]}" ]; then
1288 return 0
1290 ((c++))
1291 done
1292 return 1
1295 # Try to count non option arguments passed on the command line for the
1296 # specified git command.
1297 # When options are used, it is necessary to use the special -- option to
1298 # tell the implementation were non option arguments begin.
1299 # XXX this can not be improved, since options can appear everywhere, as
1300 # an example:
1301 # git mv x -n y
1303 # __git_count_arguments requires 1 argument: the git command executed.
1304 __git_count_arguments ()
1306 local word i c=0
1308 # Skip "git" (first argument)
1309 for ((i=$__git_cmd_idx; i < ${#words[@]}; i++)); do
1310 word="${words[i]}"
1312 case "$word" in
1314 # Good; we can assume that the following are only non
1315 # option arguments.
1316 ((c = 0))
1318 "$1")
1319 # Skip the specified git command and discard git
1320 # main options
1321 ((c = 0))
1324 ((c++))
1326 esac
1327 done
1329 printf "%d" $c
1332 __git_whitespacelist="nowarn warn error error-all fix"
1333 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1334 __git_showcurrentpatch="diff raw"
1335 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1336 __git_quoted_cr="nowarn warn strip"
1338 _git_am ()
1340 __git_find_repo_path
1341 if [ -d "$__git_repo_path"/rebase-apply ]; then
1342 __gitcomp "$__git_am_inprogress_options"
1343 return
1345 case "$cur" in
1346 --whitespace=*)
1347 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1348 return
1350 --patch-format=*)
1351 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1352 return
1354 --show-current-patch=*)
1355 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1356 return
1358 --quoted-cr=*)
1359 __gitcomp "$__git_quoted_cr" "" "${cur##--quoted-cr=}"
1360 return
1362 --*)
1363 __gitcomp_builtin am "" \
1364 "$__git_am_inprogress_options"
1365 return
1366 esac
1369 _git_apply ()
1371 case "$cur" in
1372 --whitespace=*)
1373 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1374 return
1376 --*)
1377 __gitcomp_builtin apply
1378 return
1379 esac
1382 _git_add ()
1384 case "$cur" in
1385 --chmod=*)
1386 __gitcomp "+x -x" "" "${cur##--chmod=}"
1387 return
1389 --*)
1390 __gitcomp_builtin add
1391 return
1392 esac
1394 local complete_opt="--others --modified --directory --no-empty-directory"
1395 if test -n "$(__git_find_on_cmdline "-u --update")"
1396 then
1397 complete_opt="--modified"
1399 __git_complete_index_file "$complete_opt"
1402 _git_archive ()
1404 case "$cur" in
1405 --format=*)
1406 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1407 return
1409 --remote=*)
1410 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1411 return
1413 --*)
1414 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1415 return
1417 esac
1418 __git_complete_file
1421 _git_bisect ()
1423 __git_has_doubledash && return
1425 local subcommands="start bad good skip reset visualize replay log run"
1426 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1427 if [ -z "$subcommand" ]; then
1428 __git_find_repo_path
1429 if [ -f "$__git_repo_path"/BISECT_START ]; then
1430 __gitcomp "$subcommands"
1431 else
1432 __gitcomp "replay start"
1434 return
1437 case "$subcommand" in
1438 bad|good|reset|skip|start)
1439 __git_complete_refs
1443 esac
1446 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1448 _git_branch ()
1450 local i c="$__git_cmd_idx" only_local_ref="n" has_r="n"
1452 while [ $c -lt $cword ]; do
1453 i="${words[c]}"
1454 case "$i" in
1455 -d|-D|--delete|-m|-M|--move|-c|-C|--copy)
1456 only_local_ref="y" ;;
1457 -r|--remotes)
1458 has_r="y" ;;
1459 esac
1460 ((c++))
1461 done
1463 case "$cur" in
1464 --set-upstream-to=*)
1465 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1467 --*)
1468 __gitcomp_builtin branch
1471 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1472 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1473 else
1474 __git_complete_refs
1477 esac
1480 _git_bundle ()
1482 local cmd="${words[__git_cmd_idx+1]}"
1483 case "$cword" in
1484 $((__git_cmd_idx+1)))
1485 __gitcomp "create list-heads verify unbundle"
1487 $((__git_cmd_idx+2)))
1488 # looking for a file
1491 case "$cmd" in
1492 create)
1493 __git_complete_revlist
1495 esac
1497 esac
1500 # Helper function to decide whether or not we should enable DWIM logic for
1501 # git-switch and git-checkout.
1503 # To decide between the following rules in decreasing priority order:
1504 # - the last provided of "--guess" or "--no-guess" explicitly enable or
1505 # disable completion of DWIM logic respectively.
1506 # - If checkout.guess is false, disable completion of DWIM logic.
1507 # - If the --no-track option is provided, take this as a hint to disable the
1508 # DWIM completion logic
1509 # - If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion
1510 # logic, as requested by the user.
1511 # - Enable DWIM logic otherwise.
1513 __git_checkout_default_dwim_mode ()
1515 local last_option dwim_opt="--dwim"
1517 if [ "${GIT_COMPLETION_CHECKOUT_NO_GUESS-}" = "1" ]; then
1518 dwim_opt=""
1521 # --no-track disables DWIM, but with lower priority than
1522 # --guess/--no-guess/checkout.guess
1523 if [ -n "$(__git_find_on_cmdline "--no-track")" ]; then
1524 dwim_opt=""
1527 # checkout.guess = false disables DWIM, but with lower priority than
1528 # --guess/--no-guess
1529 if [ "$(__git config --type=bool checkout.guess)" = "false" ]; then
1530 dwim_opt=""
1533 # Find the last provided --guess or --no-guess
1534 last_option="$(__git_find_last_on_cmdline "--guess --no-guess")"
1535 case "$last_option" in
1536 --guess)
1537 dwim_opt="--dwim"
1539 --no-guess)
1540 dwim_opt=""
1542 esac
1544 echo "$dwim_opt"
1547 _git_checkout ()
1549 __git_has_doubledash && return
1551 local dwim_opt="$(__git_checkout_default_dwim_mode)"
1553 case "$prev" in
1554 -b|-B|--orphan)
1555 # Complete local branches (and DWIM branch
1556 # remote branch names) for an option argument
1557 # specifying a new branch name. This is for
1558 # convenience, assuming new branches are
1559 # possibly based on pre-existing branch names.
1560 __git_complete_refs $dwim_opt --mode="heads"
1561 return
1565 esac
1567 case "$cur" in
1568 --conflict=*)
1569 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1571 --*)
1572 __gitcomp_builtin checkout
1575 # At this point, we've already handled special completion for
1576 # the arguments to -b/-B, and --orphan. There are 3 main
1577 # things left we can possibly complete:
1578 # 1) a start-point for -b/-B, -d/--detach, or --orphan
1579 # 2) a remote head, for --track
1580 # 3) an arbitrary reference, possibly including DWIM names
1583 if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan")" ]; then
1584 __git_complete_refs --mode="refs"
1585 elif [ -n "$(__git_find_on_cmdline "--track")" ]; then
1586 __git_complete_refs --mode="remote-heads"
1587 else
1588 __git_complete_refs $dwim_opt --mode="refs"
1591 esac
1594 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1596 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1598 _git_cherry_pick ()
1600 __git_find_repo_path
1601 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1602 __gitcomp "$__git_cherry_pick_inprogress_options"
1603 return
1606 __git_complete_strategy && return
1608 case "$cur" in
1609 --*)
1610 __gitcomp_builtin cherry-pick "" \
1611 "$__git_cherry_pick_inprogress_options"
1614 __git_complete_refs
1616 esac
1619 _git_clean ()
1621 case "$cur" in
1622 --*)
1623 __gitcomp_builtin clean
1624 return
1626 esac
1628 # XXX should we check for -x option ?
1629 __git_complete_index_file "--others --directory"
1632 _git_clone ()
1634 case "$prev" in
1635 -c|--config)
1636 __git_complete_config_variable_name_and_value
1637 return
1639 esac
1640 case "$cur" in
1641 --config=*)
1642 __git_complete_config_variable_name_and_value \
1643 --cur="${cur##--config=}"
1644 return
1646 --*)
1647 __gitcomp_builtin clone
1648 return
1650 esac
1653 __git_untracked_file_modes="all no normal"
1655 _git_commit ()
1657 case "$prev" in
1658 -c|-C)
1659 __git_complete_refs
1660 return
1662 esac
1664 case "$cur" in
1665 --cleanup=*)
1666 __gitcomp "default scissors strip verbatim whitespace
1667 " "" "${cur##--cleanup=}"
1668 return
1670 --reuse-message=*|--reedit-message=*|\
1671 --fixup=*|--squash=*)
1672 __git_complete_refs --cur="${cur#*=}"
1673 return
1675 --untracked-files=*)
1676 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1677 return
1679 --*)
1680 __gitcomp_builtin commit
1681 return
1682 esac
1684 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1685 __git_complete_index_file "--committable"
1686 else
1687 # This is the first commit
1688 __git_complete_index_file "--cached"
1692 _git_describe ()
1694 case "$cur" in
1695 --*)
1696 __gitcomp_builtin describe
1697 return
1698 esac
1699 __git_complete_refs
1702 __git_diff_algorithms="myers minimal patience histogram"
1704 __git_diff_submodule_formats="diff log short"
1706 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1708 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1709 ignore-all-space allow-indentation-change"
1711 __git_diff_common_options="--stat --numstat --shortstat --summary
1712 --patch-with-stat --name-only --name-status --color
1713 --no-color --color-words --no-renames --check
1714 --color-moved --color-moved= --no-color-moved
1715 --color-moved-ws= --no-color-moved-ws
1716 --full-index --binary --abbrev --diff-filter=
1717 --find-copies-harder --ignore-cr-at-eol
1718 --text --ignore-space-at-eol --ignore-space-change
1719 --ignore-all-space --ignore-blank-lines --exit-code
1720 --quiet --ext-diff --no-ext-diff
1721 --no-prefix --src-prefix= --dst-prefix=
1722 --inter-hunk-context=
1723 --patience --histogram --minimal
1724 --raw --word-diff --word-diff-regex=
1725 --dirstat --dirstat= --dirstat-by-file
1726 --dirstat-by-file= --cumulative
1727 --diff-algorithm=
1728 --submodule --submodule= --ignore-submodules
1729 --indent-heuristic --no-indent-heuristic
1730 --textconv --no-textconv
1731 --patch --no-patch
1732 --anchored=
1735 __git_diff_difftool_options="--cached --staged --pickaxe-all --pickaxe-regex
1736 --base --ours --theirs --no-index --relative --merge-base
1737 $__git_diff_common_options"
1739 _git_diff ()
1741 __git_has_doubledash && return
1743 case "$cur" in
1744 --diff-algorithm=*)
1745 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1746 return
1748 --submodule=*)
1749 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1750 return
1752 --color-moved=*)
1753 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1754 return
1756 --color-moved-ws=*)
1757 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1758 return
1760 --*)
1761 __gitcomp "$__git_diff_difftool_options"
1762 return
1764 esac
1765 __git_complete_revlist_file
1768 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1769 tkdiff vimdiff nvimdiff gvimdiff xxdiff araxis p4merge
1770 bc codecompare smerge
1773 _git_difftool ()
1775 __git_has_doubledash && return
1777 case "$cur" in
1778 --tool=*)
1779 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1780 return
1782 --*)
1783 __gitcomp_builtin difftool "$__git_diff_difftool_options"
1784 return
1786 esac
1787 __git_complete_revlist_file
1790 __git_fetch_recurse_submodules="yes on-demand no"
1792 _git_fetch ()
1794 case "$cur" in
1795 --recurse-submodules=*)
1796 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1797 return
1799 --filter=*)
1800 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1801 return
1803 --*)
1804 __gitcomp_builtin fetch
1805 return
1807 esac
1808 __git_complete_remote_or_refspec
1811 __git_format_patch_extra_options="
1812 --full-index --not --all --no-prefix --src-prefix=
1813 --dst-prefix= --notes
1816 _git_format_patch ()
1818 case "$cur" in
1819 --thread=*)
1820 __gitcomp "
1821 deep shallow
1822 " "" "${cur##--thread=}"
1823 return
1825 --base=*|--interdiff=*|--range-diff=*)
1826 __git_complete_refs --cur="${cur#--*=}"
1827 return
1829 --*)
1830 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1831 return
1833 esac
1834 __git_complete_revlist
1837 _git_fsck ()
1839 case "$cur" in
1840 --*)
1841 __gitcomp_builtin fsck
1842 return
1844 esac
1847 _git_gitk ()
1849 __gitk_main
1852 # Lists matching symbol names from a tag (as in ctags) file.
1853 # 1: List symbol names matching this word.
1854 # 2: The tag file to list symbol names from.
1855 # 3: A prefix to be added to each listed symbol name (optional).
1856 # 4: A suffix to be appended to each listed symbol name (optional).
1857 __git_match_ctag () {
1858 awk -v pfx="${3-}" -v sfx="${4-}" "
1859 /^${1//\//\\/}/ { print pfx \$1 sfx }
1860 " "$2"
1863 # Complete symbol names from a tag file.
1864 # Usage: __git_complete_symbol [<option>]...
1865 # --tags=<file>: The tag file to list symbol names from instead of the
1866 # default "tags".
1867 # --pfx=<prefix>: A prefix to be added to each symbol name.
1868 # --cur=<word>: The current symbol name to be completed. Defaults to
1869 # the current word to be completed.
1870 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1871 # of the default space.
1872 __git_complete_symbol () {
1873 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1875 while test $# != 0; do
1876 case "$1" in
1877 --tags=*) tags="${1##--tags=}" ;;
1878 --pfx=*) pfx="${1##--pfx=}" ;;
1879 --cur=*) cur_="${1##--cur=}" ;;
1880 --sfx=*) sfx="${1##--sfx=}" ;;
1881 *) return 1 ;;
1882 esac
1883 shift
1884 done
1886 if test -r "$tags"; then
1887 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1891 _git_grep ()
1893 __git_has_doubledash && return
1895 case "$cur" in
1896 --*)
1897 __gitcomp_builtin grep
1898 return
1900 esac
1902 case "$cword,$prev" in
1903 $((__git_cmd_idx+1)),*|*,-*)
1904 __git_complete_symbol && return
1906 esac
1908 __git_complete_refs
1911 _git_help ()
1913 case "$cur" in
1914 --*)
1915 __gitcomp_builtin help
1916 return
1918 esac
1919 if test -n "${GIT_TESTING_ALL_COMMAND_LIST-}"
1920 then
1921 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1922 else
1923 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1927 _git_init ()
1929 case "$cur" in
1930 --shared=*)
1931 __gitcomp "
1932 false true umask group all world everybody
1933 " "" "${cur##--shared=}"
1934 return
1936 --*)
1937 __gitcomp_builtin init
1938 return
1940 esac
1943 _git_ls_files ()
1945 case "$cur" in
1946 --*)
1947 __gitcomp_builtin ls-files
1948 return
1950 esac
1952 # XXX ignore options like --modified and always suggest all cached
1953 # files.
1954 __git_complete_index_file "--cached"
1957 _git_ls_remote ()
1959 case "$cur" in
1960 --*)
1961 __gitcomp_builtin ls-remote
1962 return
1964 esac
1965 __gitcomp_nl "$(__git_remotes)"
1968 _git_ls_tree ()
1970 case "$cur" in
1971 --*)
1972 __gitcomp_builtin ls-tree
1973 return
1975 esac
1977 __git_complete_file
1980 # Options that go well for log, shortlog and gitk
1981 __git_log_common_options="
1982 --not --all
1983 --branches --tags --remotes
1984 --first-parent --merges --no-merges
1985 --max-count=
1986 --max-age= --since= --after=
1987 --min-age= --until= --before=
1988 --min-parents= --max-parents=
1989 --no-min-parents --no-max-parents
1991 # Options that go well for log and gitk (not shortlog)
1992 __git_log_gitk_options="
1993 --dense --sparse --full-history
1994 --simplify-merges --simplify-by-decoration
1995 --left-right --notes --no-notes
1997 # Options that go well for log and shortlog (not gitk)
1998 __git_log_shortlog_options="
1999 --author= --committer= --grep=
2000 --all-match --invert-grep
2003 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
2004 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
2006 _git_log ()
2008 __git_has_doubledash && return
2009 __git_find_repo_path
2011 local merge=""
2012 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
2013 merge="--merge"
2015 case "$prev,$cur" in
2016 -L,:*:*)
2017 return # fall back to Bash filename completion
2019 -L,:*)
2020 __git_complete_symbol --cur="${cur#:}" --sfx=":"
2021 return
2023 -G,*|-S,*)
2024 __git_complete_symbol
2025 return
2027 esac
2028 case "$cur" in
2029 --pretty=*|--format=*)
2030 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2031 " "" "${cur#*=}"
2032 return
2034 --date=*)
2035 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
2036 return
2038 --decorate=*)
2039 __gitcomp "full short no" "" "${cur##--decorate=}"
2040 return
2042 --diff-algorithm=*)
2043 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2044 return
2046 --submodule=*)
2047 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2048 return
2050 --no-walk=*)
2051 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
2052 return
2054 --*)
2055 __gitcomp "
2056 $__git_log_common_options
2057 $__git_log_shortlog_options
2058 $__git_log_gitk_options
2059 --root --topo-order --date-order --reverse
2060 --follow --full-diff
2061 --abbrev-commit --no-abbrev-commit --abbrev=
2062 --relative-date --date=
2063 --pretty= --format= --oneline
2064 --show-signature
2065 --cherry-mark
2066 --cherry-pick
2067 --graph
2068 --decorate --decorate= --no-decorate
2069 --walk-reflogs
2070 --no-walk --no-walk= --do-walk
2071 --parents --children
2072 --expand-tabs --expand-tabs= --no-expand-tabs
2073 $merge
2074 $__git_diff_common_options
2075 --pickaxe-all --pickaxe-regex
2077 return
2079 -L:*:*)
2080 return # fall back to Bash filename completion
2082 -L:*)
2083 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
2084 return
2086 -G*)
2087 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
2088 return
2090 -S*)
2091 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
2092 return
2094 esac
2095 __git_complete_revlist
2098 _git_merge ()
2100 __git_complete_strategy && return
2102 case "$cur" in
2103 --*)
2104 __gitcomp_builtin merge
2105 return
2106 esac
2107 __git_complete_refs
2110 _git_mergetool ()
2112 case "$cur" in
2113 --tool=*)
2114 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
2115 return
2117 --*)
2118 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
2119 return
2121 esac
2124 _git_merge_base ()
2126 case "$cur" in
2127 --*)
2128 __gitcomp_builtin merge-base
2129 return
2131 esac
2132 __git_complete_refs
2135 _git_mv ()
2137 case "$cur" in
2138 --*)
2139 __gitcomp_builtin mv
2140 return
2142 esac
2144 if [ $(__git_count_arguments "mv") -gt 0 ]; then
2145 # We need to show both cached and untracked files (including
2146 # empty directories) since this may not be the last argument.
2147 __git_complete_index_file "--cached --others --directory"
2148 else
2149 __git_complete_index_file "--cached"
2153 _git_notes ()
2155 local subcommands='add append copy edit get-ref list merge prune remove show'
2156 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2158 case "$subcommand,$cur" in
2159 ,--*)
2160 __gitcomp_builtin notes
2163 case "$prev" in
2164 --ref)
2165 __git_complete_refs
2168 __gitcomp "$subcommands --ref"
2170 esac
2172 *,--reuse-message=*|*,--reedit-message=*)
2173 __git_complete_refs --cur="${cur#*=}"
2175 *,--*)
2176 __gitcomp_builtin notes_$subcommand
2178 prune,*|get-ref,*)
2179 # this command does not take a ref, do not complete it
2182 case "$prev" in
2183 -m|-F)
2186 __git_complete_refs
2188 esac
2190 esac
2193 _git_pull ()
2195 __git_complete_strategy && return
2197 case "$cur" in
2198 --recurse-submodules=*)
2199 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
2200 return
2202 --*)
2203 __gitcomp_builtin pull
2205 return
2207 esac
2208 __git_complete_remote_or_refspec
2211 __git_push_recurse_submodules="check on-demand only"
2213 __git_complete_force_with_lease ()
2215 local cur_=$1
2217 case "$cur_" in
2218 --*=)
2220 *:*)
2221 __git_complete_refs --cur="${cur_#*:}"
2224 __git_complete_refs --cur="$cur_"
2226 esac
2229 _git_push ()
2231 case "$prev" in
2232 --repo)
2233 __gitcomp_nl "$(__git_remotes)"
2234 return
2236 --recurse-submodules)
2237 __gitcomp "$__git_push_recurse_submodules"
2238 return
2240 esac
2241 case "$cur" in
2242 --repo=*)
2243 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2244 return
2246 --recurse-submodules=*)
2247 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2248 return
2250 --force-with-lease=*)
2251 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2252 return
2254 --*)
2255 __gitcomp_builtin push
2256 return
2258 esac
2259 __git_complete_remote_or_refspec
2262 _git_range_diff ()
2264 case "$cur" in
2265 --*)
2266 __gitcomp "
2267 --creation-factor= --no-dual-color
2268 $__git_diff_common_options
2270 return
2272 esac
2273 __git_complete_revlist
2276 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2277 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2279 _git_rebase ()
2281 __git_find_repo_path
2282 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2283 __gitcomp "$__git_rebase_interactive_inprogress_options"
2284 return
2285 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2286 [ -d "$__git_repo_path"/rebase-merge ]; then
2287 __gitcomp "$__git_rebase_inprogress_options"
2288 return
2290 __git_complete_strategy && return
2291 case "$cur" in
2292 --whitespace=*)
2293 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2294 return
2296 --onto=*)
2297 __git_complete_refs --cur="${cur##--onto=}"
2298 return
2300 --*)
2301 __gitcomp_builtin rebase "" \
2302 "$__git_rebase_interactive_inprogress_options"
2304 return
2305 esac
2306 __git_complete_refs
2309 _git_reflog ()
2311 local subcommands="show delete expire"
2312 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2314 if [ -z "$subcommand" ]; then
2315 __gitcomp "$subcommands"
2316 else
2317 __git_complete_refs
2321 __git_send_email_confirm_options="always never auto cc compose"
2322 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2324 _git_send_email ()
2326 case "$prev" in
2327 --to|--cc|--bcc|--from)
2328 __gitcomp "$(__git send-email --dump-aliases)"
2329 return
2331 esac
2333 case "$cur" in
2334 --confirm=*)
2335 __gitcomp "
2336 $__git_send_email_confirm_options
2337 " "" "${cur##--confirm=}"
2338 return
2340 --suppress-cc=*)
2341 __gitcomp "
2342 $__git_send_email_suppresscc_options
2343 " "" "${cur##--suppress-cc=}"
2345 return
2347 --smtp-encryption=*)
2348 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2349 return
2351 --thread=*)
2352 __gitcomp "
2353 deep shallow
2354 " "" "${cur##--thread=}"
2355 return
2357 --to=*|--cc=*|--bcc=*|--from=*)
2358 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2359 return
2361 --*)
2362 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2363 --compose --confirm= --dry-run --envelope-sender
2364 --from --identity
2365 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2366 --no-suppress-from --no-thread --quiet --reply-to
2367 --signed-off-by-cc --smtp-pass --smtp-server
2368 --smtp-server-port --smtp-encryption= --smtp-user
2369 --subject --suppress-cc= --suppress-from --thread --to
2370 --validate --no-validate
2371 $__git_format_patch_extra_options"
2372 return
2374 esac
2375 __git_complete_revlist
2378 _git_stage ()
2380 _git_add
2383 _git_status ()
2385 local complete_opt
2386 local untracked_state
2388 case "$cur" in
2389 --ignore-submodules=*)
2390 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2391 return
2393 --untracked-files=*)
2394 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2395 return
2397 --column=*)
2398 __gitcomp "
2399 always never auto column row plain dense nodense
2400 " "" "${cur##--column=}"
2401 return
2403 --*)
2404 __gitcomp_builtin status
2405 return
2407 esac
2409 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2410 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2412 case "$untracked_state" in
2414 # --ignored option does not matter
2415 complete_opt=
2417 all|normal|*)
2418 complete_opt="--cached --directory --no-empty-directory --others"
2420 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2421 complete_opt="$complete_opt --ignored --exclude=*"
2424 esac
2426 __git_complete_index_file "$complete_opt"
2429 _git_switch ()
2431 local dwim_opt="$(__git_checkout_default_dwim_mode)"
2433 case "$prev" in
2434 -c|-C|--orphan)
2435 # Complete local branches (and DWIM branch
2436 # remote branch names) for an option argument
2437 # specifying a new branch name. This is for
2438 # convenience, assuming new branches are
2439 # possibly based on pre-existing branch names.
2440 __git_complete_refs $dwim_opt --mode="heads"
2441 return
2445 esac
2447 case "$cur" in
2448 --conflict=*)
2449 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2451 --*)
2452 __gitcomp_builtin switch
2455 # Unlike in git checkout, git switch --orphan does not take
2456 # a start point. Thus we really have nothing to complete after
2457 # the branch name.
2458 if [ -n "$(__git_find_on_cmdline "--orphan")" ]; then
2459 return
2462 # At this point, we've already handled special completion for
2463 # -c/-C, and --orphan. There are 3 main things left to
2464 # complete:
2465 # 1) a start-point for -c/-C or -d/--detach
2466 # 2) a remote head, for --track
2467 # 3) a branch name, possibly including DWIM remote branches
2469 if [ -n "$(__git_find_on_cmdline "-c -C -d --detach")" ]; then
2470 __git_complete_refs --mode="refs"
2471 elif [ -n "$(__git_find_on_cmdline "--track")" ]; then
2472 __git_complete_refs --mode="remote-heads"
2473 else
2474 __git_complete_refs $dwim_opt --mode="heads"
2477 esac
2480 __git_config_get_set_variables ()
2482 local prevword word config_file= c=$cword
2483 while [ $c -gt "$__git_cmd_idx" ]; do
2484 word="${words[c]}"
2485 case "$word" in
2486 --system|--global|--local|--file=*)
2487 config_file="$word"
2488 break
2490 -f|--file)
2491 config_file="$word $prevword"
2492 break
2494 esac
2495 prevword=$word
2496 c=$((--c))
2497 done
2499 __git config $config_file --name-only --list
2502 __git_config_vars=
2503 __git_compute_config_vars ()
2505 test -n "$__git_config_vars" ||
2506 __git_config_vars="$(git help --config-for-completion | sort -u)"
2509 # Completes possible values of various configuration variables.
2511 # Usage: __git_complete_config_variable_value [<option>]...
2512 # --varname=<word>: The name of the configuration variable whose value is
2513 # to be completed. Defaults to the previous word on the
2514 # command line.
2515 # --cur=<word>: The current value to be completed. Defaults to the current
2516 # word to be completed.
2517 __git_complete_config_variable_value ()
2519 local varname="$prev" cur_="$cur"
2521 while test $# != 0; do
2522 case "$1" in
2523 --varname=*) varname="${1##--varname=}" ;;
2524 --cur=*) cur_="${1##--cur=}" ;;
2525 *) return 1 ;;
2526 esac
2527 shift
2528 done
2530 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2531 varname="${varname,,}"
2532 else
2533 varname="$(echo "$varname" |tr A-Z a-z)"
2536 case "$varname" in
2537 branch.*.remote|branch.*.pushremote)
2538 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2539 return
2541 branch.*.merge)
2542 __git_complete_refs --cur="$cur_"
2543 return
2545 branch.*.rebase)
2546 __gitcomp "false true merges preserve interactive" "" "$cur_"
2547 return
2549 remote.pushdefault)
2550 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2551 return
2553 remote.*.fetch)
2554 local remote="${varname#remote.}"
2555 remote="${remote%.fetch}"
2556 if [ -z "$cur_" ]; then
2557 __gitcomp_nl "refs/heads/" "" "" ""
2558 return
2560 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2561 return
2563 remote.*.push)
2564 local remote="${varname#remote.}"
2565 remote="${remote%.push}"
2566 __gitcomp_nl "$(__git for-each-ref \
2567 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2568 return
2570 pull.twohead|pull.octopus)
2571 __git_compute_merge_strategies
2572 __gitcomp "$__git_merge_strategies" "" "$cur_"
2573 return
2575 color.pager)
2576 __gitcomp "false true" "" "$cur_"
2577 return
2579 color.*.*)
2580 __gitcomp "
2581 normal black red green yellow blue magenta cyan white
2582 bold dim ul blink reverse
2583 " "" "$cur_"
2584 return
2586 color.*)
2587 __gitcomp "false true always never auto" "" "$cur_"
2588 return
2590 diff.submodule)
2591 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2592 return
2594 help.format)
2595 __gitcomp "man info web html" "" "$cur_"
2596 return
2598 log.date)
2599 __gitcomp "$__git_log_date_formats" "" "$cur_"
2600 return
2602 sendemail.aliasfiletype)
2603 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2604 return
2606 sendemail.confirm)
2607 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2608 return
2610 sendemail.suppresscc)
2611 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2612 return
2614 sendemail.transferencoding)
2615 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2616 return
2618 *.*)
2619 return
2621 esac
2624 # Completes configuration sections, subsections, variable names.
2626 # Usage: __git_complete_config_variable_name [<option>]...
2627 # --cur=<word>: The current configuration section/variable name to be
2628 # completed. Defaults to the current word to be completed.
2629 # --sfx=<suffix>: A suffix to be appended to each fully completed
2630 # configuration variable name (but not to sections or
2631 # subsections) instead of the default space.
2632 __git_complete_config_variable_name ()
2634 local cur_="$cur" sfx
2636 while test $# != 0; do
2637 case "$1" in
2638 --cur=*) cur_="${1##--cur=}" ;;
2639 --sfx=*) sfx="${1##--sfx=}" ;;
2640 *) return 1 ;;
2641 esac
2642 shift
2643 done
2645 case "$cur_" in
2646 branch.*.*)
2647 local pfx="${cur_%.*}."
2648 cur_="${cur_##*.}"
2649 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2650 return
2652 branch.*)
2653 local pfx="${cur_%.*}."
2654 cur_="${cur_#*.}"
2655 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2656 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "${sfx- }"
2657 return
2659 guitool.*.*)
2660 local pfx="${cur_%.*}."
2661 cur_="${cur_##*.}"
2662 __gitcomp "
2663 argPrompt cmd confirm needsFile noConsole noRescan
2664 prompt revPrompt revUnmerged title
2665 " "$pfx" "$cur_" "$sfx"
2666 return
2668 difftool.*.*)
2669 local pfx="${cur_%.*}."
2670 cur_="${cur_##*.}"
2671 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2672 return
2674 man.*.*)
2675 local pfx="${cur_%.*}."
2676 cur_="${cur_##*.}"
2677 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2678 return
2680 mergetool.*.*)
2681 local pfx="${cur_%.*}."
2682 cur_="${cur_##*.}"
2683 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2684 return
2686 pager.*)
2687 local pfx="${cur_%.*}."
2688 cur_="${cur_#*.}"
2689 __git_compute_all_commands
2690 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "${sfx- }"
2691 return
2693 remote.*.*)
2694 local pfx="${cur_%.*}."
2695 cur_="${cur_##*.}"
2696 __gitcomp "
2697 url proxy fetch push mirror skipDefaultUpdate
2698 receivepack uploadpack tagOpt pushurl
2699 " "$pfx" "$cur_" "$sfx"
2700 return
2702 remote.*)
2703 local pfx="${cur_%.*}."
2704 cur_="${cur_#*.}"
2705 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2706 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "${sfx- }"
2707 return
2709 url.*.*)
2710 local pfx="${cur_%.*}."
2711 cur_="${cur_##*.}"
2712 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2713 return
2715 *.*)
2716 __git_compute_config_vars
2717 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2720 __git_compute_config_vars
2721 __gitcomp "$(echo "$__git_config_vars" |
2722 awk -F . '{
2723 sections[$1] = 1
2725 END {
2726 for (s in sections)
2727 print s "."
2729 ')" "" "$cur_"
2731 esac
2734 # Completes '='-separated configuration sections/variable names and values
2735 # for 'git -c section.name=value'.
2737 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2738 # --cur=<word>: The current configuration section/variable name/value to be
2739 # completed. Defaults to the current word to be completed.
2740 __git_complete_config_variable_name_and_value ()
2742 local cur_="$cur"
2744 while test $# != 0; do
2745 case "$1" in
2746 --cur=*) cur_="${1##--cur=}" ;;
2747 *) return 1 ;;
2748 esac
2749 shift
2750 done
2752 case "$cur_" in
2753 *=*)
2754 __git_complete_config_variable_value \
2755 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2758 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2760 esac
2763 _git_config ()
2765 case "$prev" in
2766 --get|--get-all|--unset|--unset-all)
2767 __gitcomp_nl "$(__git_config_get_set_variables)"
2768 return
2770 *.*)
2771 __git_complete_config_variable_value
2772 return
2774 esac
2775 case "$cur" in
2776 --*)
2777 __gitcomp_builtin config
2780 __git_complete_config_variable_name
2782 esac
2785 _git_remote ()
2787 local subcommands="
2788 add rename remove set-head set-branches
2789 get-url set-url show prune update
2791 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2792 if [ -z "$subcommand" ]; then
2793 case "$cur" in
2794 --*)
2795 __gitcomp_builtin remote
2798 __gitcomp "$subcommands"
2800 esac
2801 return
2804 case "$subcommand,$cur" in
2805 add,--*)
2806 __gitcomp_builtin remote_add
2808 add,*)
2810 set-head,--*)
2811 __gitcomp_builtin remote_set-head
2813 set-branches,--*)
2814 __gitcomp_builtin remote_set-branches
2816 set-head,*|set-branches,*)
2817 __git_complete_remote_or_refspec
2819 update,--*)
2820 __gitcomp_builtin remote_update
2822 update,*)
2823 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2825 set-url,--*)
2826 __gitcomp_builtin remote_set-url
2828 get-url,--*)
2829 __gitcomp_builtin remote_get-url
2831 prune,--*)
2832 __gitcomp_builtin remote_prune
2835 __gitcomp_nl "$(__git_remotes)"
2837 esac
2840 _git_replace ()
2842 case "$cur" in
2843 --format=*)
2844 __gitcomp "short medium long" "" "${cur##--format=}"
2845 return
2847 --*)
2848 __gitcomp_builtin replace
2849 return
2851 esac
2852 __git_complete_refs
2855 _git_rerere ()
2857 local subcommands="clear forget diff remaining status gc"
2858 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2859 if test -z "$subcommand"
2860 then
2861 __gitcomp "$subcommands"
2862 return
2866 _git_reset ()
2868 __git_has_doubledash && return
2870 case "$cur" in
2871 --*)
2872 __gitcomp_builtin reset
2873 return
2875 esac
2876 __git_complete_refs
2879 _git_restore ()
2881 case "$prev" in
2883 __git_complete_refs
2884 return
2886 esac
2888 case "$cur" in
2889 --conflict=*)
2890 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2892 --source=*)
2893 __git_complete_refs --cur="${cur##--source=}"
2895 --*)
2896 __gitcomp_builtin restore
2898 esac
2901 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2903 _git_revert ()
2905 __git_find_repo_path
2906 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2907 __gitcomp "$__git_revert_inprogress_options"
2908 return
2910 __git_complete_strategy && return
2911 case "$cur" in
2912 --*)
2913 __gitcomp_builtin revert "" \
2914 "$__git_revert_inprogress_options"
2915 return
2917 esac
2918 __git_complete_refs
2921 _git_rm ()
2923 case "$cur" in
2924 --*)
2925 __gitcomp_builtin rm
2926 return
2928 esac
2930 __git_complete_index_file "--cached"
2933 _git_shortlog ()
2935 __git_has_doubledash && return
2937 case "$cur" in
2938 --*)
2939 __gitcomp "
2940 $__git_log_common_options
2941 $__git_log_shortlog_options
2942 --numbered --summary --email
2944 return
2946 esac
2947 __git_complete_revlist
2950 _git_show ()
2952 __git_has_doubledash && return
2954 case "$cur" in
2955 --pretty=*|--format=*)
2956 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2957 " "" "${cur#*=}"
2958 return
2960 --diff-algorithm=*)
2961 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2962 return
2964 --submodule=*)
2965 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2966 return
2968 --color-moved=*)
2969 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
2970 return
2972 --color-moved-ws=*)
2973 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
2974 return
2976 --*)
2977 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2978 --oneline --show-signature
2979 --expand-tabs --expand-tabs= --no-expand-tabs
2980 $__git_diff_common_options
2982 return
2984 esac
2985 __git_complete_revlist_file
2988 _git_show_branch ()
2990 case "$cur" in
2991 --*)
2992 __gitcomp_builtin show-branch
2993 return
2995 esac
2996 __git_complete_revlist
2999 _git_sparse_checkout ()
3001 local subcommands="list init set disable"
3002 local subcommand="$(__git_find_on_cmdline "$subcommands")"
3003 if [ -z "$subcommand" ]; then
3004 __gitcomp "$subcommands"
3005 return
3008 case "$subcommand,$cur" in
3009 init,--*)
3010 __gitcomp "--cone"
3012 set,--*)
3013 __gitcomp "--stdin"
3017 esac
3020 _git_stash ()
3022 local subcommands='push list show apply clear drop pop create branch'
3023 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
3025 if [ -z "$subcommand" ]; then
3026 case "$((cword - __git_cmd_idx)),$cur" in
3027 *,--*)
3028 __gitcomp_builtin stash_push
3030 1,sa*)
3031 __gitcomp "save"
3033 1,*)
3034 __gitcomp "$subcommands"
3036 esac
3037 return
3040 case "$subcommand,$cur" in
3041 list,--*)
3042 # NEEDSWORK: can we somehow unify this with the options in _git_log() and _git_show()
3043 __gitcomp_builtin stash_list "$__git_log_common_options $__git_diff_common_options"
3045 show,--*)
3046 __gitcomp_builtin stash_show "$__git_diff_common_options"
3048 *,--*)
3049 __gitcomp_builtin "stash_$subcommand"
3051 branch,*)
3052 if [ $cword -eq $((__git_cmd_idx+2)) ]; then
3053 __git_complete_refs
3054 else
3055 __gitcomp_nl "$(__git stash list \
3056 | sed -n -e 's/:.*//p')"
3059 show,*|apply,*|drop,*|pop,*)
3060 __gitcomp_nl "$(__git stash list \
3061 | sed -n -e 's/:.*//p')"
3063 esac
3066 _git_submodule ()
3068 __git_has_doubledash && return
3070 local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
3071 local subcommand="$(__git_find_on_cmdline "$subcommands")"
3072 if [ -z "$subcommand" ]; then
3073 case "$cur" in
3074 --*)
3075 __gitcomp "--quiet"
3078 __gitcomp "$subcommands"
3080 esac
3081 return
3084 case "$subcommand,$cur" in
3085 add,--*)
3086 __gitcomp "--branch --force --name --reference --depth"
3088 status,--*)
3089 __gitcomp "--cached --recursive"
3091 deinit,--*)
3092 __gitcomp "--force --all"
3094 update,--*)
3095 __gitcomp "
3096 --init --remote --no-fetch
3097 --recommend-shallow --no-recommend-shallow
3098 --force --rebase --merge --reference --depth --recursive --jobs
3101 set-branch,--*)
3102 __gitcomp "--default --branch"
3104 summary,--*)
3105 __gitcomp "--cached --files --summary-limit"
3107 foreach,--*|sync,--*)
3108 __gitcomp "--recursive"
3112 esac
3115 _git_svn ()
3117 local subcommands="
3118 init fetch clone rebase dcommit log find-rev
3119 set-tree commit-diff info create-ignore propget
3120 proplist show-ignore show-externals branch tag blame
3121 migrate mkdirs reset gc
3123 local subcommand="$(__git_find_on_cmdline "$subcommands")"
3124 if [ -z "$subcommand" ]; then
3125 __gitcomp "$subcommands"
3126 else
3127 local remote_opts="--username= --config-dir= --no-auth-cache"
3128 local fc_opts="
3129 --follow-parent --authors-file= --repack=
3130 --no-metadata --use-svm-props --use-svnsync-props
3131 --log-window-size= --no-checkout --quiet
3132 --repack-flags --use-log-author --localtime
3133 --add-author-from
3134 --recursive
3135 --ignore-paths= --include-paths= $remote_opts
3137 local init_opts="
3138 --template= --shared= --trunk= --tags=
3139 --branches= --stdlayout --minimize-url
3140 --no-metadata --use-svm-props --use-svnsync-props
3141 --rewrite-root= --prefix= $remote_opts
3143 local cmt_opts="
3144 --edit --rmdir --find-copies-harder --copy-similarity=
3147 case "$subcommand,$cur" in
3148 fetch,--*)
3149 __gitcomp "--revision= --fetch-all $fc_opts"
3151 clone,--*)
3152 __gitcomp "--revision= $fc_opts $init_opts"
3154 init,--*)
3155 __gitcomp "$init_opts"
3157 dcommit,--*)
3158 __gitcomp "
3159 --merge --strategy= --verbose --dry-run
3160 --fetch-all --no-rebase --commit-url
3161 --revision --interactive $cmt_opts $fc_opts
3164 set-tree,--*)
3165 __gitcomp "--stdin $cmt_opts $fc_opts"
3167 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
3168 show-externals,--*|mkdirs,--*)
3169 __gitcomp "--revision="
3171 log,--*)
3172 __gitcomp "
3173 --limit= --revision= --verbose --incremental
3174 --oneline --show-commit --non-recursive
3175 --authors-file= --color
3178 rebase,--*)
3179 __gitcomp "
3180 --merge --verbose --strategy= --local
3181 --fetch-all --dry-run $fc_opts
3184 commit-diff,--*)
3185 __gitcomp "--message= --file= --revision= $cmt_opts"
3187 info,--*)
3188 __gitcomp "--url"
3190 branch,--*)
3191 __gitcomp "--dry-run --message --tag"
3193 tag,--*)
3194 __gitcomp "--dry-run --message"
3196 blame,--*)
3197 __gitcomp "--git-format"
3199 migrate,--*)
3200 __gitcomp "
3201 --config-dir= --ignore-paths= --minimize
3202 --no-auth-cache --username=
3205 reset,--*)
3206 __gitcomp "--revision= --parent"
3210 esac
3214 _git_tag ()
3216 local i c="$__git_cmd_idx" f=0
3217 while [ $c -lt $cword ]; do
3218 i="${words[c]}"
3219 case "$i" in
3220 -d|--delete|-v|--verify)
3221 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3222 return
3227 esac
3228 ((c++))
3229 done
3231 case "$prev" in
3232 -m|-F)
3234 -*|tag)
3235 if [ $f = 1 ]; then
3236 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3240 __git_complete_refs
3242 esac
3244 case "$cur" in
3245 --*)
3246 __gitcomp_builtin tag
3248 esac
3251 _git_whatchanged ()
3253 _git_log
3256 __git_complete_worktree_paths ()
3258 local IFS=$'\n'
3259 # Generate completion reply from worktree list skipping the first
3260 # entry: it's the path of the main worktree, which can't be moved,
3261 # removed, locked, etc.
3262 __gitcomp_nl "$(git worktree list --porcelain |
3263 sed -n -e '2,$ s/^worktree //p')"
3266 _git_worktree ()
3268 local subcommands="add list lock move prune remove unlock"
3269 local subcommand subcommand_idx
3271 subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3272 subcommand_idx="${subcommand% *}"
3273 subcommand="${subcommand#* }"
3275 case "$subcommand,$cur" in
3277 __gitcomp "$subcommands"
3279 *,--*)
3280 __gitcomp_builtin worktree_$subcommand
3282 add,*) # usage: git worktree add [<options>] <path> [<commit-ish>]
3283 # Here we are not completing an --option, it's either the
3284 # path or a ref.
3285 case "$prev" in
3286 -b|-B) # Complete refs for branch to be created/reseted.
3287 __git_complete_refs
3289 -*) # The previous word is an -o|--option without an
3290 # unstuck argument: have to complete the path for
3291 # the new worktree, so don't list anything, but let
3292 # Bash fall back to filename completion.
3294 *) # The previous word is not an --option, so it must
3295 # be either the 'add' subcommand, the unstuck
3296 # argument of an option (e.g. branch for -b|-B), or
3297 # the path for the new worktree.
3298 if [ $cword -eq $((subcommand_idx+1)) ]; then
3299 # Right after the 'add' subcommand: have to
3300 # complete the path, so fall back to Bash
3301 # filename completion.
3303 else
3304 case "${words[cword-2]}" in
3305 -b|-B) # After '-b <branch>': have to
3306 # complete the path, so fall back
3307 # to Bash filename completion.
3309 *) # After the path: have to complete
3310 # the ref to be checked out.
3311 __git_complete_refs
3313 esac
3316 esac
3318 lock,*|remove,*|unlock,*)
3319 __git_complete_worktree_paths
3321 move,*)
3322 if [ $cword -eq $((subcommand_idx+1)) ]; then
3323 # The first parameter must be an existing working
3324 # tree to be moved.
3325 __git_complete_worktree_paths
3326 else
3327 # The second parameter is the destination: it could
3328 # be any path, so don't list anything, but let Bash
3329 # fall back to filename completion.
3333 esac
3336 __git_complete_common () {
3337 local command="$1"
3339 case "$cur" in
3340 --*)
3341 __gitcomp_builtin "$command"
3343 esac
3346 __git_cmds_with_parseopt_helper=
3347 __git_support_parseopt_helper () {
3348 test -n "$__git_cmds_with_parseopt_helper" ||
3349 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3351 case " $__git_cmds_with_parseopt_helper " in
3352 *" $1 "*)
3353 return 0
3356 return 1
3358 esac
3361 __git_have_func () {
3362 declare -f -- "$1" >/dev/null 2>&1
3365 __git_complete_command () {
3366 local command="$1"
3367 local completion_func="_git_${command//-/_}"
3368 if ! __git_have_func $completion_func &&
3369 __git_have_func _completion_loader
3370 then
3371 _completion_loader "git-$command"
3373 if __git_have_func $completion_func
3374 then
3375 $completion_func
3376 return 0
3377 elif __git_support_parseopt_helper "$command"
3378 then
3379 __git_complete_common "$command"
3380 return 0
3381 else
3382 return 1
3386 __git_main ()
3388 local i c=1 command __git_dir __git_repo_path
3389 local __git_C_args C_args_count=0
3390 local __git_cmd_idx
3392 while [ $c -lt $cword ]; do
3393 i="${words[c]}"
3394 case "$i" in
3395 --git-dir=*)
3396 __git_dir="${i#--git-dir=}"
3398 --git-dir)
3399 ((c++))
3400 __git_dir="${words[c]}"
3402 --bare)
3403 __git_dir="."
3405 --help)
3406 command="help"
3407 break
3409 -c|--work-tree|--namespace)
3410 ((c++))
3413 __git_C_args[C_args_count++]=-C
3414 ((c++))
3415 __git_C_args[C_args_count++]="${words[c]}"
3420 command="$i"
3421 __git_cmd_idx="$c"
3422 break
3424 esac
3425 ((c++))
3426 done
3428 if [ -z "${command-}" ]; then
3429 case "$prev" in
3430 --git-dir|-C|--work-tree)
3431 # these need a path argument, let's fall back to
3432 # Bash filename completion
3433 return
3436 __git_complete_config_variable_name_and_value
3437 return
3439 --namespace)
3440 # we don't support completing these options' arguments
3441 return
3443 esac
3444 case "$cur" in
3445 --*)
3446 __gitcomp "
3447 --paginate
3448 --no-pager
3449 --git-dir=
3450 --bare
3451 --version
3452 --exec-path
3453 --exec-path=
3454 --html-path
3455 --man-path
3456 --info-path
3457 --work-tree=
3458 --namespace=
3459 --no-replace-objects
3460 --help
3464 if test -n "${GIT_TESTING_PORCELAIN_COMMAND_LIST-}"
3465 then
3466 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3467 else
3468 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3471 esac
3472 return
3475 __git_complete_command "$command" && return
3477 local expansion=$(__git_aliased_command "$command")
3478 if [ -n "$expansion" ]; then
3479 words[1]=$expansion
3480 __git_complete_command "$expansion"
3484 __gitk_main ()
3486 __git_has_doubledash && return
3488 local __git_repo_path
3489 __git_find_repo_path
3491 local merge=""
3492 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3493 merge="--merge"
3495 case "$cur" in
3496 --*)
3497 __gitcomp "
3498 $__git_log_common_options
3499 $__git_log_gitk_options
3500 $merge
3502 return
3504 esac
3505 __git_complete_revlist
3508 if [[ -n ${ZSH_VERSION-} && -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3509 echo "ERROR: this script is obsolete, please see git-completion.zsh" 1>&2
3510 return
3513 __git_func_wrap ()
3515 local cur words cword prev
3516 local __git_cmd_idx=0
3517 _get_comp_words_by_ref -n =: cur words cword prev
3521 ___git_complete ()
3523 local wrapper="__git_wrap${2}"
3524 eval "$wrapper () { __git_func_wrap $2 ; }"
3525 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3526 || complete -o default -o nospace -F $wrapper $1
3529 # Setup the completion for git commands
3530 # 1: command or alias
3531 # 2: function to call (e.g. `git`, `gitk`, `git_fetch`)
3532 __git_complete ()
3534 local func
3536 if __git_have_func $2; then
3537 func=$2
3538 elif __git_have_func __$2_main; then
3539 func=__$2_main
3540 elif __git_have_func _$2; then
3541 func=_$2
3542 else
3543 echo "ERROR: could not find function '$2'" 1>&2
3544 return 1
3546 ___git_complete $1 $func
3549 ___git_complete git __git_main
3550 ___git_complete gitk __gitk_main
3552 # The following are necessary only for Cygwin, and only are needed
3553 # when the user has tab-completed the executable name and consequently
3554 # included the '.exe' suffix.
3556 if [ "$OSTYPE" = cygwin ]; then
3557 ___git_complete git.exe __git_main