Document git aliases support

This patch ports and modifies appropriately the git aliases documentation
from my patch, shall it rest in peace.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 4ce78679fed2f617ff3dd808ede061f5a94efff9..570b691ba19322ad33b2cc0d76a37e4ab09b1d1f 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -91,6 +91,14 @@ core.warnAmbiguousRefs::
        If true, git will warn you if the ref name you passed it is ambiguous
        and might match multiple refs in the .git/refs/ tree. True by default.
 
+alias.*::
+       Command aliases for the gitlink:git[1] command wrapper - e.g.
+       after defining "alias.last = cat-file commit HEAD", the invocation
+       "git last" is equivalent to "git cat-file commit HEAD". To avoid
+       confusion, aliases that hide existing git commands are ignored.
+       Arguments are split at whitespaces, but single or double
+       quote pair can be used to quote them.
+
 apply.whitespace::
        Tells `git-apply` how to handle whitespaces, in the same way
        as the '--whitespace' option. See gitlink:git-apply[1].

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 61331ab12140c43c3b043aab7e6dd21294678041..d4472b56d1b11227bc20b8ad3f69a3d42278dd42 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -21,6 +21,9 @@ link:everyday.html[Everyday Git] for a useful minimum set of commands, and
 "man git-commandname" for documentation of each command.  CVS users may
 also want to read link:cvs-migration.html[CVS migration].
 
+The COMMAND is either a name of a Git command (see below) or an alias
+as defined in the configuration file (see gitlink:git-repo-config[1]).
+
 OPTIONS
 -------
 --version::