Documentation/git-commit-tree.txt

   1 git-commit-tree(1)
   2 ==================
   3
   4 NAME
   5 ----
   6 git-commit-tree - Create a new commit object
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git commit-tree' <tree> [(-p <parent>)...] < changelog
  13 'git commit-tree' <tree> [(-p <parent>)...] [(-m <message>)...] [(-F <file>)...]
  14
  15 DESCRIPTION
  16 -----------
  17 This is usually not what an end user wants to run directly.  See
  18 linkgit:git-commit[1] instead.
  19
  20 Creates a new commit object based on the provided tree object and
  21 emits the new commit object id on stdout. The log message is read
  22 from the standard input, unless `-m` or `-F` options are given.
  23
  24 A commit object may have any number of parents. With exactly one
  25 parent, it is an ordinary commit. Having more than one parent makes
  26 the commit a merge between several lines of history. Initial (root)
  27 commits have no parents.
  28
  29 While a tree represents a particular directory state of a working
  30 directory, a commit represents that state in "time", and explains how
  31 to get there.
  32
  33 Normally a commit would identify a new "HEAD" state, and while git
  34 doesn't care where you save the note about that state, in practice we
  35 tend to just write the result to the file that is pointed at by
  36 `.git/HEAD`, so that we can always see what the last committed
  37 state was.
  38
  39 OPTIONS
  40 -------
  41 <tree>::
  42         An existing tree object
  43
  44 -p <parent>::
  45         Each '-p' indicates the id of a parent commit object.
  46
  47 -m <message>::
  48         A paragraph in the commit log message. This can be given more than
  49         once and each <message> becomes its own paragraph.
  50
  51 -F <file>::
  52         Read the commit log message from the given file. Use `-` to read
  53         from the standard input.
  54
  55
  56 Commit Information
  57 ------------------
  58
  59 A commit encapsulates:
  60
  61 - all parent object ids
  62 - author name, email and date
  63 - committer name and email and the commit time.
  64
  65 While parent object ids are provided on the command line, author and
  66 committer information is taken from the following environment variables,
  67 if set:
  68
  69         GIT_AUTHOR_NAME
  70         GIT_AUTHOR_EMAIL
  71         GIT_AUTHOR_DATE
  72         GIT_COMMITTER_NAME
  73         GIT_COMMITTER_EMAIL
  74         GIT_COMMITTER_DATE
  75         EMAIL
  76
  77 (nb "<", ">" and "\n"s are stripped)
  78
  79 In case (some of) these environment variables are not set, the information
  80 is taken from the configuration items user.name and user.email, or, if not
  81 present, system user name and the hostname used for outgoing mail (taken
  82 from `/etc/mailname` and falling back to the fully qualified hostname when
  83 that file does not exist).
  84
  85 A commit comment is read from stdin. If a changelog
  86 entry is not provided via "<" redirection, 'git commit-tree' will just wait
  87 for one to be entered and terminated with ^D.
  88
  89 include::date-formats.txt[]
  90
  91 Discussion
  92 ----------
  93
  94 include::i18n.txt[]
  95
  96 FILES
  97 -----
  98 /etc/mailname
  99
 100 SEE ALSO
 101 --------
 102 linkgit:git-write-tree[1]
 103
 104 GIT
 105 ---
 106 Part of the linkgit:git[1] suite