From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "SZEDER Gábor" <szeder.dev@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"René Scharfe" <l.s.r@web.de>,
"Denton Liu" <liu.denton@gmail.com>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH v3 0/4] completion: make __git_complete public
Date: Wed, 30 Dec 2020 17:29:46 -0600 [thread overview]
Message-ID: <20201230232950.582152-1-felipe.contreras@gmail.com> (raw)
Back in 2012 I argued [1] for the introduction of a helper that would
allow users to specify aliases like:
git_complete gf git_fetch
There was pushback because there was no clear guideline for public
functions (git_complete vs. _git_complete vs. _GIT_complete), and some
aliases didn't actually work.
Fast-forward to 2020, and there's still no guideline for public
functions, and those aliases still don't work (even though I sent the
fixes).
This has not prevented people from using this function that is clearly
needed to setup custom aliases [2], and in fact that's the recommended
way since there's no other.
But it is cumbersome that the user must type:
__git_complete gf _git_fetch
Or worse:
__git_complete gk __gitk_main
8 years is more than enough time to stop waiting for the perfect to
come; let's define a public function (with the same name) that is
actually user-friendly:
__git_complete gf git_fetch
__git_complete gk gitk
While also maintaining backwards compatibility.
Changes since v2:
* Improved the safety of __git_have_func with suggestions from René Scharfe
* Added documentation to the top of git-completion.bash
[1] https://lore.kernel.org/git/1334524814-13581-1-git-send-email-felipe.contreras@gmail.com/
[2] https://stackoverflow.com/questions/342969/how-do-i-get-bash-completion-to-work-with-aliases
Felipe Contreras (4):
completion: bash: add __git_have_func helper
completion: bash: improve function detection
test: completion: add tests for __git_complete
completion: add proper public __git_complete
contrib/completion/git-completion.bash | 50 ++++++++++++++++++++------
t/t9902-completion.sh | 20 +++++++++++
2 files changed, 60 insertions(+), 10 deletions(-)
Range-diff against v2:
1: 0993732142 = 1: 0993732142 completion: bash: add __git_have_func helper
-: ---------- > 2: 6a3fe8b79b completion: bash: improve function detection
2: 7918c34d0e = 3: b211eebc0d test: completion: add tests for __git_complete
3: 8a6cc52063 ! 4: a5bfe5376b completion: add proper public __git_complete
@@ Commit message
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
## contrib/completion/git-completion.bash ##
+@@
+ # tell the completion to use commit completion. This also works with aliases
+ # of form "!sh -c '...'". For example, "!sh -c ': git commit ; ... '".
+ #
++# If you have a command that is not part of git, but you would still
++# like completion, you can use __git_complete:
++#
++# __git_complete gl git_log
++#
++# Or if it's a main command (i.e. git or gitk):
++#
++# __git_complete gk gitk
++#
+ # Compatible with bash 3.2.57.
+ #
+ # You can set the following environment variables to influence the behavior of
@@ contrib/completion/git-completion.bash: __git_func_wrap ()
$1
}
--
2.30.0
next reply other threads:[~2020-12-30 23:32 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-30 23:29 Felipe Contreras [this message]
2020-12-30 23:29 ` [PATCH v3 1/4] completion: bash: add __git_have_func helper Felipe Contreras
2020-12-30 23:29 ` [PATCH v3 2/4] completion: bash: improve function detection Felipe Contreras
2020-12-30 23:29 ` [PATCH v3 3/4] test: completion: add tests for __git_complete Felipe Contreras
2020-12-30 23:29 ` [PATCH v3 4/4] completion: add proper public __git_complete Felipe Contreras
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=20201230232950.582152-1-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=l.s.r@web.de \
--cc=liu.denton@gmail.com \
--cc=pclouds@gmail.com \
--cc=szeder.dev@gmail.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).