Documentation / git-commit-tree.txton commit git-commit documentation: remove comment on unfixed git-rm (7905ba6)
   1git-commit-tree(1)
   2==================
   3
   4NAME
   5----
   6git-commit-tree - Creates a new commit object
   7
   8
   9SYNOPSIS
  10--------
  11'git-commit-tree' <tree> [-p <parent commit>]\* < changelog
  12
  13DESCRIPTION
  14-----------
  15Creates a new commit object based on the provided tree object and
  16emits the new commit object id on stdout. If no parent is given then
  17it is considered to be an initial tree.
  18
  19A commit object usually has 1 parent (a commit after a change) or up
  20to 16 parents.  More than one parent represents a merge of branches
  21that led to them.
  22
  23While a tree represents a particular directory state of a working
  24directory, a commit represents that state in "time", and explains how
  25to get there.
  26
  27Normally a commit would identify a new "HEAD" state, and while git
  28doesn't care where you save the note about that state, in practice we
  29tend to just write the result to the file that is pointed at by
  30`.git/HEAD`, so that we can always see what the last committed
  31state was.
  32
  33OPTIONS
  34-------
  35<tree>::
  36        An existing tree object
  37
  38-p <parent commit>::
  39        Each '-p' indicates the id of a parent commit object.
  40        
  41
  42Commit Information
  43------------------
  44
  45A commit encapsulates:
  46
  47- all parent object ids
  48- author name, email and date
  49- committer name and email and the commit time.
  50
  51If not provided, "git-commit-tree" uses your name, hostname and domain to
  52provide author and committer info. This can be overridden by
  53either `.git/config` file, or using the following environment variables.
  54
  55        GIT_AUTHOR_NAME
  56        GIT_AUTHOR_EMAIL
  57        GIT_AUTHOR_DATE
  58        GIT_COMMITTER_NAME
  59        GIT_COMMITTER_EMAIL
  60
  61(nb "<", ">" and "\n"s are stripped)
  62
  63In `.git/config` file, the following items are used for GIT_AUTHOR_NAME and
  64GIT_AUTHOR_EMAIL:
  65
  66        [user]
  67                name = "Your Name"
  68                email = "your@email.address.xz"
  69
  70A commit comment is read from stdin (max 999 chars). If a changelog
  71entry is not provided via "<" redirection, "git-commit-tree" will just wait
  72for one to be entered and terminated with ^D.
  73
  74
  75Diagnostics
  76-----------
  77You don't exist. Go away!::
  78    The passwd(5) gecos field couldn't be read
  79Your parents must have hated you!::
  80    The password(5) gecos field is longer than a giant static buffer.
  81Your sysadmin must hate you!::
  82    The password(5) name field is longer than a giant static buffer.
  83
  84Discussion
  85----------
  86
  87include::i18n.txt[]
  88
  89See Also
  90--------
  91gitlink:git-write-tree[1]
  92
  93
  94Author
  95------
  96Written by Linus Torvalds <torvalds@osdl.org>
  97
  98Documentation
  99--------------
 100Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 101
 102GIT
 103---
 104Part of the gitlink:git[7] suite
 105