Document git aliases support
authorPetr Baudis <pasky@suse.cz>
Wed, 7 Jun 2006 18:43:50 +0000 (20:43 +0200)
committerJunio C Hamano <junkio@cox.net>
Wed, 7 Jun 2006 19:37:46 +0000 (12:37 -0700)
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>
Documentation/config.txt
Documentation/git.txt

index 4ce7867..570b691 100644 (file)
@@ -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].
index 61331ab..d4472b5 100644 (file)
@@ -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::