aboutsummaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
diff options
context:
space:
mode:
authorW. Trevor King <wking@tremily.us>2013-02-17 19:15:58 -0500
committerJunio C Hamano <gitster@pobox.com>2013-02-18 00:48:47 -0800
commit632cc3e6b687c48998223eb49fc465bcb3a9c1d2 (patch)
tree30fa1c90f9e5eca3218088f4d7ee2b4dec8f2f0f /Documentation/user-manual.txt
parent47adb8ac7c550bc89e7eae743dcc8940c2549edf (diff)
downloadgit-632cc3e6b687c48998223eb49fc465bcb3a9c1d2.tar.gz
git-632cc3e6b687c48998223eb49fc465bcb3a9c1d2.tar.xz
user-manual: use 'git config --global user.*' for setup
A simple command line call is easier than spawning an editor, especially for folks new to ideas like the "command line" and "text editors". This is also the approach suggested by 'git commit' if you try and commit without having configured user.name or user.email. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/user-manual.txt')
-rw-r--r--Documentation/user-manual.txt18
1 files changed, 13 insertions, 5 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index c28ba0dac..8074313f8 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -991,9 +991,16 @@ Developing with git
Telling git your name
---------------------
-Before creating any commits, you should introduce yourself to git. The
-easiest way to do so is to make sure the following lines appear in a
-file named .gitconfig in your home directory:
+Before creating any commits, you should introduce yourself to Git.
+The easiest way to do so is to use linkgit:git-config[1]:
+
+------------------------------------------------
+$ git config --global user.name 'Your Name Comes Here'
+$ git config --global user.email 'you@yourdomain.example.com'
+------------------------------------------------
+
+Which will add the following to a file named `.gitconfig` in your
+home directory:
------------------------------------------------
[user]
@@ -1001,8 +1008,9 @@ file named .gitconfig in your home directory:
email = you@yourdomain.example.com
------------------------------------------------
-(See the "CONFIGURATION FILE" section of linkgit:git-config[1] for
-details on the configuration file.)
+See the "CONFIGURATION FILE" section of linkgit:git-config[1] for
+details on the configuration file. The file is plain text, so you can
+also edit it with your favorite editor.
[[creating-a-new-repository]]