Clarify commit-tree documentation
As per http://marc.info/?l=git&m=118737219702802&w=2 , clarify git-commit-tree documentation. Signed-off-by: Mike Hommey <mh@glandium.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Mike Hommey committed
Aug 17, 2007 at 22:13 UTC
0734d2656a3098f66b835b35f9f81079854ebb9f
1 file changed
+6
-9
Documentation/git-commit-tree.txt
+6
-9
@@ -51,9 +51,9 @@ A commit encapsulates:
51
- author name, email and date
52
- committer name and email and the commit time.
53
54
-If not provided, "git-commit-tree" uses your name, hostname and domain to
55
-provide author and committer info. This can be overridden by
56
-either `.git/config` file, or using the following environment variables.
54
+While parent object ids are provided on the command line, author and
55
+commiter information is taken from the following environment variables,
56
+if set:
57
58
GIT_AUTHOR_NAME
59
GIT_AUTHOR_EMAIL
@@ -65,12 +65,9 @@ either `.git/config` file, or using the following environment variables.
65
66
(nb "<", ">" and "\n"s are stripped)
67
68
-In `.git/config` file, the following items are used for GIT_AUTHOR_NAME and
69
-GIT_AUTHOR_EMAIL:
70
-
71
- [user]
72
- name = "Your Name"
73
- email = "your@email.address.xz"
68
+In case (some of) these environment variables are not set, the information
69
+is taken from the configuration items user.name and user.email, or, if not
70
+present, system user name and fully qualified hostname.
71
72
A commit comment is read from stdin. If a changelog
73
entry is not provided via "<" redirection, "git-commit-tree" will just wait