add documentation

Project: http://git-wip-us.apache.org/repos/asf/maven-scm/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven-scm/commit/da088373
Tree: http://git-wip-us.apache.org/repos/asf/maven-scm/tree/da088373
Diff: http://git-wip-us.apache.org/repos/asf/maven-scm/diff/da088373

Branch: refs/heads/master
Commit: da088373469ec4901e46241d6c7503920508c813
Parents: d114bfb
Author: imod <[email protected]>
Authored: Fri Jul 18 06:15:37 2014 +0200
Committer: imod <[email protected]>
Committed: Fri Jul 18 06:15:37 2014 +0200

----------------------------------------------------------------------
 .../src/site/markdown/index.md.vm                       | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/maven-scm/blob/da088373/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/site/markdown/index.md.vm
----------------------------------------------------------------------
diff --git 
a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/site/markdown/index.md.vm
 
b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/site/markdown/index.md.vm
index 8734528..e104bc2 100644
--- 
a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/site/markdown/index.md.vm
+++ 
b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/site/markdown/index.md.vm
@@ -68,6 +68,7 @@ Usage with the `maven-scm-plugin`
                        
 Examples
 ____
+
 changelog
 
        mvn 
org.apache.maven.plugins:maven-scm-plugin:${project.version}:changelog
@@ -76,7 +77,16 @@ release
 
        mvn release:prepare release:perform -Dresume=false -Dusername=XXX 
-Dpassword=XXX
 
-       
+
+Committer / Author
+____
+
+The jgit provider per default uses the information of the "user" section in 
the .gitconfig. If you explicitly configure a user there, this user will be 
used as author and committer. 
+If you don't define a user in the .gitconfig, then the user passed as 
"username" with the maven execution is used. The email per default will be 
'username'@hostname. If you don't like 
+the hostname to be used as the domain. you can configure a default domain in 
the .gitconfig as follows:   
+
+       git config --global maven-scm.maildomain mycomp.com     
+
 
                        
                        

Reply via email to