Skip to content

Automate updating git-completion.bash a bit

Nguyễn Thái Ngọc Duy git 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest42 patches 20 repliesIn review
  2. v241 patches 15 repliesSuperseded
  3. v12 patches 11 repliesSuperseded

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/42parse-options: support --git-completion-helperparse-options.c parse-options.h+48 -18 replies
2/42parse-options: add OPT_xxx_F() variantsparse-options.h+12 -70 replies
3/42parse-options: let OPT__FORCE take optional flags argumentbuiltin/add.c builtin/branch.c builtin/checkout-index.c +11 more+17 -150 replies
4/42git-completion.bash: introduce __gitcomp_builtincontrib/completion/git-completion.bash+33 -03 replies
5/42completion: use __gitcomp_builtin in _git_addcontrib/completion/git-completion.bash+1 -40 replies
6/42completion: use __gitcomp_builtin in _git_amcontrib/completion/git-completion.bash parse-options.h rerere.h+8 -106 replies
7/42completion: use __gitcomp_builtin in _git_applyapply.c contrib/completion/git-completion.bash+4 -100 replies
8/42completion: use __gitcomp_builtin in _git_branchbuiltin/branch.c contrib/completion/git-completion.bash+3 -70 replies
9/42completion: use __gitcomp_builtin in _git_checkoutbuiltin/checkout.c contrib/completion/git-completion.bash t/t9902-completion.sh+13 -120 replies
10/42completion: use __gitcomp_builtin in _git_cherry_pickcontrib/completion/git-completion.bash+5 -20 replies
11/42completion: use __gitcomp_builtin in _git_cleanbuiltin/clean.c contrib/completion/git-completion.bash+2 -20 replies
12/42completion: use __gitcomp_builtin in _git_clonecontrib/completion/git-completion.bash+1 -200 replies
13/42completion: use __gitcomp_builtin in _git_commitcontrib/completion/git-completion.bash+1 -100 replies
14/42completion: use __gitcomp_builtin in _git_configcontrib/completion/git-completion.bash+1 -80 replies
15/42completion: use __gitcomp_builtin in _git_describecontrib/completion/git-completion.bash+1 -50 replies
16/42completion: use __gitcomp_builtin in _git_difftoolcontrib/completion/git-completion.bash+6 -60 replies
17/42completion: use __gitcomp_builtin in _git_fetchcontrib/completion/git-completion.bash+1 -10 replies
18/42completion: use __gitcomp_builtin in _git_fsckcontrib/completion/git-completion.bash+1 -40 replies
19/42completion: use __gitcomp_builtin in _git_gcbuiltin/gc.c contrib/completion/git-completion.bash+6 -30 replies
20/42completion: use __gitcomp_builtin in _git_grepbuiltin/grep.c contrib/completion/git-completion.bash+9 -200 replies
21/42completion: use __gitcomp_builtin in _git_helpcontrib/completion/git-completion.bash+1 -10 replies
22/42completion: use __gitcomp_builtin in _git_initcontrib/completion/git-completion.bash+1 -10 replies
23/42completion: use __gitcomp_builtin in _git_ls_filescontrib/completion/git-completion.bash+1 -70 replies
24/42completion: use __gitcomp_builtin in _git_ls_remotebuiltin/ls-remote.c contrib/completion/git-completion.bash+4 -30 replies
25/42completion: use __gitcomp_builtin in _git_mergecontrib/completion/git-completion.bash+7 -20 replies
26/42completion: use __gitcomp_builtin in _git_merge_basecontrib/completion/git-completion.bash+1 -10 replies
27/42completion: use __gitcomp_builtin in _git_mvbuiltin/mv.c contrib/completion/git-completion.bash+3 -20 replies
28/42completion: use __gitcomp_builtin in _git_name_revcontrib/completion/git-completion.bash+1 -10 replies
29/42completion: use __gitcomp_builtin in _git_notesbuiltin/notes.c contrib/completion/git-completion.bash+10 -85 replies
30/42completion: use __gitcomp_builtin in _git_pullcontrib/completion/git-completion.bash+5 -200 replies
31/42completion: use __gitcomp_builtin in _git_pushbuiltin/push.c contrib/completion/git-completion.bash+2 -70 replies
32/42completion: use __gitcomp_builtin in _git_remotecontrib/completion/git-completion.bash+8 -80 replies
33/42remote: force completing --mirror= instead of --mirrorbuiltin/remote.c parse-options.c parse-options.h+8 -20 replies
34/42completion: use __gitcomp_builtin in _git_replacebuiltin/replace.c contrib/completion/git-completion.bash+3 -20 replies
35/42completion: use __gitcomp_builtin in _git_resetcontrib/completion/git-completion.bash+1 -10 replies
36/42completion: use __gitcomp_builtin in _git_revertcontrib/completion/git-completion.bash+5 -50 replies
37/42completion: use __gitcomp_builtin in _git_rmbuiltin/rm.c contrib/completion/git-completion.bash+2 -20 replies
38/42completion: use __gitcomp_builtin in _git_show_branchcontrib/completion/git-completion.bash+1 -60 replies
39/42completion: use __gitcomp_builtin in _git_statuscontrib/completion/git-completion.bash+1 -50 replies
40/42completion: use __gitcomp_builtin in _git_tagcontrib/completion/git-completion.bash+1 -50 replies
41/42completion: use __gitcomp_builtin in _git_worktreebuiltin/worktree.c contrib/completion/git-completion.bash+5 -50 replies
42/42git-completion.bash: add GIT_COMPLETION_OPTIONS=all configcontrib/completion/git-completion.bash parse-options.c+12 -55 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH v3 00/42] Automate updating git-completion.bash a bit

