Skip to contentSkip to conversation

doc: make it easier to find custom command information

PATCH New Omri Sarig via GitGitGadget 1 participant 1 message Mar 7 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: make it easier to find custom command information

From: Omri Sarig <[email protected]>

Git supports creating additional commands through aliases, and through placement of executables with a "git-" prefix in the PATH.

This information was not easy enough to find - users will look for this information around the command description, but the documentation exists in other locations.

Update the "GIT COMMANDS" section to reference the relevant sections, making it easier for to find this information.

---
doc: Make it easier to find custom command information

Hi,

Following the discussion on
https://lore.kernel.org/git/[email protected]/#related, I've added the suggested documentation.

The only change I made is updating linkgit:gitconfig[1] to be linkgit:git-config[1], which I believe is the correct form for that.

With Kind Regards, Omri

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2225%2Fomrisarig13%2Fbreadcrumb-custom-commands-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2225/omrisarig13/breadcrumb-custom-commands-v1
Pull-Request: https://github.com/git/git/pull/2225

 Documentation/git.adoc | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Documentation/git.adoc +4 -1
index 66442735ea..4e800c409e 100644
@@ -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:git-config[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)
 -------------------------------

base-commit: 795c338de725e13bd361214c6b768019fc45a2c1

Signature · 1 line
gitgitgadget