[PATCH] Document git aliases support

From

Petr Baudis <pasky@suse.cz>

Date

Jun 7, 2006, 20:11 UTC

Message-ID

<20060607201134.GC2609@pasky.or.cz>

In-Reply-To

<7vzmgog5ce.fsf@assigned-by-dhcp.cox.net>

> Petr Baudis <pasky@suse.cz> writes:
> > diff --git a/Documentation/config.txt b/Documentation/config.txt
> > index c861c6c..ad9ec3e 100644
> > --- a/Documentation/config.txt
> > +++ b/Documentation/config.txt
> > @@ -91,6 +91,13 @@ 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". You cannot
> > +	override even existing command names with aliases. Arguments are
> > +	split by spaces, the usual shell quoting and escaping is supported.
> > +
> 
> "even"?  How about: "alias that hides existing command names are
> not used to avoid confusion"?

Oops, that "even" was not meant to be there. I have rephrased it a bit.

---

Signed-off-by: Petr Baudis <pasky@suse.cz>
---

 Documentation/config.txt |    8 ++++++++
 Documentation/git.txt    |    3 +++
 2 files changed, 11 insertions(+), 0 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index c861c6c..91615c1 100644
--- 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". It is not
+	allowed to redefine existing command names using aliases to avoid
+	confusion and troubles with script usage. Arguments are split by
+	spaces, the usual shell quoting and escaping is supported.
+
 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 24ca55d..e474bdf 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -21,6 +21,9 @@ link:everyday.html[Everyday Git] for a u
 "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::

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
A person is just about as big as the things that make them angry.