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