X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-commit-tree.txt;h=41d1a1c4b340b17a545feebe9877def8b009933f;hb=162f41292167a800432fc6bbacfcd9f93a90b0c8;hp=d9b0ab07170160dda74512843bd15e9ef350a5a5;hpb=29504118f8528f658fd0bfc02d8d78d4c01dc2cc;p=git.git diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index d9b0ab07..41d1a1c4 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -8,7 +8,7 @@ git-commit-tree - Creates a new commit object SYNOPSIS -------- -'git-commit-tree' [-p ]\ < changelog +'git-commit-tree' [-p ]\* < changelog DESCRIPTION ----------- @@ -26,8 +26,9 @@ to get there. Normally a commit would identify a new "HEAD" state, and while git doesn't care where you save the note about that state, in practice we -tend to just write the result to the file `.git/HEAD`, so that we can -always see what the last committed state was. +tend to just write the result to the file that is pointed at by +`.git/HEAD`, so that we can always see what the last committed +state was. OPTIONS ------- @@ -48,8 +49,8 @@ A commit encapsulates: - 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 using the -following environment variables. +provide author and committer info. This can be overridden by +either `.git/config` file, or using the following environment variables. GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL @@ -59,10 +60,18 @@ 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" + A commit comment is read from stdin (max 999 chars). If a changelog entry is not provided via "<" redirection, "git-commit-tree" will just wait for one to be entered and terminated with ^D. + Diagnostics ----------- You don't exist. Go away!::