X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-commit-tree.txt;h=a2537e179ab4602090df28a0ee7e4dabda36064f;hb=afc05f9f13beded8caf15d8e58d06fd64e0f7808;hp=55366688136010ff079a502c99a6af9e9b12dc13;hpb=07ee0d77c66d6f356cd3f82435e67510779aa53c;p=git.git diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 553666881..a2537e179 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -1,18 +1,20 @@ git-commit-tree(1) ================== -v0.1, May 2005 NAME ---- -git-commit-tree - Creates a new commit object +git-commit-tree - Create a new commit object SYNOPSIS -------- -'git-commit-tree' [-p ]\ < changelog +'git-commit-tree' [-p ]\* < changelog DESCRIPTION ----------- +This is usually not what an end user wants to run directly. See +gitlink:git-commit[1] instead. + Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. If no parent is given then it is considered to be an initial tree. @@ -27,8 +29,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 ------- @@ -36,8 +39,8 @@ OPTIONS An existing tree object -p :: - Each '-p' indicates a the id of a parent commit object. - + Each '-p' indicates the id of a parent commit object. + Commit Information ------------------ @@ -48,21 +51,28 @@ 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 using the -following environment variables. +While parent object ids are provided on the command line, author and +committer information is taken from the following environment variables, +if set: GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE GIT_COMMITTER_NAME GIT_COMMITTER_EMAIL + GIT_COMMITTER_DATE + EMAIL + +(nb "<", ">" and "\n"s are stripped) + +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. -(nb <,> and '\n's are stripped) +A commit comment is read from stdin. If a changelog +entry is not provided via "<" redirection, "git-commit-tree" will just wait +for one to be entered and terminated with ^D. -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 ----------- @@ -73,9 +83,14 @@ Your parents must have hated you!:: Your sysadmin must hate you!:: The password(5) name field is longer than a giant static buffer. +Discussion +---------- + +include::i18n.txt[] + See Also -------- -link:git-write-tree.html[git-write-tree] +gitlink:git-write-tree[1] Author @@ -88,5 +103,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list