1# bash/zsh completion support for core Git.
2#
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.
6#
7# The contained completion routines provide support for completing:
8#
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
17#
18# To use these routines:
19#
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.
25#
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 ; ... '".
31#
32# Compatible with bash 3.2.57.
33#
34# You can set the following environment variables to influence the behavior of
35# the completion routines:
36#
37# GIT_COMPLETION_CHECKOUT_NO_GUESS
38#
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).
42
43case "$COMP_WORDBREAKS" in
44*:*) : great ;;
45*) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
46esac
47
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 ()
52{
53 if [ -n "$__git_repo_path" ]; then
54 # we already know where it is
55 return
56 fi
57
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)"
72 fi
73}
74
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 ()
79{
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"
87 fi
88}
89
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 ()
93{
94 git ${__git_C_args:+"${__git_C_args[@]}"} \
95 ${__git_dir:+--git-dir="$__git_dir"} "$@" 2>/dev/null
96}
97
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 ()
102{
103 local rest="$1" len ch
104
105 dequoted_word=""
106
107 while test -n "$rest"; do
108 len=${#dequoted_word}
109 dequoted_word="$dequoted_word${rest%%[\\\'\"]*}"
110 rest="${rest:$((${#dequoted_word}-$len))}"
111
112 case "${rest:0:1}" in
113 \\)
114 ch="${rest:1:1}"
115 case "$ch" in
116 $'\n')
117 ;;
118 *)
119 dequoted_word="$dequoted_word$ch"
120 ;;
121 esac
122 rest="${rest:2}"
123 ;;
124 \')
125 rest="${rest:1}"
126 len=${#dequoted_word}
127 dequoted_word="$dequoted_word${rest%%\'*}"
128 rest="${rest:$((${#dequoted_word}-$len+1))}"
129 ;;
130 \")
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
137 \\)
138 ch="${rest:1:1}"
139 case "$ch" in
140 \"|\\|\$|\`)
141 dequoted_word="$dequoted_word$ch"
142 ;;
143 $'\n')
144 ;;
145 *)
146 dequoted_word="$dequoted_word\\$ch"
147 ;;
148 esac
149 rest="${rest:2}"
150 ;;
151 \")
152 rest="${rest:1}"
153 break
154 ;;
155 esac
156 done
157 ;;
158 esac
159 done
160}
161
162# The following function is based on code from:
163#
164# bash_completion - programmable completion functions for bash 3.2+
165#
166# Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
167# © 2009-2010, Bash Completion Maintainers
168# <bash-completion-devel@lists.alioth.debian.org>
169#
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.
174#
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.
179#
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/>.
182#
183# The latest version of this software can be obtained here:
184#
185# http://bash-completion.alioth.debian.org/
186#
187# RELEASE: 2.x
188
189# This function can be used to access a tokenized list of words
190# on the command line:
191#
192# __git_reassemble_comp_words_by_ref '=:'
193# if test "${words_[cword_-1]}" = -w
194# then
195# ...
196# fi
197#
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.
201#
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.
206#
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.
211#
212# Output: words_, cword_, cur_.
213
214__git_reassemble_comp_words_by_ref()
215{
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
223 fi
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]}" ]
235 do
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--))
240 fi
241 first=
242 words_[$j]=${words_[j]}${COMP_WORDS[i]}
243 if [ $i = $COMP_CWORD ]; then
244 cword_=$j
245 fi
246 if (($i < ${#COMP_WORDS[@]} - 1)); then
247 ((i++))
248 else
249 # Done.
250 return
251 fi
252 done
253 words_[$j]=${words_[j]}${COMP_WORDS[i]}
254 if [ $i = $COMP_CWORD ]; then
255 cword_=$j
256 fi
257 done
258}
259
260if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
261_get_comp_words_by_ref ()
262{
263 local exclude cur_ words_ cword_
264 if [ "$1" = "-n" ]; then
265 exclude=$2
266 shift 2
267 fi
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_
274 ;;
275 prev)
276 prev=${words_[$cword_-1]}
277 ;;
278 words)
279 words=("${words_[@]}")
280 ;;
281 cword)
282 cword=$cword_
283 ;;
284 esac
285 shift
286 done
287}
288fi
289
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 ()
298{
299 local IFS=$'\n'
300
301 COMPREPLY=($1)
302}
303
304__gitcompappend ()
305{
306 local x i=${#COMPREPLY[@]}
307 for x in $1; do
308 if [[ "$x" == "$3"* ]]; then
309 COMPREPLY[i++]="$2$x$4"
310 fi
311 done
312}
313
314__gitcompadd ()
315{
316 COMPREPLY=()
317 __gitcompappend "$@"
318}
319
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 ()
328{
329 local cur_="${3-$cur}"
330
331 case "$cur_" in
332 --*=)
333 ;;
334 --no-*)
335 local c i=0 IFS=$' \t\n'
336 for c in $1; do
337 if [[ $c == "--" ]]; then
338 continue
339 fi
340 c="$c${4-}"
341 if [[ $c == "$cur_"* ]]; then
342 case $c in
343 --*=|*.) ;;
344 *) c="$c " ;;
345 esac
346 COMPREPLY[i++]="${2-}$c"
347 fi
348 done
349 ;;
350 *)
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 "
357 fi
358 break
359 fi
360 c="$c${4-}"
361 if [[ $c == "$cur_"* ]]; then
362 case $c in
363 *=|*.) ;;
364 *) c="$c " ;;
365 esac
366 COMPREPLY[i++]="${2-}$c"
367 fi
368 done
369 ;;
370 esac
371}
372
373# Clear the variables caching builtins' options when (re-)sourcing
374# the completion script.
375if [[ -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
377else
378 unset $(compgen -v __gitcomp_builtin_)
379fi
380
381# This function is equivalent to
382#
383# __gitcomp "$(git xxx --git-completion-helper) ..."
384#
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 ()
390{
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"
396
397 local var=__gitcomp_builtin_"${cmd/-/_}"
398 local options
399 eval "options=\$$var"
400
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
405
406 for i in $excl; do
407 options="${options/ $i / }"
408 done
409 eval "$var=\"$options\""
410 fi
411
412 __gitcomp "$options"
413}
414
415# Variation of __gitcomp_nl () that appends to the existing list of
416# completion candidates, COMPREPLY.
417__gitcomp_nl_append ()
418{
419 local IFS=$'\n'
420 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
421}
422
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 ()
433{
434 COMPREPLY=()
435 __gitcomp_nl_append "$@"
436}
437
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 ()
445{
446 local IFS=$'\n'
447
448 COMPREPLY=($1)
449
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
454}
455
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 ()
464{
465 local IFS=$'\n'
466
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}" ""
472
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
477}
478
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 ()
484{
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//\\/\\\\}*"
492 fi
493}
494
495
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 ()
504{
505 local root="$2" match="$3"
506
507 __git_ls_files_helper "$root" "$1" "$match" |
508 awk -F / -v pfx="${2//\\/\\\\}" '{
509 paths[$1] = 1
510 }
511 END {
512 for (p in paths) {
513 if (substr(p, 1, 1) != "\"") {
514 # No special characters, easy!
515 print pfx p
516 continue
517 }
518
519 # The path is quoted.
520 p = dequote(p)
521 if (p == "")
522 continue
523
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
535 }
536 }
537 function dequote(p, bs_idx, out, esc, esc_idx, dec) {
538 # Skip opening double quote.
539 p = substr(p, 2)
540
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)
546
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 cant 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)
565 }
566 }
567 # Drop closing double quote, if there is one.
568 # (There isnt 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
574
575 return out
576 }'
577}
578
579# __git_complete_index_file requires 1 argument:
580# 1: the options to pass to ls-file
581#
582# The exception is --committable, which finds the files appropriate commit.
583__git_complete_index_file ()
584{
585 local dequoted_word pfx="" cur_
586
587 __git_dequote "$cur"
588
589 case "$dequoted_word" in
590 ?*/*)
591 pfx="${dequoted_word%/*}/"
592 cur_="${dequoted_word##*/}"
593 ;;
594 *)
595 cur_="$dequoted_word"
596 esac
597
598 __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
599}
600
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 ()
607{
608 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
609
610 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
611 "refs/heads/$cur_*" "refs/heads/$cur_*/**"
612}
613
614# Lists tags from the local repository.
615# Accepts the same positional parameters as __git_heads() above.
616__git_tags ()
617{
618 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
619
620 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
621 "refs/tags/$cur_*" "refs/tags/$cur_*/**"
622}
623
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).
635#
636# Use __git_complete_refs() instead.
637__git_refs ()
638{
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
645
646 __git_find_repo_path
647 dir="$__git_repo_path"
648
649 if [ -z "$remote" ]; then
650 if [ -z "$dir" ]; then
651 return
652 fi
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
664 fi
665 fi
666
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#^}
673 fi
674 case "$cur_" in
675 refs|refs/*)
676 format="refname"
677 refs=("$match*" "$match*/**")
678 track=""
679 ;;
680 *)
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"
686 fi
687 ;;
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*/**")
694 ;;
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
706 fi
707 return
708 fi
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
718 ;;
719 *)
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
742 fi
743 ;;
744 esac
745}
746
747# Completes refs, short and long, local and remote, symbolic and pseudo.
748#
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 ()
759{
760 local remote track pfx cur_="$cur" sfx=" "
761
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
773
774 __gitcomp_direct "$(__git_refs "$remote" "$track" "$pfx" "$cur_" "$sfx")"
775}
776
777# __git_refs2 requires 1 argument (to pass to __git_refs)
778# Deprecated: use __git_complete_fetch_refspecs() instead.
779__git_refs2 ()
780{
781 local i
782 for i in $(__git_refs "$1"); do
783 echo "$i:$i"
784 done
785}
786
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 ()
795{
796 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
797
798 __gitcomp_direct "$(
799 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
800 echo "$pfx$i:$i$sfx"
801 done
802 )"
803}
804
805# __git_refs_remotes requires 1 argument (to pass to ls-remote)
806__git_refs_remotes ()
807{
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
813}
814
815__git_remotes ()
816{
817 __git_find_repo_path
818 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
819 __git remote
820}
821
822# Returns true if $1 matches the name of a configured remote, false otherwise.
823__git_is_configured_remote ()
824{
825 local remote
826 for remote in $(__git_remotes); do
827 if [ "$remote" = "$1" ]; then
828 return 0
829 fi
830 done
831 return 1
832}
833
834__git_list_merge_strategies ()
835{
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/[ ]*$//
842 p
843 }'
844}
845
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 ()
853{
854 test -n "$__git_merge_strategies" ||
855 __git_merge_strategies=$(__git_list_merge_strategies)
856}
857
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="
862
863__git_complete_revlist_file ()
864{
865 local dequoted_word pfx ls ref cur_="$cur"
866 case "$cur_" in
867 *..?*:*)
868 return
869 ;;
870 ?*:*)
871 ref="${cur_%%:*}"
872 cur_="${cur_#*:}"
873
874 __git_dequote "$cur_"
875
876 case "$dequoted_word" in
877 ?*/*)
878 pfx="${dequoted_word%/*}"
879 cur_="${dequoted_word##*/}"
880 ls="$ref:$pfx"
881 pfx="$pfx/"
882 ;;
883 *)
884 cur_="$dequoted_word"
885 ls="$ref"
886 ;;
887 esac
888
889 case "$COMP_WORDBREAKS" in
890 *:*) : great ;;
891 *) pfx="$ref:$pfx" ;;
892 esac
893
894 __gitcomp_file "$(__git ls-tree "$ls" \
895 | sed 's/^.* //
896 s/$//')" \
897 "$pfx" "$cur_"
898 ;;
899 *...*)
900 pfx="${cur_%...*}..."
901 cur_="${cur_#*...}"
902 __git_complete_refs --pfx="$pfx" --cur="$cur_"
903 ;;
904 *..*)
905 pfx="${cur_%..*}.."
906 cur_="${cur_#*..}"
907 __git_complete_refs --pfx="$pfx" --cur="$cur_"
908 ;;
909 *)
910 __git_complete_refs
911 ;;
912 esac
913}
914
915__git_complete_file ()
916{
917 __git_complete_revlist_file
918}
919
920__git_complete_revlist ()
921{
922 __git_complete_revlist_file
923}
924
925__git_complete_remote_or_refspec ()
926{
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++))
931 fi
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
942 ;;
943 *) ;;
944 esac
945 ;;
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
955 fi
956 if [ $no_complete_refspec = 1 ]; then
957 return
958 fi
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
968 ;;
969 +*)
970 pfx="+"
971 cur_="${cur_#+}"
972 ;;
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_"
980 fi
981 ;;
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_"
987 fi
988 ;;
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_"
994 fi
995 ;;
996 esac
997}
998
999__git_complete_strategy ()
1000{
1001 __git_compute_merge_strategies
1002 case "$prev" in
1003 -s|--strategy)
1004 __gitcomp "$__git_merge_strategies"
1005 return 0
1006 ;;
1007 -X)
1008 __gitcomp "$__git_merge_strategy_options"
1009 return 0
1010 ;;
1011 esac
1012 case "$cur" in
1013 --strategy=*)
1014 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1015 return 0
1016 ;;
1017 --strategy-option=*)
1018 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1019 return 0
1020 ;;
1021 esac
1022 return 1
1023}
1024
1025__git_all_commands=
1026__git_compute_all_commands ()
1027{
1028 test -n "$__git_all_commands" ||
1029 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1030}
1031
1032# Lists all set config variables starting with the given section prefix,
1033# with the prefix removed.
1034__git_get_config_variables ()
1035{
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
1040}
1041
1042__git_pretty_aliases ()
1043{
1044 __git_get_config_variables "pretty"
1045}
1046
1047# __git_aliased_command requires 1 argument
1048__git_aliased_command ()
1049{
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
1056 ;;
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 ;;
1065 *)
1066 echo "$word"
1067 return
1068 esac
1069 done
1070}
1071
1072# __git_find_on_cmdline requires 1 argument
1073__git_find_on_cmdline ()
1074{
1075 local word subcommand c=1
1076 while [ $c -lt $cword ]; do
1077 word="${words[c]}"
1078 for subcommand in $1; do
1079 if [ "$subcommand" = "$word" ]; then
1080 echo "$subcommand"
1081 return
1082 fi
1083 done
1084 ((c++))
1085 done
1086}
1087
1088# Echo the value of an option set on the command line or config
1089#
1090# $1: short option name
1091# $2: long option name including =
1092# $3: list of possible values
1093# $4: config string (optional)
1094#
1095# example:
1096# result="$(__git_get_option_value "-d" "--do-something=" \
1097# "yes no" "core.doSomething")"
1098#
1099# result is then either empty (no option set) or "yes" or "no"
1100#
1101# __git_get_option_value requires 3 arguments
1102__git_get_option_value ()
1103{
1104 local c short_opt long_opt val
1105 local result= values config_key word
1106
1107 short_opt="$1"
1108 long_opt="$2"
1109 values="$3"
1110 config_key="$4"
1111
1112 ((c = $cword - 1))
1113 while [ $c -ge 0 ]; do
1114 word="${words[c]}"
1115 for val in $values; do
1116 if [ "$short_opt$val" = "$word" ] ||
1117 [ "$long_opt$val" = "$word" ]; then
1118 result="$val"
1119 break 2
1120 fi
1121 done
1122 ((c--))
1123 done
1124
1125 if [ -n "$config_key" ] && [ -z "$result" ]; then
1126 result="$(__git config "$config_key")"
1127 fi
1128
1129 echo "$result"
1130}
1131
1132__git_has_doubledash ()
1133{
1134 local c=1
1135 while [ $c -lt $cword ]; do
1136 if [ "--" = "${words[c]}" ]; then
1137 return 0
1138 fi
1139 ((c++))
1140 done
1141 return 1
1142}
1143
1144# Try to count non option arguments passed on the command line for the
1145# specified git command.
1146# When options are used, it is necessary to use the special -- option to
1147# tell the implementation were non option arguments begin.
1148# XXX this can not be improved, since options can appear everywhere, as
1149# an example:
1150# git mv x -n y
1151#
1152# __git_count_arguments requires 1 argument: the git command executed.
1153__git_count_arguments ()
1154{
1155 local word i c=0
1156
1157 # Skip "git" (first argument)
1158 for ((i=1; i < ${#words[@]}; i++)); do
1159 word="${words[i]}"
1160
1161 case "$word" in
1162 --)
1163 # Good; we can assume that the following are only non
1164 # option arguments.
1165 ((c = 0))
1166 ;;
1167 "$1")
1168 # Skip the specified git command and discard git
1169 # main options
1170 ((c = 0))
1171 ;;
1172 ?*)
1173 ((c++))
1174 ;;
1175 esac
1176 done
1177
1178 printf "%d" $c
1179}
1180
1181__git_whitespacelist="nowarn warn error error-all fix"
1182__git_patchformat="mbox stgit stgit-series hg mboxrd"
1183__git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1184
1185_git_am ()
1186{
1187 __git_find_repo_path
1188 if [ -d "$__git_repo_path"/rebase-apply ]; then
1189 __gitcomp "$__git_am_inprogress_options"
1190 return
1191 fi
1192 case "$cur" in
1193 --whitespace=*)
1194 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1195 return
1196 ;;
1197 --patch-format=*)
1198 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1199 return
1200 ;;
1201 --*)
1202 __gitcomp_builtin am "" \
1203 "$__git_am_inprogress_options"
1204 return
1205 esac
1206}
1207
1208_git_apply ()
1209{
1210 case "$cur" in
1211 --whitespace=*)
1212 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1213 return
1214 ;;
1215 --*)
1216 __gitcomp_builtin apply
1217 return
1218 esac
1219}
1220
1221_git_add ()
1222{
1223 case "$cur" in
1224 --chmod=*)
1225 __gitcomp "+x -x" "" "${cur##--chmod=}"
1226 return
1227 ;;
1228 --*)
1229 __gitcomp_builtin add
1230 return
1231 esac
1232
1233 local complete_opt="--others --modified --directory --no-empty-directory"
1234 if test -n "$(__git_find_on_cmdline "-u --update")"
1235 then
1236 complete_opt="--modified"
1237 fi
1238 __git_complete_index_file "$complete_opt"
1239}
1240
1241_git_archive ()
1242{
1243 case "$cur" in
1244 --format=*)
1245 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1246 return
1247 ;;
1248 --remote=*)
1249 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1250 return
1251 ;;
1252 --*)
1253 __gitcomp "
1254 --format= --list --verbose
1255 --prefix= --remote= --exec= --output
1256 "
1257 return
1258 ;;
1259 esac
1260 __git_complete_file
1261}
1262
1263_git_bisect ()
1264{
1265 __git_has_doubledash && return
1266
1267 local subcommands="start bad good skip reset visualize replay log run"
1268 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1269 if [ -z "$subcommand" ]; then
1270 __git_find_repo_path
1271 if [ -f "$__git_repo_path"/BISECT_START ]; then
1272 __gitcomp "$subcommands"
1273 else
1274 __gitcomp "replay start"
1275 fi
1276 return
1277 fi
1278
1279 case "$subcommand" in
1280 bad|good|reset|skip|start)
1281 __git_complete_refs
1282 ;;
1283 *)
1284 ;;
1285 esac
1286}
1287
1288__git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1289
1290_git_branch ()
1291{
1292 local i c=1 only_local_ref="n" has_r="n"
1293
1294 while [ $c -lt $cword ]; do
1295 i="${words[c]}"
1296 case "$i" in
1297 -d|--delete|-m|--move) only_local_ref="y" ;;
1298 -r|--remotes) has_r="y" ;;
1299 esac
1300 ((c++))
1301 done
1302
1303 case "$cur" in
1304 --set-upstream-to=*)
1305 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1306 ;;
1307 --*)
1308 __gitcomp_builtin branch
1309 ;;
1310 *)
1311 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1312 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1313 else
1314 __git_complete_refs
1315 fi
1316 ;;
1317 esac
1318}
1319
1320_git_bundle ()
1321{
1322 local cmd="${words[2]}"
1323 case "$cword" in
1324 2)
1325 __gitcomp "create list-heads verify unbundle"
1326 ;;
1327 3)
1328 # looking for a file
1329 ;;
1330 *)
1331 case "$cmd" in
1332 create)
1333 __git_complete_revlist
1334 ;;
1335 esac
1336 ;;
1337 esac
1338}
1339
1340_git_checkout ()
1341{
1342 __git_has_doubledash && return
1343
1344 case "$cur" in
1345 --conflict=*)
1346 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1347 ;;
1348 --*)
1349 __gitcomp_builtin checkout
1350 ;;
1351 *)
1352 # check if --track, --no-track, or --no-guess was specified
1353 # if so, disable DWIM mode
1354 local flags="--track --no-track --no-guess" track_opt="--track"
1355 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
1356 [ -n "$(__git_find_on_cmdline "$flags")" ]; then
1357 track_opt=''
1358 fi
1359 __git_complete_refs $track_opt
1360 ;;
1361 esac
1362}
1363
1364__git_sequencer_inprogress_options="--continue --quit --abort --skip"
1365
1366__git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1367
1368_git_cherry_pick ()
1369{
1370 __git_find_repo_path
1371 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1372 __gitcomp "$__git_cherry_pick_inprogress_options"
1373 return
1374 fi
1375
1376 __git_complete_strategy && return
1377
1378 case "$cur" in
1379 --*)
1380 __gitcomp_builtin cherry-pick "" \
1381 "$__git_cherry_pick_inprogress_options"
1382 ;;
1383 *)
1384 __git_complete_refs
1385 ;;
1386 esac
1387}
1388
1389_git_clean ()
1390{
1391 case "$cur" in
1392 --*)
1393 __gitcomp_builtin clean
1394 return
1395 ;;
1396 esac
1397
1398 # XXX should we check for -x option ?
1399 __git_complete_index_file "--others --directory"
1400}
1401
1402_git_clone ()
1403{
1404 case "$prev" in
1405 -c|--config)
1406 __git_complete_config_variable_name_and_value
1407 return
1408 ;;
1409 esac
1410 case "$cur" in
1411 --config=*)
1412 __git_complete_config_variable_name_and_value \
1413 --cur="${cur##--config=}"
1414 return
1415 ;;
1416 --*)
1417 __gitcomp_builtin clone
1418 return
1419 ;;
1420 esac
1421}
1422
1423__git_untracked_file_modes="all no normal"
1424
1425_git_commit ()
1426{
1427 case "$prev" in
1428 -c|-C)
1429 __git_complete_refs
1430 return
1431 ;;
1432 esac
1433
1434 case "$cur" in
1435 --cleanup=*)
1436 __gitcomp "default scissors strip verbatim whitespace
1437 " "" "${cur##--cleanup=}"
1438 return
1439 ;;
1440 --reuse-message=*|--reedit-message=*|\
1441 --fixup=*|--squash=*)
1442 __git_complete_refs --cur="${cur#*=}"
1443 return
1444 ;;
1445 --untracked-files=*)
1446 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1447 return
1448 ;;
1449 --*)
1450 __gitcomp_builtin commit
1451 return
1452 esac
1453
1454 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1455 __git_complete_index_file "--committable"
1456 else
1457 # This is the first commit
1458 __git_complete_index_file "--cached"
1459 fi
1460}
1461
1462_git_describe ()
1463{
1464 case "$cur" in
1465 --*)
1466 __gitcomp_builtin describe
1467 return
1468 esac
1469 __git_complete_refs
1470}
1471
1472__git_diff_algorithms="myers minimal patience histogram"
1473
1474__git_diff_submodule_formats="diff log short"
1475
1476__git_diff_common_options="--stat --numstat --shortstat --summary
1477 --patch-with-stat --name-only --name-status --color
1478 --no-color --color-words --no-renames --check
1479 --full-index --binary --abbrev --diff-filter=
1480 --find-copies-harder --ignore-cr-at-eol
1481 --text --ignore-space-at-eol --ignore-space-change
1482 --ignore-all-space --ignore-blank-lines --exit-code
1483 --quiet --ext-diff --no-ext-diff
1484 --no-prefix --src-prefix= --dst-prefix=
1485 --inter-hunk-context=
1486 --patience --histogram --minimal
1487 --raw --word-diff --word-diff-regex=
1488 --dirstat --dirstat= --dirstat-by-file
1489 --dirstat-by-file= --cumulative
1490 --diff-algorithm=
1491 --submodule --submodule= --ignore-submodules
1492"
1493
1494_git_diff ()
1495{
1496 __git_has_doubledash && return
1497
1498 case "$cur" in
1499 --diff-algorithm=*)
1500 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1501 return
1502 ;;
1503 --submodule=*)
1504 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1505 return
1506 ;;
1507 --*)
1508 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1509 --base --ours --theirs --no-index
1510 $__git_diff_common_options
1511 "
1512 return
1513 ;;
1514 esac
1515 __git_complete_revlist_file
1516}
1517
1518__git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1519 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc
1520 codecompare smerge
1521"
1522
1523_git_difftool ()
1524{
1525 __git_has_doubledash && return
1526
1527 case "$cur" in
1528 --tool=*)
1529 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1530 return
1531 ;;
1532 --*)
1533 __gitcomp_builtin difftool "$__git_diff_common_options
1534 --base --cached --ours --theirs
1535 --pickaxe-all --pickaxe-regex
1536 --relative --staged
1537 "
1538 return
1539 ;;
1540 esac
1541 __git_complete_revlist_file
1542}
1543
1544__git_fetch_recurse_submodules="yes on-demand no"
1545
1546_git_fetch ()
1547{
1548 case "$cur" in
1549 --recurse-submodules=*)
1550 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1551 return
1552 ;;
1553 --filter=*)
1554 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1555 return
1556 ;;
1557 --*)
1558 __gitcomp_builtin fetch
1559 return
1560 ;;
1561 esac
1562 __git_complete_remote_or_refspec
1563}
1564
1565__git_format_patch_extra_options="
1566 --full-index --not --all --no-prefix --src-prefix=
1567 --dst-prefix= --notes
1568"
1569
1570_git_format_patch ()
1571{
1572 case "$cur" in
1573 --thread=*)
1574 __gitcomp "
1575 deep shallow
1576 " "" "${cur##--thread=}"
1577 return
1578 ;;
1579 --*)
1580 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1581 return
1582 ;;
1583 esac
1584 __git_complete_revlist
1585}
1586
1587_git_fsck ()
1588{
1589 case "$cur" in
1590 --*)
1591 __gitcomp_builtin fsck
1592 return
1593 ;;
1594 esac
1595}
1596
1597_git_gitk ()
1598{
1599 _gitk
1600}
1601
1602# Lists matching symbol names from a tag (as in ctags) file.
1603# 1: List symbol names matching this word.
1604# 2: The tag file to list symbol names from.
1605# 3: A prefix to be added to each listed symbol name (optional).
1606# 4: A suffix to be appended to each listed symbol name (optional).
1607__git_match_ctag () {
1608 awk -v pfx="${3-}" -v sfx="${4-}" "
1609 /^${1//\//\\/}/ { print pfx \$1 sfx }
1610 " "$2"
1611}
1612
1613# Complete symbol names from a tag file.
1614# Usage: __git_complete_symbol [<option>]...
1615# --tags=<file>: The tag file to list symbol names from instead of the
1616# default "tags".
1617# --pfx=<prefix>: A prefix to be added to each symbol name.
1618# --cur=<word>: The current symbol name to be completed. Defaults to
1619# the current word to be completed.
1620# --sfx=<suffix>: A suffix to be appended to each symbol name instead
1621# of the default space.
1622__git_complete_symbol () {
1623 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1624
1625 while test $# != 0; do
1626 case "$1" in
1627 --tags=*) tags="${1##--tags=}" ;;
1628 --pfx=*) pfx="${1##--pfx=}" ;;
1629 --cur=*) cur_="${1##--cur=}" ;;
1630 --sfx=*) sfx="${1##--sfx=}" ;;
1631 *) return 1 ;;
1632 esac
1633 shift
1634 done
1635
1636 if test -r "$tags"; then
1637 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1638 fi
1639}
1640
1641_git_grep ()
1642{
1643 __git_has_doubledash && return
1644
1645 case "$cur" in
1646 --*)
1647 __gitcomp_builtin grep
1648 return
1649 ;;
1650 esac
1651
1652 case "$cword,$prev" in
1653 2,*|*,-*)
1654 __git_complete_symbol && return
1655 ;;
1656 esac
1657
1658 __git_complete_refs
1659}
1660
1661_git_help ()
1662{
1663 case "$cur" in
1664 --*)
1665 __gitcomp_builtin help
1666 return
1667 ;;
1668 esac
1669 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1670 then
1671 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1672 else
1673 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1674 fi
1675}
1676
1677_git_init ()
1678{
1679 case "$cur" in
1680 --shared=*)
1681 __gitcomp "
1682 false true umask group all world everybody
1683 " "" "${cur##--shared=}"
1684 return
1685 ;;
1686 --*)
1687 __gitcomp_builtin init
1688 return
1689 ;;
1690 esac
1691}
1692
1693_git_ls_files ()
1694{
1695 case "$cur" in
1696 --*)
1697 __gitcomp_builtin ls-files
1698 return
1699 ;;
1700 esac
1701
1702 # XXX ignore options like --modified and always suggest all cached
1703 # files.
1704 __git_complete_index_file "--cached"
1705}
1706
1707_git_ls_remote ()
1708{
1709 case "$cur" in
1710 --*)
1711 __gitcomp_builtin ls-remote
1712 return
1713 ;;
1714 esac
1715 __gitcomp_nl "$(__git_remotes)"
1716}
1717
1718_git_ls_tree ()
1719{
1720 case "$cur" in
1721 --*)
1722 __gitcomp_builtin ls-tree
1723 return
1724 ;;
1725 esac
1726
1727 __git_complete_file
1728}
1729
1730# Options that go well for log, shortlog and gitk
1731__git_log_common_options="
1732 --not --all
1733 --branches --tags --remotes
1734 --first-parent --merges --no-merges
1735 --max-count=
1736 --max-age= --since= --after=
1737 --min-age= --until= --before=
1738 --min-parents= --max-parents=
1739 --no-min-parents --no-max-parents
1740"
1741# Options that go well for log and gitk (not shortlog)
1742__git_log_gitk_options="
1743 --dense --sparse --full-history
1744 --simplify-merges --simplify-by-decoration
1745 --left-right --notes --no-notes
1746"
1747# Options that go well for log and shortlog (not gitk)
1748__git_log_shortlog_options="
1749 --author= --committer= --grep=
1750 --all-match --invert-grep
1751"
1752
1753__git_log_pretty_formats="oneline short medium full fuller email raw format: mboxrd"
1754__git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1755
1756_git_log ()
1757{
1758 __git_has_doubledash && return
1759 __git_find_repo_path
1760
1761 local merge=""
1762 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1763 merge="--merge"
1764 fi
1765 case "$prev,$cur" in
1766 -L,:*:*)
1767 return # fall back to Bash filename completion
1768 ;;
1769 -L,:*)
1770 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1771 return
1772 ;;
1773 -G,*|-S,*)
1774 __git_complete_symbol
1775 return
1776 ;;
1777 esac
1778 case "$cur" in
1779 --pretty=*|--format=*)
1780 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1781 " "" "${cur#*=}"
1782 return
1783 ;;
1784 --date=*)
1785 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1786 return
1787 ;;
1788 --decorate=*)
1789 __gitcomp "full short no" "" "${cur##--decorate=}"
1790 return
1791 ;;
1792 --diff-algorithm=*)
1793 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1794 return
1795 ;;
1796 --submodule=*)
1797 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1798 return
1799 ;;
1800 --*)
1801 __gitcomp "
1802 $__git_log_common_options
1803 $__git_log_shortlog_options
1804 $__git_log_gitk_options
1805 --root --topo-order --date-order --reverse
1806 --follow --full-diff
1807 --abbrev-commit --abbrev=
1808 --relative-date --date=
1809 --pretty= --format= --oneline
1810 --show-signature
1811 --cherry-mark
1812 --cherry-pick
1813 --graph
1814 --decorate --decorate=
1815 --walk-reflogs
1816 --parents --children
1817 $merge
1818 $__git_diff_common_options
1819 --pickaxe-all --pickaxe-regex
1820 "
1821 return
1822 ;;
1823 -L:*:*)
1824 return # fall back to Bash filename completion
1825 ;;
1826 -L:*)
1827 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
1828 return
1829 ;;
1830 -G*)
1831 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
1832 return
1833 ;;
1834 -S*)
1835 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
1836 return
1837 ;;
1838 esac
1839 __git_complete_revlist
1840}
1841
1842_git_merge ()
1843{
1844 __git_complete_strategy && return
1845
1846 case "$cur" in
1847 --*)
1848 __gitcomp_builtin merge
1849 return
1850 esac
1851 __git_complete_refs
1852}
1853
1854_git_mergetool ()
1855{
1856 case "$cur" in
1857 --tool=*)
1858 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
1859 return
1860 ;;
1861 --*)
1862 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
1863 return
1864 ;;
1865 esac
1866}
1867
1868_git_merge_base ()
1869{
1870 case "$cur" in
1871 --*)
1872 __gitcomp_builtin merge-base
1873 return
1874 ;;
1875 esac
1876 __git_complete_refs
1877}
1878
1879_git_mv ()
1880{
1881 case "$cur" in
1882 --*)
1883 __gitcomp_builtin mv
1884 return
1885 ;;
1886 esac
1887
1888 if [ $(__git_count_arguments "mv") -gt 0 ]; then
1889 # We need to show both cached and untracked files (including
1890 # empty directories) since this may not be the last argument.
1891 __git_complete_index_file "--cached --others --directory"
1892 else
1893 __git_complete_index_file "--cached"
1894 fi
1895}
1896
1897_git_notes ()
1898{
1899 local subcommands='add append copy edit get-ref list merge prune remove show'
1900 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1901
1902 case "$subcommand,$cur" in
1903 ,--*)
1904 __gitcomp_builtin notes
1905 ;;
1906 ,*)
1907 case "$prev" in
1908 --ref)
1909 __git_complete_refs
1910 ;;
1911 *)
1912 __gitcomp "$subcommands --ref"
1913 ;;
1914 esac
1915 ;;
1916 *,--reuse-message=*|*,--reedit-message=*)
1917 __git_complete_refs --cur="${cur#*=}"
1918 ;;
1919 *,--*)
1920 __gitcomp_builtin notes_$subcommand
1921 ;;
1922 prune,*|get-ref,*)
1923 # this command does not take a ref, do not complete it
1924 ;;
1925 *)
1926 case "$prev" in
1927 -m|-F)
1928 ;;
1929 *)
1930 __git_complete_refs
1931 ;;
1932 esac
1933 ;;
1934 esac
1935}
1936
1937_git_pull ()
1938{
1939 __git_complete_strategy && return
1940
1941 case "$cur" in
1942 --recurse-submodules=*)
1943 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1944 return
1945 ;;
1946 --*)
1947 __gitcomp_builtin pull
1948
1949 return
1950 ;;
1951 esac
1952 __git_complete_remote_or_refspec
1953}
1954
1955__git_push_recurse_submodules="check on-demand only"
1956
1957__git_complete_force_with_lease ()
1958{
1959 local cur_=$1
1960
1961 case "$cur_" in
1962 --*=)
1963 ;;
1964 *:*)
1965 __git_complete_refs --cur="${cur_#*:}"
1966 ;;
1967 *)
1968 __git_complete_refs --cur="$cur_"
1969 ;;
1970 esac
1971}
1972
1973_git_push ()
1974{
1975 case "$prev" in
1976 --repo)
1977 __gitcomp_nl "$(__git_remotes)"
1978 return
1979 ;;
1980 --recurse-submodules)
1981 __gitcomp "$__git_push_recurse_submodules"
1982 return
1983 ;;
1984 esac
1985 case "$cur" in
1986 --repo=*)
1987 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
1988 return
1989 ;;
1990 --recurse-submodules=*)
1991 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
1992 return
1993 ;;
1994 --force-with-lease=*)
1995 __git_complete_force_with_lease "${cur##--force-with-lease=}"
1996 return
1997 ;;
1998 --*)
1999 __gitcomp_builtin push
2000 return
2001 ;;
2002 esac
2003 __git_complete_remote_or_refspec
2004}
2005
2006_git_range_diff ()
2007{
2008 case "$cur" in
2009 --*)
2010 __gitcomp "
2011 --creation-factor= --no-dual-color
2012 $__git_diff_common_options
2013 "
2014 return
2015 ;;
2016 esac
2017 __git_complete_revlist
2018}
2019
2020_git_rebase ()
2021{
2022 __git_find_repo_path
2023 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2024 __gitcomp "--continue --skip --abort --quit --edit-todo --show-current-patch"
2025 return
2026 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2027 [ -d "$__git_repo_path"/rebase-merge ]; then
2028 __gitcomp "--continue --skip --abort --quit --show-current-patch"
2029 return
2030 fi
2031 __git_complete_strategy && return
2032 case "$cur" in
2033 --whitespace=*)
2034 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2035 return
2036 ;;
2037 --*)
2038 __gitcomp "
2039 --onto --merge --strategy --interactive
2040 --rebase-merges --preserve-merges --stat --no-stat
2041 --committer-date-is-author-date --ignore-date
2042 --ignore-whitespace --whitespace=
2043 --autosquash --no-autosquash
2044 --fork-point --no-fork-point
2045 --autostash --no-autostash
2046 --verify --no-verify --keep-base
2047 --keep-empty --root --force-rebase --no-ff
2048 --rerere-autoupdate
2049 --exec
2050 "
2051
2052 return
2053 esac
2054 __git_complete_refs
2055}
2056
2057_git_reflog ()
2058{
2059 local subcommands="show delete expire"
2060 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2061
2062 if [ -z "$subcommand" ]; then
2063 __gitcomp "$subcommands"
2064 else
2065 __git_complete_refs
2066 fi
2067}
2068
2069__git_send_email_confirm_options="always never auto cc compose"
2070__git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2071
2072_git_send_email ()
2073{
2074 case "$prev" in
2075 --to|--cc|--bcc|--from)
2076 __gitcomp "$(__git send-email --dump-aliases)"
2077 return
2078 ;;
2079 esac
2080
2081 case "$cur" in
2082 --confirm=*)
2083 __gitcomp "
2084 $__git_send_email_confirm_options
2085 " "" "${cur##--confirm=}"
2086 return
2087 ;;
2088 --suppress-cc=*)
2089 __gitcomp "
2090 $__git_send_email_suppresscc_options
2091 " "" "${cur##--suppress-cc=}"
2092
2093 return
2094 ;;
2095 --smtp-encryption=*)
2096 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2097 return
2098 ;;
2099 --thread=*)
2100 __gitcomp "
2101 deep shallow
2102 " "" "${cur##--thread=}"
2103 return
2104 ;;
2105 --to=*|--cc=*|--bcc=*|--from=*)
2106 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2107 return
2108 ;;
2109 --*)
2110 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2111 --compose --confirm= --dry-run --envelope-sender
2112 --from --identity
2113 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2114 --no-suppress-from --no-thread --quiet --reply-to
2115 --signed-off-by-cc --smtp-pass --smtp-server
2116 --smtp-server-port --smtp-encryption= --smtp-user
2117 --subject --suppress-cc= --suppress-from --thread --to
2118 --validate --no-validate
2119 $__git_format_patch_extra_options"
2120 return
2121 ;;
2122 esac
2123 __git_complete_revlist
2124}
2125
2126_git_stage ()
2127{
2128 _git_add
2129}
2130
2131_git_status ()
2132{
2133 local complete_opt
2134 local untracked_state
2135
2136 case "$cur" in
2137 --ignore-submodules=*)
2138 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2139 return
2140 ;;
2141 --untracked-files=*)
2142 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2143 return
2144 ;;
2145 --column=*)
2146 __gitcomp "
2147 always never auto column row plain dense nodense
2148 " "" "${cur##--column=}"
2149 return
2150 ;;
2151 --*)
2152 __gitcomp_builtin status
2153 return
2154 ;;
2155 esac
2156
2157 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2158 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2159
2160 case "$untracked_state" in
2161 no)
2162 # --ignored option does not matter
2163 complete_opt=
2164 ;;
2165 all|normal|*)
2166 complete_opt="--cached --directory --no-empty-directory --others"
2167
2168 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2169 complete_opt="$complete_opt --ignored --exclude=*"
2170 fi
2171 ;;
2172 esac
2173
2174 __git_complete_index_file "$complete_opt"
2175}
2176
2177_git_switch ()
2178{
2179 case "$cur" in
2180 --conflict=*)
2181 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2182 ;;
2183 --*)
2184 __gitcomp_builtin switch
2185 ;;
2186 *)
2187 # check if --track, --no-track, or --no-guess was specified
2188 # if so, disable DWIM mode
2189 local track_opt="--track" only_local_ref=n
2190 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
2191 [ -n "$(__git_find_on_cmdline "--track --no-track --no-guess")" ]; then
2192 track_opt=''
2193 fi
2194 # explicit --guess enables DWIM mode regardless of
2195 # $GIT_COMPLETION_CHECKOUT_NO_GUESS
2196 if [ -n "$(__git_find_on_cmdline "--guess")" ]; then
2197 track_opt='--track'
2198 fi
2199 if [ -z "$(__git_find_on_cmdline "-d --detach")" ]; then
2200 only_local_ref=y
2201 else
2202 # --guess --detach is invalid combination, no
2203 # dwim will be done when --detach is specified
2204 track_opt=
2205 fi
2206 if [ $only_local_ref = y -a -z "$track_opt" ]; then
2207 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
2208 else
2209 __git_complete_refs $track_opt
2210 fi
2211 ;;
2212 esac
2213}
2214
2215__git_config_get_set_variables ()
2216{
2217 local prevword word config_file= c=$cword
2218 while [ $c -gt 1 ]; do
2219 word="${words[c]}"
2220 case "$word" in
2221 --system|--global|--local|--file=*)
2222 config_file="$word"
2223 break
2224 ;;
2225 -f|--file)
2226 config_file="$word $prevword"
2227 break
2228 ;;
2229 esac
2230 prevword=$word
2231 c=$((--c))
2232 done
2233
2234 __git config $config_file --name-only --list
2235}
2236
2237__git_config_vars=
2238__git_compute_config_vars ()
2239{
2240 test -n "$__git_config_vars" ||
2241 __git_config_vars="$(git help --config-for-completion | sort -u)"
2242}
2243
2244# Completes possible values of various configuration variables.
2245#
2246# Usage: __git_complete_config_variable_value [<option>]...
2247# --varname=<word>: The name of the configuration variable whose value is
2248# to be completed. Defaults to the previous word on the
2249# command line.
2250# --cur=<word>: The current value to be completed. Defaults to the current
2251# word to be completed.
2252__git_complete_config_variable_value ()
2253{
2254 local varname="$prev" cur_="$cur"
2255
2256 while test $# != 0; do
2257 case "$1" in
2258 --varname=*) varname="${1##--varname=}" ;;
2259 --cur=*) cur_="${1##--cur=}" ;;
2260 *) return 1 ;;
2261 esac
2262 shift
2263 done
2264
2265 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2266 varname="${varname,,}"
2267 else
2268 varname="$(echo "$varname" |tr A-Z a-z)"
2269 fi
2270
2271 case "$varname" in
2272 branch.*.remote|branch.*.pushremote)
2273 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2274 return
2275 ;;
2276 branch.*.merge)
2277 __git_complete_refs --cur="$cur_"
2278 return
2279 ;;
2280 branch.*.rebase)
2281 __gitcomp "false true merges preserve interactive" "" "$cur_"
2282 return
2283 ;;
2284 remote.pushdefault)
2285 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2286 return
2287 ;;
2288 remote.*.fetch)
2289 local remote="${varname#remote.}"
2290 remote="${remote%.fetch}"
2291 if [ -z "$cur_" ]; then
2292 __gitcomp_nl "refs/heads/" "" "" ""
2293 return
2294 fi
2295 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2296 return
2297 ;;
2298 remote.*.push)
2299 local remote="${varname#remote.}"
2300 remote="${remote%.push}"
2301 __gitcomp_nl "$(__git for-each-ref \
2302 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2303 return
2304 ;;
2305 pull.twohead|pull.octopus)
2306 __git_compute_merge_strategies
2307 __gitcomp "$__git_merge_strategies" "" "$cur_"
2308 return
2309 ;;
2310 color.pager)
2311 __gitcomp "false true" "" "$cur_"
2312 return
2313 ;;
2314 color.*.*)
2315 __gitcomp "
2316 normal black red green yellow blue magenta cyan white
2317 bold dim ul blink reverse
2318 " "" "$cur_"
2319 return
2320 ;;
2321 color.*)
2322 __gitcomp "false true always never auto" "" "$cur_"
2323 return
2324 ;;
2325 diff.submodule)
2326 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2327 return
2328 ;;
2329 help.format)
2330 __gitcomp "man info web html" "" "$cur_"
2331 return
2332 ;;
2333 log.date)
2334 __gitcomp "$__git_log_date_formats" "" "$cur_"
2335 return
2336 ;;
2337 sendemail.aliasfiletype)
2338 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2339 return
2340 ;;
2341 sendemail.confirm)
2342 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2343 return
2344 ;;
2345 sendemail.suppresscc)
2346 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2347 return
2348 ;;
2349 sendemail.transferencoding)
2350 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2351 return
2352 ;;
2353 *.*)
2354 return
2355 ;;
2356 esac
2357}
2358
2359# Completes configuration sections, subsections, variable names.
2360#
2361# Usage: __git_complete_config_variable_name [<option>]...
2362# --cur=<word>: The current configuration section/variable name to be
2363# completed. Defaults to the current word to be completed.
2364# --sfx=<suffix>: A suffix to be appended to each fully completed
2365# configuration variable name (but not to sections or
2366# subsections) instead of the default space.
2367__git_complete_config_variable_name ()
2368{
2369 local cur_="$cur" sfx
2370
2371 while test $# != 0; do
2372 case "$1" in
2373 --cur=*) cur_="${1##--cur=}" ;;
2374 --sfx=*) sfx="${1##--sfx=}" ;;
2375 *) return 1 ;;
2376 esac
2377 shift
2378 done
2379
2380 case "$cur_" in
2381 branch.*.*)
2382 local pfx="${cur_%.*}."
2383 cur_="${cur_##*.}"
2384 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2385 return
2386 ;;
2387 branch.*)
2388 local pfx="${cur%.*}."
2389 cur_="${cur#*.}"
2390 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2391 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2392 return
2393 ;;
2394 guitool.*.*)
2395 local pfx="${cur_%.*}."
2396 cur_="${cur_##*.}"
2397 __gitcomp "
2398 argPrompt cmd confirm needsFile noConsole noRescan
2399 prompt revPrompt revUnmerged title
2400 " "$pfx" "$cur_" "$sfx"
2401 return
2402 ;;
2403 difftool.*.*)
2404 local pfx="${cur_%.*}."
2405 cur_="${cur_##*.}"
2406 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2407 return
2408 ;;
2409 man.*.*)
2410 local pfx="${cur_%.*}."
2411 cur_="${cur_##*.}"
2412 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2413 return
2414 ;;
2415 mergetool.*.*)
2416 local pfx="${cur_%.*}."
2417 cur_="${cur_##*.}"
2418 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2419 return
2420 ;;
2421 pager.*)
2422 local pfx="${cur_%.*}."
2423 cur_="${cur_#*.}"
2424 __git_compute_all_commands
2425 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2426 return
2427 ;;
2428 remote.*.*)
2429 local pfx="${cur_%.*}."
2430 cur_="${cur_##*.}"
2431 __gitcomp "
2432 url proxy fetch push mirror skipDefaultUpdate
2433 receivepack uploadpack tagOpt pushurl
2434 " "$pfx" "$cur_" "$sfx"
2435 return
2436 ;;
2437 remote.*)
2438 local pfx="${cur_%.*}."
2439 cur_="${cur_#*.}"
2440 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2441 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2442 return
2443 ;;
2444 url.*.*)
2445 local pfx="${cur_%.*}."
2446 cur_="${cur_##*.}"
2447 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2448 return
2449 ;;
2450 *.*)
2451 __git_compute_config_vars
2452 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2453 ;;
2454 *)
2455 __git_compute_config_vars
2456 __gitcomp "$(echo "$__git_config_vars" |
2457 awk -F . '{
2458 sections[$1] = 1
2459 }
2460 END {
2461 for (s in sections)
2462 print s "."
2463 }
2464 ')" "" "$cur_"
2465 ;;
2466 esac
2467}
2468
2469# Completes '='-separated configuration sections/variable names and values
2470# for 'git -c section.name=value'.
2471#
2472# Usage: __git_complete_config_variable_name_and_value [<option>]...
2473# --cur=<word>: The current configuration section/variable name/value to be
2474# completed. Defaults to the current word to be completed.
2475__git_complete_config_variable_name_and_value ()
2476{
2477 local cur_="$cur"
2478
2479 while test $# != 0; do
2480 case "$1" in
2481 --cur=*) cur_="${1##--cur=}" ;;
2482 *) return 1 ;;
2483 esac
2484 shift
2485 done
2486
2487 case "$cur_" in
2488 *=*)
2489 __git_complete_config_variable_value \
2490 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2491 ;;
2492 *)
2493 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2494 ;;
2495 esac
2496}
2497
2498_git_config ()
2499{
2500 case "$prev" in
2501 --get|--get-all|--unset|--unset-all)
2502 __gitcomp_nl "$(__git_config_get_set_variables)"
2503 return
2504 ;;
2505 *.*)
2506 __git_complete_config_variable_value
2507 return
2508 ;;
2509 esac
2510 case "$cur" in
2511 --*)
2512 __gitcomp_builtin config
2513 ;;
2514 *)
2515 __git_complete_config_variable_name
2516 ;;
2517 esac
2518}
2519
2520_git_remote ()
2521{
2522 local subcommands="
2523 add rename remove set-head set-branches
2524 get-url set-url show prune update
2525 "
2526 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2527 if [ -z "$subcommand" ]; then
2528 case "$cur" in
2529 --*)
2530 __gitcomp_builtin remote
2531 ;;
2532 *)
2533 __gitcomp "$subcommands"
2534 ;;
2535 esac
2536 return
2537 fi
2538
2539 case "$subcommand,$cur" in
2540 add,--*)
2541 __gitcomp_builtin remote_add
2542 ;;
2543 add,*)
2544 ;;
2545 set-head,--*)
2546 __gitcomp_builtin remote_set-head
2547 ;;
2548 set-branches,--*)
2549 __gitcomp_builtin remote_set-branches
2550 ;;
2551 set-head,*|set-branches,*)
2552 __git_complete_remote_or_refspec
2553 ;;
2554 update,--*)
2555 __gitcomp_builtin remote_update
2556 ;;
2557 update,*)
2558 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2559 ;;
2560 set-url,--*)
2561 __gitcomp_builtin remote_set-url
2562 ;;
2563 get-url,--*)
2564 __gitcomp_builtin remote_get-url
2565 ;;
2566 prune,--*)
2567 __gitcomp_builtin remote_prune
2568 ;;
2569 *)
2570 __gitcomp_nl "$(__git_remotes)"
2571 ;;
2572 esac
2573}
2574
2575_git_replace ()
2576{
2577 case "$cur" in
2578 --format=*)
2579 __gitcomp "short medium long" "" "${cur##--format=}"
2580 return
2581 ;;
2582 --*)
2583 __gitcomp_builtin replace
2584 return
2585 ;;
2586 esac
2587 __git_complete_refs
2588}
2589
2590_git_rerere ()
2591{
2592 local subcommands="clear forget diff remaining status gc"
2593 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2594 if test -z "$subcommand"
2595 then
2596 __gitcomp "$subcommands"
2597 return
2598 fi
2599}
2600
2601_git_reset ()
2602{
2603 __git_has_doubledash && return
2604
2605 case "$cur" in
2606 --*)
2607 __gitcomp_builtin reset
2608 return
2609 ;;
2610 esac
2611 __git_complete_refs
2612}
2613
2614_git_restore ()
2615{
2616 case "$cur" in
2617 --conflict=*)
2618 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2619 ;;
2620 --source=*)
2621 __git_complete_refs --cur="${cur##--source=}"
2622 ;;
2623 --*)
2624 __gitcomp_builtin restore
2625 ;;
2626 esac
2627}
2628
2629__git_revert_inprogress_options=$__git_sequencer_inprogress_options
2630
2631_git_revert ()
2632{
2633 __git_find_repo_path
2634 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2635 __gitcomp "$__git_revert_inprogress_options"
2636 return
2637 fi
2638 __git_complete_strategy && return
2639 case "$cur" in
2640 --*)
2641 __gitcomp_builtin revert "" \
2642 "$__git_revert_inprogress_options"
2643 return
2644 ;;
2645 esac
2646 __git_complete_refs
2647}
2648
2649_git_rm ()
2650{
2651 case "$cur" in
2652 --*)
2653 __gitcomp_builtin rm
2654 return
2655 ;;
2656 esac
2657
2658 __git_complete_index_file "--cached"
2659}
2660
2661_git_shortlog ()
2662{
2663 __git_has_doubledash && return
2664
2665 case "$cur" in
2666 --*)
2667 __gitcomp "
2668 $__git_log_common_options
2669 $__git_log_shortlog_options
2670 --numbered --summary --email
2671 "
2672 return
2673 ;;
2674 esac
2675 __git_complete_revlist
2676}
2677
2678_git_show ()
2679{
2680 __git_has_doubledash && return
2681
2682 case "$cur" in
2683 --pretty=*|--format=*)
2684 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2685 " "" "${cur#*=}"
2686 return
2687 ;;
2688 --diff-algorithm=*)
2689 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2690 return
2691 ;;
2692 --submodule=*)
2693 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2694 return
2695 ;;
2696 --*)
2697 __gitcomp "--pretty= --format= --abbrev-commit --oneline
2698 --show-signature
2699 $__git_diff_common_options
2700 "
2701 return
2702 ;;
2703 esac
2704 __git_complete_revlist_file
2705}
2706
2707_git_show_branch ()
2708{
2709 case "$cur" in
2710 --*)
2711 __gitcomp_builtin show-branch
2712 return
2713 ;;
2714 esac
2715 __git_complete_revlist
2716}
2717
2718_git_stash ()
2719{
2720 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2721 local subcommands='push list show apply clear drop pop create branch'
2722 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2723 if [ -n "$(__git_find_on_cmdline "-p")" ]; then
2724 subcommand="push"
2725 fi
2726 if [ -z "$subcommand" ]; then
2727 case "$cur" in
2728 --*)
2729 __gitcomp "$save_opts"
2730 ;;
2731 sa*)
2732 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2733 __gitcomp "save"
2734 fi
2735 ;;
2736 *)
2737 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2738 __gitcomp "$subcommands"
2739 fi
2740 ;;
2741 esac
2742 else
2743 case "$subcommand,$cur" in
2744 push,--*)
2745 __gitcomp "$save_opts --message"
2746 ;;
2747 save,--*)
2748 __gitcomp "$save_opts"
2749 ;;
2750 apply,--*|pop,--*)
2751 __gitcomp "--index --quiet"
2752 ;;
2753 drop,--*)
2754 __gitcomp "--quiet"
2755 ;;
2756 list,--*)
2757 __gitcomp "--name-status --oneline --patch-with-stat"
2758 ;;
2759 show,--*|branch,--*)
2760 ;;
2761 branch,*)
2762 if [ $cword -eq 3 ]; then
2763 __git_complete_refs
2764 else
2765 __gitcomp_nl "$(__git stash list \
2766 | sed -n -e 's/:.*//p')"
2767 fi
2768 ;;
2769 show,*|apply,*|drop,*|pop,*)
2770 __gitcomp_nl "$(__git stash list \
2771 | sed -n -e 's/:.*//p')"
2772 ;;
2773 *)
2774 ;;
2775 esac
2776 fi
2777}
2778
2779_git_submodule ()
2780{
2781 __git_has_doubledash && return
2782
2783 local subcommands="add status init deinit update set-branch summary foreach sync absorbgitdirs"
2784 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2785 if [ -z "$subcommand" ]; then
2786 case "$cur" in
2787 --*)
2788 __gitcomp "--quiet"
2789 ;;
2790 *)
2791 __gitcomp "$subcommands"
2792 ;;
2793 esac
2794 return
2795 fi
2796
2797 case "$subcommand,$cur" in
2798 add,--*)
2799 __gitcomp "--branch --force --name --reference --depth"
2800 ;;
2801 status,--*)
2802 __gitcomp "--cached --recursive"
2803 ;;
2804 deinit,--*)
2805 __gitcomp "--force --all"
2806 ;;
2807 update,--*)
2808 __gitcomp "
2809 --init --remote --no-fetch
2810 --recommend-shallow --no-recommend-shallow
2811 --force --rebase --merge --reference --depth --recursive --jobs
2812 "
2813 ;;
2814 set-branch,--*)
2815 __gitcomp "--default --branch"
2816 ;;
2817 summary,--*)
2818 __gitcomp "--cached --files --summary-limit"
2819 ;;
2820 foreach,--*|sync,--*)
2821 __gitcomp "--recursive"
2822 ;;
2823 *)
2824 ;;
2825 esac
2826}
2827
2828_git_svn ()
2829{
2830 local subcommands="
2831 init fetch clone rebase dcommit log find-rev
2832 set-tree commit-diff info create-ignore propget
2833 proplist show-ignore show-externals branch tag blame
2834 migrate mkdirs reset gc
2835 "
2836 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2837 if [ -z "$subcommand" ]; then
2838 __gitcomp "$subcommands"
2839 else
2840 local remote_opts="--username= --config-dir= --no-auth-cache"
2841 local fc_opts="
2842 --follow-parent --authors-file= --repack=
2843 --no-metadata --use-svm-props --use-svnsync-props
2844 --log-window-size= --no-checkout --quiet
2845 --repack-flags --use-log-author --localtime
2846 --add-author-from
2847 --ignore-paths= --include-paths= $remote_opts
2848 "
2849 local init_opts="
2850 --template= --shared= --trunk= --tags=
2851 --branches= --stdlayout --minimize-url
2852 --no-metadata --use-svm-props --use-svnsync-props
2853 --rewrite-root= --prefix= $remote_opts
2854 "
2855 local cmt_opts="
2856 --edit --rmdir --find-copies-harder --copy-similarity=
2857 "
2858
2859 case "$subcommand,$cur" in
2860 fetch,--*)
2861 __gitcomp "--revision= --fetch-all $fc_opts"
2862 ;;
2863 clone,--*)
2864 __gitcomp "--revision= $fc_opts $init_opts"
2865 ;;
2866 init,--*)
2867 __gitcomp "$init_opts"
2868 ;;
2869 dcommit,--*)
2870 __gitcomp "
2871 --merge --strategy= --verbose --dry-run
2872 --fetch-all --no-rebase --commit-url
2873 --revision --interactive $cmt_opts $fc_opts
2874 "
2875 ;;
2876 set-tree,--*)
2877 __gitcomp "--stdin $cmt_opts $fc_opts"
2878 ;;
2879 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
2880 show-externals,--*|mkdirs,--*)
2881 __gitcomp "--revision="
2882 ;;
2883 log,--*)
2884 __gitcomp "
2885 --limit= --revision= --verbose --incremental
2886 --oneline --show-commit --non-recursive
2887 --authors-file= --color
2888 "
2889 ;;
2890 rebase,--*)
2891 __gitcomp "
2892 --merge --verbose --strategy= --local
2893 --fetch-all --dry-run $fc_opts
2894 "
2895 ;;
2896 commit-diff,--*)
2897 __gitcomp "--message= --file= --revision= $cmt_opts"
2898 ;;
2899 info,--*)
2900 __gitcomp "--url"
2901 ;;
2902 branch,--*)
2903 __gitcomp "--dry-run --message --tag"
2904 ;;
2905 tag,--*)
2906 __gitcomp "--dry-run --message"
2907 ;;
2908 blame,--*)
2909 __gitcomp "--git-format"
2910 ;;
2911 migrate,--*)
2912 __gitcomp "
2913 --config-dir= --ignore-paths= --minimize
2914 --no-auth-cache --username=
2915 "
2916 ;;
2917 reset,--*)
2918 __gitcomp "--revision= --parent"
2919 ;;
2920 *)
2921 ;;
2922 esac
2923 fi
2924}
2925
2926_git_tag ()
2927{
2928 local i c=1 f=0
2929 while [ $c -lt $cword ]; do
2930 i="${words[c]}"
2931 case "$i" in
2932 -d|--delete|-v|--verify)
2933 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
2934 return
2935 ;;
2936 -f)
2937 f=1
2938 ;;
2939 esac
2940 ((c++))
2941 done
2942
2943 case "$prev" in
2944 -m|-F)
2945 ;;
2946 -*|tag)
2947 if [ $f = 1 ]; then
2948 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
2949 fi
2950 ;;
2951 *)
2952 __git_complete_refs
2953 ;;
2954 esac
2955
2956 case "$cur" in
2957 --*)
2958 __gitcomp_builtin tag
2959 ;;
2960 esac
2961}
2962
2963_git_whatchanged ()
2964{
2965 _git_log
2966}
2967
2968_git_worktree ()
2969{
2970 local subcommands="add list lock move prune remove unlock"
2971 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2972 if [ -z "$subcommand" ]; then
2973 __gitcomp "$subcommands"
2974 else
2975 case "$subcommand,$cur" in
2976 add,--*)
2977 __gitcomp_builtin worktree_add
2978 ;;
2979 list,--*)
2980 __gitcomp_builtin worktree_list
2981 ;;
2982 lock,--*)
2983 __gitcomp_builtin worktree_lock
2984 ;;
2985 prune,--*)
2986 __gitcomp_builtin worktree_prune
2987 ;;
2988 remove,--*)
2989 __gitcomp "--force"
2990 ;;
2991 *)
2992 ;;
2993 esac
2994 fi
2995}
2996
2997__git_complete_common () {
2998 local command="$1"
2999
3000 case "$cur" in
3001 --*)
3002 __gitcomp_builtin "$command"
3003 ;;
3004 esac
3005}
3006
3007__git_cmds_with_parseopt_helper=
3008__git_support_parseopt_helper () {
3009 test -n "$__git_cmds_with_parseopt_helper" ||
3010 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3011
3012 case " $__git_cmds_with_parseopt_helper " in
3013 *" $1 "*)
3014 return 0
3015 ;;
3016 *)
3017 return 1
3018 ;;
3019 esac
3020}
3021
3022__git_complete_command () {
3023 local command="$1"
3024 local completion_func="_git_${command//-/_}"
3025 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3026 declare -f _completion_loader >/dev/null 2>/dev/null
3027 then
3028 _completion_loader "git-$command"
3029 fi
3030 if declare -f $completion_func >/dev/null 2>/dev/null
3031 then
3032 $completion_func
3033 return 0
3034 elif __git_support_parseopt_helper "$command"
3035 then
3036 __git_complete_common "$command"
3037 return 0
3038 else
3039 return 1
3040 fi
3041}
3042
3043__git_main ()
3044{
3045 local i c=1 command __git_dir __git_repo_path
3046 local __git_C_args C_args_count=0
3047
3048 while [ $c -lt $cword ]; do
3049 i="${words[c]}"
3050 case "$i" in
3051 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3052 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3053 --bare) __git_dir="." ;;
3054 --help) command="help"; break ;;
3055 -c|--work-tree|--namespace) ((c++)) ;;
3056 -C) __git_C_args[C_args_count++]=-C
3057 ((c++))
3058 __git_C_args[C_args_count++]="${words[c]}"
3059 ;;
3060 -*) ;;
3061 *) command="$i"; break ;;
3062 esac
3063 ((c++))
3064 done
3065
3066 if [ -z "$command" ]; then
3067 case "$prev" in
3068 --git-dir|-C|--work-tree)
3069 # these need a path argument, let's fall back to
3070 # Bash filename completion
3071 return
3072 ;;
3073 -c)
3074 __git_complete_config_variable_name_and_value
3075 return
3076 ;;
3077 --namespace)
3078 # we don't support completing these options' arguments
3079 return
3080 ;;
3081 esac
3082 case "$cur" in
3083 --*) __gitcomp "
3084 --paginate
3085 --no-pager
3086 --git-dir=
3087 --bare
3088 --version
3089 --exec-path
3090 --exec-path=
3091 --html-path
3092 --man-path
3093 --info-path
3094 --work-tree=
3095 --namespace=
3096 --no-replace-objects
3097 --help
3098 "
3099 ;;
3100 *)
3101 if test -n "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3102 then
3103 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3104 else
3105 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3106 fi
3107 ;;
3108 esac
3109 return
3110 fi
3111
3112 __git_complete_command "$command" && return
3113
3114 local expansion=$(__git_aliased_command "$command")
3115 if [ -n "$expansion" ]; then
3116 words[1]=$expansion
3117 __git_complete_command "$expansion"
3118 fi
3119}
3120
3121__gitk_main ()
3122{
3123 __git_has_doubledash && return
3124
3125 local __git_repo_path
3126 __git_find_repo_path
3127
3128 local merge=""
3129 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3130 merge="--merge"
3131 fi
3132 case "$cur" in
3133 --*)
3134 __gitcomp "
3135 $__git_log_common_options
3136 $__git_log_gitk_options
3137 $merge
3138 "
3139 return
3140 ;;
3141 esac
3142 __git_complete_revlist
3143}
3144
3145if [[ -n ${ZSH_VERSION-} ]] &&
3146 # Don't define these functions when sourced from 'git-completion.zsh',
3147 # it has its own implementations.
3148 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3149 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3150
3151 autoload -U +X compinit && compinit
3152
3153 __gitcomp ()
3154 {
3155 emulate -L zsh
3156
3157 local cur_="${3-$cur}"
3158
3159 case "$cur_" in
3160 --*=)
3161 ;;
3162 *)
3163 local c IFS=$' \t\n'
3164 local -a array
3165 for c in ${=1}; do
3166 c="$c${4-}"
3167 case $c in
3168 --*=*|*.) ;;
3169 *) c="$c " ;;
3170 esac
3171 array[${#array[@]}+1]="$c"
3172 done
3173 compset -P '*[=:]'
3174 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3175 ;;
3176 esac
3177 }
3178
3179 __gitcomp_direct ()
3180 {
3181 emulate -L zsh
3182
3183 local IFS=$'\n'
3184 compset -P '*[=:]'
3185 compadd -Q -- ${=1} && _ret=0
3186 }
3187
3188 __gitcomp_nl ()
3189 {
3190 emulate -L zsh
3191
3192 local IFS=$'\n'
3193 compset -P '*[=:]'
3194 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3195 }
3196
3197 __gitcomp_file_direct ()
3198 {
3199 emulate -L zsh
3200
3201 local IFS=$'\n'
3202 compset -P '*[=:]'
3203 compadd -f -- ${=1} && _ret=0
3204 }
3205
3206 __gitcomp_file ()
3207 {
3208 emulate -L zsh
3209
3210 local IFS=$'\n'
3211 compset -P '*[=:]'
3212 compadd -p "${2-}" -f -- ${=1} && _ret=0
3213 }
3214
3215 _git ()
3216 {
3217 local _ret=1 cur cword prev
3218 cur=${words[CURRENT]}
3219 prev=${words[CURRENT-1]}
3220 let cword=CURRENT-1
3221 emulate ksh -c __${service}_main
3222 let _ret && _default && _ret=0
3223 return _ret
3224 }
3225
3226 compdef _git git gitk
3227 return
3228fi
3229
3230__git_func_wrap ()
3231{
3232 local cur words cword prev
3233 _get_comp_words_by_ref -n =: cur words cword prev
3234 $1
3235}
3236
3237# Setup completion for certain functions defined above by setting common
3238# variables and workarounds.
3239# This is NOT a public function; use at your own risk.
3240__git_complete ()
3241{
3242 local wrapper="__git_wrap${2}"
3243 eval "$wrapper () { __git_func_wrap $2 ; }"
3244 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3245 || complete -o default -o nospace -F $wrapper $1
3246}
3247
3248# wrapper for backwards compatibility
3249_git ()
3250{
3251 __git_wrap__git_main
3252}
3253
3254# wrapper for backwards compatibility
3255_gitk ()
3256{
3257 __git_wrap__gitk_main
3258}
3259
3260__git_complete git __git_main
3261__git_complete gitk __gitk_main
3262
3263# The following are necessary only for Cygwin, and only are needed
3264# when the user has tab-completed the executable name and consequently
3265# included the '.exe' suffix.
3266#
3267if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3268__git_complete git.exe __git_main
3269fi