Skip to content

Commit

Permalink
Clarify commit-tree documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Mike Hommey authored and Junio C Hamano committed Aug 17, 2007
1 parent 5876b8e commit 0734d26
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions Documentation/git-commit-tree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 0734d26

Please sign in to comment.