bash-completion: Add comments to remind about required arguments
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>
Ted Pavlic committed
Jan 15, 2009 at 11:02 UTC
a42577d4c868141343378824814c058de043e24d
1 file changed
+15
contrib/completion/git-completion.bash
+15
@@ -1,3 +1,4 @@
1
+#!bash
2
#
3
# bash completion support for core Git.
4
#
@@ -50,6 +51,8 @@ case "$COMP_WORDBREAKS" in
51
*) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
52
esac
53
54
+# __gitdir accepts 0 or 1 arguments (i.e., location)
55
+# returns location of .git repo
56
__gitdir ()
57
{
58
if [ -z "${1-}" ]; then
@@ -67,6 +70,8 @@ __gitdir ()
70
fi
71
}
72
73
+# __git_ps1 accepts 0 or 1 arguments (i.e., format string)
74
+# returns text to add to bash PS1 prompt (includes branch name)
75
__git_ps1 ()
76
{
77
local g="$(git rev-parse --git-dir 2>/dev/null)"
@@ -119,6 +124,7 @@ __git_ps1 ()
124
fi
125
}
126
127
+# __gitcomp_1 requires 2 arguments
128
__gitcomp_1 ()
129
{
130
local c IFS=' '$'\t'$'\n'
@@ -131,6 +137,8 @@ __gitcomp_1 ()
137
done
138
}
139
140
+# __gitcomp accepts 1, 2, 3, or 4 arguments
141
+# generates completion reply with compgen
142
__gitcomp ()
143
{
144
local cur="${COMP_WORDS[COMP_CWORD]}"
@@ -150,6 +158,7 @@ __gitcomp ()
158
esac
159
}
160
161
+# __git_heads accepts 0 or 1 arguments (to pass to __gitdir)
162
__git_heads ()
163
{
164
local cmd i is_hash=y dir="$(__gitdir "${1-}")"
@@ -168,6 +177,7 @@ __git_heads ()
177
done
178
}
179
180
+# __git_tags accepts 0 or 1 arguments (to pass to __gitdir)
181
__git_tags ()
182
{
183
local cmd i is_hash=y dir="$(__gitdir "${1-}")"
@@ -186,6 +196,7 @@ __git_tags ()
196
done
197
}
198
199
+# __git_refs accepts 0 or 1 arguments (to pass to __gitdir)
200
__git_refs ()
201
{
202
local i is_hash=y dir="$(__gitdir "${1-}")"
@@ -218,6 +229,7 @@ __git_refs ()
229
done
230
}
231
232
+# __git_refs2 requires 1 argument (to pass to __git_refs)
233
__git_refs2 ()
234
{
235
local i
@@ -226,6 +238,7 @@ __git_refs2 ()
238
done
239
}
240
241
+# __git_refs_remotes requires 1 argument (to pass to ls-remote)
242
__git_refs_remotes ()
243
{
244
local cmd i is_hash=y
@@ -470,6 +483,7 @@ __git_aliases ()
483
done
484
}
485
486
+# __git_aliased_command requires 1 argument
487
__git_aliased_command ()
488
{
489
local word cmdline=$(git --git-dir="$(__gitdir)" \
@@ -482,6 +496,7 @@ __git_aliased_command ()
496
done
497
}
498
499
+# __git_find_subcommand requires 1 argument
500
__git_find_subcommand ()
501
{
502
local word subcommand c=1