undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bash-completion: Add comments to remind about required arguments

Browse Source 
Add a few simple comments above commands that take arguments. These
comments are meant to remind developers of potential problems that
can occur when the script is sourced on systems with "set -u." Any
function which requires arguments really ought to be called with
explicit arguments given.

Also adds a #!bash to the top of bash completions so that editing
software can always identify that the file is of sh type.

Signed-off-by: Ted Pavlic <ted@tedpavlic.com>
Acked-by: Shawn O. Pearce <spearce@spearce.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ted Pavlic 2009-01-15 11:02:23 -05:00 committed by Junio C Hamano
parent 50e126e185
commit a42577d4c8
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
contrib/completion/git-completion.bash
View File

@ -1,3 +1,4 @@
#!bash
# #
# bash completion support for core Git. # bash completion support for core Git.
# #
@ -50,6 +51,8 @@ case "$COMP_WORDBREAKS" in
*) COMP_WORDBREAKS="$COMP_WORDBREAKS:" *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
esac esac
# __gitdir accepts 0 or 1 arguments (i.e., location)
# returns location of .git repo
__gitdir () __gitdir ()
{ {
if [ -z "${1-}" ]; then if [ -z "${1-}" ]; then
@ -67,6 +70,8 @@ __gitdir ()
fi fi
} }
# __git_ps1 accepts 0 or 1 arguments (i.e., format string)
# returns text to add to bash PS1 prompt (includes branch name)
__git_ps1 () __git_ps1 ()
{ {
local g="$(git rev-parse --git-dir 2>/dev/null)" local g="$(git rev-parse --git-dir 2>/dev/null)"
@ -119,6 +124,7 @@ __git_ps1 ()
fi fi
} }
# __gitcomp_1 requires 2 arguments
__gitcomp_1 () __gitcomp_1 ()
{ {
local c IFS=' '$'\t'$'\n' local c IFS=' '$'\t'$'\n'
@ -131,6 +137,8 @@ __gitcomp_1 ()
done done
} }
# __gitcomp accepts 1, 2, 3, or 4 arguments
# generates completion reply with compgen
__gitcomp () __gitcomp ()
{ {
local cur="${COMP_WORDS[COMP_CWORD]}" local cur="${COMP_WORDS[COMP_CWORD]}"
@ -150,6 +158,7 @@ __gitcomp ()
esac esac
} }
# __git_heads accepts 0 or 1 arguments (to pass to __gitdir)
__git_heads () __git_heads ()
{ {
local cmd i is_hash=y dir="$(__gitdir "${1-}")" local cmd i is_hash=y dir="$(__gitdir "${1-}")"
@ -168,6 +177,7 @@ __git_heads ()
done done
} }
# __git_tags accepts 0 or 1 arguments (to pass to __gitdir)
__git_tags () __git_tags ()
{ {
local cmd i is_hash=y dir="$(__gitdir "${1-}")" local cmd i is_hash=y dir="$(__gitdir "${1-}")"
@ -186,6 +196,7 @@ __git_tags ()
done done
} }
# __git_refs accepts 0 or 1 arguments (to pass to __gitdir)
__git_refs () __git_refs ()
{ {
local i is_hash=y dir="$(__gitdir "${1-}")" local i is_hash=y dir="$(__gitdir "${1-}")"
@ -218,6 +229,7 @@ __git_refs ()
done done
} }
# __git_refs2 requires 1 argument (to pass to __git_refs)
__git_refs2 () __git_refs2 ()
{ {
local i local i
@ -226,6 +238,7 @@ __git_refs2 ()
done done
} }
# __git_refs_remotes requires 1 argument (to pass to ls-remote)
__git_refs_remotes () __git_refs_remotes ()
{ {
local cmd i is_hash=y local cmd i is_hash=y
@ -470,6 +483,7 @@ __git_aliases ()
done done
} }
# __git_aliased_command requires 1 argument
__git_aliased_command () __git_aliased_command ()
{ {
local word cmdline=$(git --git-dir="$(__gitdir)" \ local word cmdline=$(git --git-dir="$(__gitdir)" \
@ -482,6 +496,7 @@ __git_aliased_command ()
done done
} }
# __git_find_subcommand requires 1 argument
__git_find_subcommand () __git_find_subcommand ()
{ {
local word subcommand c=1 local word subcommand c=1