git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v3 0/1] completion: dynamic completion loading

From
Florian Gamböck <mail@floga.de>
Date
Apr 29, 2018, 16:42 UTC
Message-ID
<20180429164232.29337-1-mail@floga.de>

In this small patch I want to introduce a way to dynamically load completion scripts for external subcommands.

A few years ago, you would put a completion script (which defines a Bash function _git_foo for a custom git subcommand foo) into /etc/bash_completion.d, or save it somewhere in your $HOME and source it manually in your .bashrc.

Starting with bash-completion v2.0 (or, to be absolutely exact, the preview versions started at v1.90), completion scripts are not sourced at bash startup anymore. Rather, when typing in a command and trigger completion by pressing the TAB key, the new bash-completion's main script looks for a script with the same name as the typed command in the completion directory, sources it, and provides the completions defined in this script.

However, that only works for top level commands. After a completion script has been found, the logic is delegated to this script. This means, that the completion of subcommands must be handled by the corresponding completion script.

As it is now, git is perfectly able to call custom completion functions, iff they are already defined when calling the git completion. With my patch, git uses an already defined loader function of bash-completion (or continues silently if this function is not found), loads an external completion script, and provides its completions.

An example for an external completion script would be /usr/share/bash-completion/completions/git-foo for a git subcommand foo.

Changes since v2:
-   Replaced __load_completion with _completion_loader, which was introduced 
    way before the former and should therefor be available even in older 
    distributions
-   Updated commit message with explanations from Szeder Gábor
Changes since v1 (RFC):
-   Re-arranged if-fi statement to increase readability (suggested by Junio C 
    Hamano)
-   Re-worded commit message to include the exakt version of bashcomp that 
    introduced dynamic loading (suggested by Stefan Beller)
Florian Gamböck (1):
  completion: load completion file for external subcommand
 contrib/completion/git-completion.bash | 10 ++++++++++
 1 file changed, 10 insertions(+)
-- 
2.16.1
Next: Florian Gamböck
Message 1 of 3 in “completion: dynamic completion loading”
  1. 0/1 completion: dynamic completion loadingFlorian Gamböck, Apr 29, 2018
  2. 1/1 completion: load completion file for external subcommandFlorian Gamböck, Apr 29, 2018
  3. SZEDER GáborMay 7, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.