v3 improves __gitcomp_builtin() function a bit to allows both adding extra options (to complement --git-completion-helper limitations) and removing options.

v3 should also fix Mac OS breakage.

The last change in 42/42 is a new configurable variable in git-completion.bash that allows you to complete _all_ options, including ones that are filtered out by default. For the record there are 22 of them with the following counts:

     10 --force
      4 --rerere-autoupdate
      1 --unsafe-paths
      1 --thin
      1 --overwrite-ignore
      1 --open-files-in-pager
      1 --null
      1 --ext-grep
      1 --exit-code
      1 --auto

The first 41 patches should be ok to enter 'next' unless people find something else. 42/42 may be a bit more questionable (e.g. configuration variable name, or how we pass options to --git-completion-helper...) and might have to stay on 'pu' longer.

Interdiff with v2 below. I remove changes that are reverts back to 'master' to reduce the noise a bit.

contrib/completion/git-completion.bash +32 -11
index cfd24c5764..0cfa489a8e 100644
@@ -36,6 +36,10 @@
 #
 #     When set to "1", do not include "DWIM" suggestions in git-checkout
 #     completion (e.g., completing "foo" when "origin/foo" exists).
+#
+#   GIT_COMPLETION_OPTIONS
+#
+#     When set to "all", complete all possible options
 
 case "$COMP_WORDBREAKS" in
 *:*) : great ;;
@@ -284,24 +288,33 @@ __gitcomp ()
 #
 #    __gitcomp "$(git xxx --git-completion-helper) ..."
 #
-# except that the value from $(git) is cached
+# except that the output is cached. Accept 1-3 arguments:
+# 1: the git command to execute, this is also the cache key
+# 2: extra options to be added on top (e.g. negative forms)
+# 3: options to be excluded
 __gitcomp_builtin ()
 {
 	# spaces must be replaced with underscore for multi-word
 	# commands, e.g. "git remote add" becomes remote_add.
 	local cmd="$1"
-	shift
+	local incl="$2"
+	local excl="$3"
 
 	local var=__gitcomp_builtin_"${cmd/-/_}"
 	local options
 	eval "options=\$$var"
 
 	if [ -z "$options" ]; then
-		declare -g "$var=$(__git ${cmd/_/ } --git-completion-helper)"
-		eval "options=\$$var"
+		# leading and trailing spaces are significant to make
+		# option removal work correctly.
+		options=" $(__git ${cmd/_/ } --git-completion-helper=$GIT_COMPLETION_OPTIONS) $incl "
+		for i in $excl; do
+			options="${options/ $i / }"
+		done
+		eval "$var=\"$options\""
 	fi
 
-	__gitcomp "$options $*"
+	__gitcomp "$options"
 }
 
 # Variation of __gitcomp_nl () that appends to the existing list of
