summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Hommey <mh@glandium.org>2007-08-17 20:13:36 (GMT)
committerJunio C Hamano <gitster@pobox.com>2007-08-17 23:51:15 (GMT)
commit0734d2656a3098f66b835b35f9f81079854ebb9f (patch)
treed6bd8bb2bbcbced5883dd7c84278202dd654ef2f
parent5876b8ee3c09553912a4d033051bb25faa52ad94 (diff)
downloadgit-0734d2656a3098f66b835b35f9f81079854ebb9f.zip
git-0734d2656a3098f66b835b35f9f81079854ebb9f.tar.gz
git-0734d2656a3098f66b835b35f9f81079854ebb9f.tar.bz2
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>
-rw-r--r--Documentation/git-commit-tree.txt15
1 files changed, 6 insertions, 9 deletions
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index 5870c2c..6a328f4 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -51,9 +51,9 @@ A commit encapsulates:
- author name, email and date
- committer name and email and the commit time.
-If not provided, "git-commit-tree" uses your name, hostname and domain to
-provide author and committer info. This can be overridden by
-either `.git/config` file, or using the following environment variables.
+While parent object ids are provided on the command line, author and
+commiter information is taken from the following environment variables,
+if set:
GIT_AUTHOR_NAME
GIT_AUTHOR_EMAIL
@@ -65,12 +65,9 @@ either `.git/config` file, or using the following environment variables.
(nb "<", ">" and "\n"s are stripped)
-In `.git/config` file, the following items are used for GIT_AUTHOR_NAME and
-GIT_AUTHOR_EMAIL:
-
- [user]
- name = "Your Name"
- email = "your@email.address.xz"
+In case (some of) these environment variables are not set, the information
+is taken from the configuration items user.name and user.email, or, if not
+present, system user name and fully qualified hostname.
A commit comment is read from stdin. If a changelog
entry is not provided via "<" redirection, "git-commit-tree" will just wait