From: Roland Hieber <rhi@pengutronix.de>
To: git@vger.kernel.org
Cc: Roland Hieber <rhi@pengutronix.de>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v3 3/3] completion: add docs on how to add subcommand completions
Date: Thu, 25 Apr 2024 12:18:44 +0200 [thread overview]
Message-ID: <20240425101845.708554-3-rhi@pengutronix.de> (raw)
In-Reply-To: <20240425101845.708554-1-rhi@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
PATCH v3:
- change the wording a bit to make the text more fluent
PATCH v2: https://lore.kernel.org/git/20240424215019.268208-2-rhi@pengutronix.de
- fix typo and superfluous "-my" (thanks to Junio C Hamano)
PATCH v1: https://lore.kernel.org/git/20240424210549.256256-2-rhi@pengutronix.de/
---
contrib/completion/git-completion.bash | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 566f32d412ce..5c0ddeb3d4fb 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -31,6 +31,13 @@
# Note that "git" is optional --- '!f() { : commit; ...}; f' would complete
# just like the 'git commit' command.
#
+# To add completion for git subcommands that are implemented in external
+# scripts, define a function of the form '_git_${subcommand}' while replacing
+# all dashes with underscores, and the main git completion will make use of it.
+# For example, to add completion for 'git do-stuff' (which could e.g. live
+# in /usr/bin/git-do-stuff), name the completion function '_git_do_stuff'.
+# See _git_show, _git_bisect etc. below for more examples.
+#
# If you have a shell command that is not part of git (and is not called as a
# git subcommand), but you would still like git-style completion for it, use
# __git_complete. For example, to use the same completion as for 'git log' also
--
2.39.2
next prev parent reply other threads:[~2024-04-25 10:19 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-25 10:18 [PATCH v3 1/3] completion: add 'symbolic-ref' Roland Hieber
2024-04-25 10:18 ` [PATCH v3 2/3] completion: improve docs for using __git_complete Roland Hieber
2024-04-25 10:18 ` Roland Hieber [this message]
2024-04-25 10:45 ` [PATCH v3 1/3] completion: add 'symbolic-ref' Kristoffer Haugsbakk
2024-04-25 14:36 ` Justin Tobler
2024-04-25 16:42 ` Junio C Hamano
2024-04-25 21:40 ` Justin Tobler
2024-04-25 21:48 ` Junio C Hamano
2024-04-25 16:50 ` Junio C Hamano
2024-04-26 11:43 ` Patrick Steinhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240425101845.708554-3-rhi@pengutronix.de \
--to=rhi@pengutronix.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).