From 33bd9136d6700dcef772a48dc565fe11a7dfb85a Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@daniel.shahaf.name>
Date: Wed, 9 Mar 2016 14:06:49 +0000
Subject: 38120: _git: Document the internal helper function __git_ignore_line.

---
 Completion/Unix/Command/_git | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'Completion')

diff --git a/Completion/Unix/Command/_git b/Completion/Unix/Command/_git
index 7a459f1fb..2dd9a8028 100644
--- a/Completion/Unix/Command/_git
+++ b/Completion/Unix/Command/_git
@@ -5038,6 +5038,16 @@ __git_describe_commit () {
 
 # Completion Wrappers
 
+# '__git_ignore_line $callee "${callee_args[@]}" "${callee_compadd_args[@]}"'
+# invokes '$callee "${callee_args[@]}" "${callee_compadd_args[@]}"' with
+# callee_compadd_args modified to exclude positional parameters to the completed
+# command from being completed.  This causes 'git add foo <TAB>' not to offer
+# 'foo' again.
+#
+# Note: This function can't be used to wrap bare 'compadd' calls that use a '--'
+# argument terminator.  It can wrap functions of the form
+#     f() { shift $N; compadd "$@" -a - mymatches }
+# .
 (( $+functions[__git_ignore_line] )) ||
 __git_ignore_line () {
   declare -a ignored
-- 
cgit 1.4.1