Subject: [PATCH] Documentation: Better explain git-commit --author implications

From: Abhijit Bhopatkar <[email-masked]>
Date: Sat, 18 Oct 2008 09:05:16 +0530

'--author' changes the author name and email, but the
documentation was not clear that it will not affect the
'--signoff' option which will still use the user's name and
email from the git settings.

Signed-off-by: Abhijit Bhopatkar <[email-masked]>
---
 Documentation/git-commit.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index eb05b0f..17b69fa 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -78,7 +78,8 @@ OPTIONS
 	Override the author name used in the commit.  You can use the
 	standard `A U Thor <[email-masked]>` format.  Otherwise,
 	an existing commit that matches the given string and its author
-	name is used.
+	name is used. This has no effect on singoff line which will
+	still use commiter name and email .

 -m <msg>::
 --message=<msg>::
@@ -95,6 +96,7 @@ OPTIONS
 -s::
 --signoff::
 	Add Signed-off-by line at the end of the commit message.
+	'--author' option has no effect on this line.

 -n::
 --no-verify::
-- 
1.5.6.3