undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

commit.txt: clarify how --author argument is used

Browse Source 
commit --author was added by 146ea06 (git commit --author=$name: look $name up
in existing commits), but its documentation was sorely lacking compared to its
excellent commit message. This commit tries to improve the documentation.

Signed-off-by: Jay Soffian <jaysoffian@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jay Soffian 2010-06-06 19:31:34 -04:00 committed by Junio C Hamano
parent e1e5ec868f
commit 3334729cf2
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/git-commit.txt
View File

@ -95,10 +95,11 @@ OPTIONS
read the message from the standard input.
--author=<author>::
Override the author name used in the commit. You can use the
standard `A U Thor <author@example.com>` format. Otherwise,
an existing commit that matches the given string and its author
name is used.
Override the commit author. Specify an explicit author using the
standard `A U Thor <author@example.com>` format. Otherwise <author>
is assumed to be a pattern and is used to search for an existing
commit by that author (i.e. rev-list --all -i --author=<author>);
the commit author is then copied from the first such commit found.
--date=<date>::
Override the author date used in the commit.