From: D. Ben Knoble <ben.knoble@gmail.com>
Date: Tue, 03 Mar 2026 18:48:54 GMT
Subject: Re: [PATCH v3] doc: add information regarding external commands
Message-ID: <CALnO6CASi3eyf_Zn1RS_Atjm6hj6Vnq0nNNyV8JJFCAK7hz0rg@mail.gmail.com>
In-Reply-To: <xmqqh5qwdaeh.fsf@gitster.g>

On Tue, Mar 3, 2026 at 1:40 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> Speaking of "alias", I have always felt that it was suboptimal to
> make users refer to "git help config" to find out about it.  I
> wonder if "git help git" should be the first place users would look
> for a help about them?
>
> We have "GIT COMMANDS" section in "git help git" that says "We
> divide GIt into porcelain and plumbing" and then have two
> subsections there that list commands that belong to these two
> categories.  Perhaps leaving some breadcrumbs to redirect them would
> be a good start, something like this?
>
>  Documentation/git.adoc | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git c/Documentation/git.adoc w/Documentation/git.adoc
> index ce099e78b8..fb5b477eda 100644
> --- c/Documentation/git.adoc
> +++ w/Documentation/git.adoc
> @@ -235,7 +235,10 @@ GIT COMMANDS
>  ------------
>
>  We divide Git into high level ("porcelain") commands and low level
> -("plumbing") commands.
> +("plumbing") commands.  For defining command aliases, see
> +linkgit:gitconfig[1] and look for descriptions of `alias.*`.
> +For installing custom "git" subcommands, see the description for
> +the 'PATH' environment variable in this manual.
>
>  High-level commands (porcelain)
>  -------------------------------

I very much like that, thanks.

-- 
D. Ben Knoble