@@ -1096,12 +1109,13 @@ __git_count_arguments ()
 }
 
 __git_whitespacelist="nowarn warn error error-all fix"
+__git_am_inprogress_options="--skip --continue --resolved --abort"
 
 _git_am ()
 {
 	__git_find_repo_path
 	if [ -d "$__git_repo_path"/rebase-apply ]; then
-		__gitcomp "--skip --continue --resolved --abort"
+		__gitcomp "$__git_am_inprogress_options"
 		return
 	fi
 	case "$cur" in
@@ -1110,7 +1124,8 @@ _git_am ()
 		return
 		;;
 	--*)
-		__gitcomp_builtin am "--no-utf8"
+		__gitcomp_builtin am "--no-utf8" \
+			"$__git_am_inprogress_options"
 		return
 	esac
 }
@@ -1272,16 +1287,19 @@ _git_cherry ()
 	__git_complete_refs
 }
 
+__git_cherry_pick_inprogress_options="--continue --quit --abort"
+
 _git_cherry_pick ()
 {
 	__git_find_repo_path
 	if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
-		__gitcomp "--continue --quit --abort"
+		__gitcomp "$__git_cherry_pick_inprogress_options"
 		return
 	fi
 	case "$cur" in
 	--*)
-		__gitcomp_builtin cherry-pick
+		__gitcomp_builtin cherry-pick "" \
+			"$__git_cherry_pick_inprogress_options"
 		;;
 	*)
 		__git_complete_refs
@@ -2674,16 +2692,19 @@ _git_reset ()
 	__git_complete_refs
 }
 
+__git_revert_inprogress_options="--continue --quit --abort"
+
 _git_revert ()
 {
 	__git_find_repo_path
 	if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
-		__gitcomp "--continue --quit --abort"
+		__gitcomp "$__git_revert_inprogress_options"
 		return
 	fi
 	case "$cur" in
 	--*)
-		__gitcomp_builtin revert "--no-edit"
+		__gitcomp_builtin revert "--no-edit" \
+			"$__git_revert_inprogress_options"
 		return
 		;;
 	esac
parse-options.c +7 -4
index 979577ba2c..5b8b2b376e 100644
@@ -430,14 +430,17 @@ void parse_options_start(struct parse_opt_ctx_t *ctx,
  * many options that do not suppress it properly.
  */
 static int show_gitcomp(struct parse_opt_ctx_t *ctx,
-			const struct option *opts)
+			const struct option *opts,
+			const char *arg)
 {
 	for (; opts->type != OPTION_END; opts++) {
 		const char *suffix = "";
 
 		if (!opts->long_name)
 			continue;
-		if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
+		if (opts->flags & PARSE_OPT_HIDDEN)
+			continue;
+		if ((opts->flags & PARSE_OPT_NOCOMPLETE) && strcmp(arg, "all"))
 			continue;
 
 		switch (opts->type) {
@@ -498,8 +501,8 @@ int parse_options_step(struct parse_opt_ctx_t *ctx,
 			goto show_usage;
 
 		/* lone --git-completion-helper is asked by git-completion.bash */
-		if (ctx->total == 1 && !strcmp(arg + 1, "-git-completion-helper"))
-			return show_gitcomp(ctx, options);
+		if (ctx->total == 1 && skip_prefix(arg + 1, "-git-completion-helper=", &arg))
+			return show_gitcomp(ctx, options, arg);
 
 		if (arg[1] != '-') {
 			ctx->opt = arg + 1;
parse-options.h +1 -1
index f63151fbda..0ba08691e6 100644
@@ -92,7 +92,7 @@ typedef int parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  *				(i.e. '<argh>') in the help message.
  *				Useful for options with multiple parameters.
  *   PARSE_OPT_NOCOMPLETE: by default all visible options are completable
- *			   git-completion.bash. This option suppresses that.
+ *			   by git-completion.bash. This option suppresses that.
  *   PARSE_OPT_COMP_ARG: this option forces to git-completion.bash to
  *			 complete an option as --name= not --name even if
  *			 the option takes optional argument.
Signature · 1 line
2.16.1.207.gedba492059