git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: Re: [PATCH] completion: clarify support for short options and arguments
Date: Sun, 07 Dec 2025 14:38:29 +0900	[thread overview]
Message-ID: <xmqqbjkan962.fsf@gitster.g> (raw)
In-Reply-To: <xmqqzf7vm7b7.fsf@gitster.g> (Junio C. Hamano's message of "Sun, 07 Dec 2025 10:03:56 +0900")

Junio C Hamano <gitster@pobox.com> writes:

> The list of supported completions in the header of the file was
> mostly written a long time ago when Shawn added the initial version
> of this script in 2006.  The list explicitly states that we complete
> "common --long-options", which implies that we do not complete
> not-so-common ones and single letter options (this text dates back
> to May 2007).
>
> Update the description to explicitly state that single-letter
> options are not completed.  Also, document that arguments to options
> are completed, even for single-letter options (e.g., "git -c <TAB>"
> offers configuration variables).

I appended the following to the end of the proposed commit log
message:

  The reason why we do not complete single-letter options is because
  it does not seem to help all that much to learn that the command
  takes -c, -d, -e options when "git foo -<TAB>" offers these three,
  unlike long options that is easier to guess what they are about.

  Because this rationale is primarily for our developers, let's leave
  it out of the completion script itself, whose messages are entirely
  for end-users.  Our developers can run "git blame" to find this
  commit as needed.

      reply	other threads:[~2025-12-07  5:38 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-07  1:03 [PATCH] completion: clarify support for short options and arguments Junio C Hamano
2025-12-07  5:38 ` Junio C Hamano [this message]

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqbjkan962.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).