git-commit.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-commit(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-commit(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-commit -\r
 269    Record your changes\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content"><em>git-commit</em> [-a] [-s] [-v] [(-c | -C) &lt;commit&gt; | -F &lt;file&gt; | -m &lt;msg&gt;]\r
 277            [--no-verify] [--amend] [-e] [--author &lt;author&gt;]\r
 278            [--] [[-i | -o ]&lt;file&gt;&#8230;]</div></div>\r
 279 </div>\r
 280 <h2>DESCRIPTION</h2>\r
 281 <div class="sectionbody">\r
 282 <p>Updates the index file for given paths, or all modified files if\r
 283 <em>-a</em> is specified, and makes a commit object.  The command\r
 284 VISUAL and EDITOR environment variables to edit the commit log\r
 285 message.</p>\r
 286 <p>Several environment variable are used during commits.  They are\r
 287 documented in <a href="git-commit-tree.html">git-commit-tree(1)</a>.</p>\r
 288 <p>This command can run <tt>commit-msg</tt>, <tt>pre-commit</tt>, and\r
 289 <tt>post-commit</tt> hooks.  See <a href="hooks.html">hooks</a> for more\r
 290 information.</p>\r
 291 </div>\r
 292 <h2>OPTIONS</h2>\r
 293 <div class="sectionbody">\r
 294 <dl>\r
 295 <dt>\r
 296 -a|--all\r
 297 </dt>\r
 298 <dd>\r
 299 <p>\r
 300         Update all paths in the index file.  This flag notices\r
 301         files that have been modified and deleted, but new files\r
 302         you have not told git about are not affected.\r
 303 </p>\r
 304 </dd>\r
 305 <dt>\r
 306 -c or -C &lt;commit&gt;\r
 307 </dt>\r
 308 <dd>\r
 309 <p>\r
 310         Take existing commit object, and reuse the log message\r
 311         and the authorship information (including the timestamp)\r
 312         when creating the commit.  With <em>-C</em>, the editor is not\r
 313         invoked; with <em>-c</em> the user can further edit the commit\r
 314         message.\r
 315 </p>\r
 316 </dd>\r
 317 <dt>\r
 318 -F &lt;file&gt;\r
 319 </dt>\r
 320 <dd>\r
 321 <p>\r
 322         Take the commit message from the given file.  Use <em>-</em> to\r
 323         read the message from the standard input.\r
 324 </p>\r
 325 </dd>\r
 326 <dt>\r
 327 --author &lt;author&gt;\r
 328 </dt>\r
 329 <dd>\r
 330 <p>\r
 331         Override the author name used in the commit.  Use\r
 332         <tt>A U Thor &lt;author@example.com&gt;</tt> format.\r
 333 </p>\r
 334 </dd>\r
 335 <dt>\r
 336 -m &lt;msg&gt;\r
 337 </dt>\r
 338 <dd>\r
 339 <p>\r
 340         Use the given &lt;msg&gt; as the commit message.\r
 341 </p>\r
 342 </dd>\r
 343 <dt>\r
 344 -s|--signoff\r
 345 </dt>\r
 346 <dd>\r
 347 <p>\r
 348         Add Signed-off-by line at the end of the commit message.\r
 349 </p>\r
 350 </dd>\r
 351 <dt>\r
 352 -v|--verify\r
 353 </dt>\r
 354 <dd>\r
 355 <p>\r
 356         Look for suspicious lines the commit introduces, and\r
 357         abort committing if there is one.  The definition of\r
 358         <em>suspicious lines</em> is currently the lines that has\r
 359         trailing whitespaces, and the lines whose indentation\r
 360         has a SP character immediately followed by a TAB\r
 361         character.  This is the default.\r
 362 </p>\r
 363 </dd>\r
 364 <dt>\r
 365 -n|--no-verify\r
 366 </dt>\r
 367 <dd>\r
 368 <p>\r
 369         The opposite of <tt>--verify</tt>.\r
 370 </p>\r
 371 </dd>\r
 372 <dt>\r
 373 -e|--edit\r
 374 </dt>\r
 375 <dd>\r
 376 <p>\r
 377         The message taken from file with <tt>-F</tt>, command line with\r
 378         <tt>-m</tt>, and from file with <tt>-C</tt> are usually used as the\r
 379         commit log message unmodified.  This option lets you\r
 380         further edit the message taken from these sources.\r
 381 </p>\r
 382 </dd>\r
 383 <dt>\r
 384 --amend\r
 385 </dt>\r
 386 <dd>\r
 387 <p>\r
 388         Used to amend the tip of the current branch. Prepare the tree\r
 389         object you would want to replace the latest commit as usual\r
 390         (this includes the usual -i/-o and explicit paths), and the\r
 391         commit log editor is seeded with the commit message from the\r
 392         tip of the current branch. The commit you create replaces the\r
 393         current tip &#8212; if it was a merge, it will have the parents of\r
 394         the current tip as parents &#8212; so the current top commit is\r
 395         discarded.\r
 396 </p>\r
 397 <p>It is a rough equivalent for:</p>\r
 398 <div class="listingblock">\r
 399 <div class="content">\r
 400 <pre><tt>        $ git reset --soft HEAD^\r
 401         $ ... do something else to come up with the right tree ...\r
 402         $ git commit -c ORIG_HEAD\r
 403 </tt></pre>\r
 404 </div></div>\r
 405 <p>but can be used to amend a merge commit.</p>\r
 406 </dd>\r
 407 <dt>\r
 408 -i|--include\r
 409 </dt>\r
 410 <dd>\r
 411 <p>\r
 412         Instead of committing only the files specified on the\r
 413         command line, update them in the index file and then\r
 414         commit the whole index.  This is the traditional\r
 415         behaviour.\r
 416 </p>\r
 417 </dd>\r
 418 <dt>\r
 419 -o|--only\r
 420 </dt>\r
 421 <dd>\r
 422 <p>\r
 423         Commit only the files specified on the command line.\r
 424         This format cannot be used during a merge, nor when the\r
 425         index and the latest commit does not match on the\r
 426         specified paths to avoid confusion.\r
 427 </p>\r
 428 </dd>\r
 429 <dt>\r
 430 &#8212;\r
 431 </dt>\r
 432 <dd>\r
 433 <p>\r
 434         Do not interpret any more arguments as options.\r
 435 </p>\r
 436 </dd>\r
 437 <dt>\r
 438 &lt;file&gt;&#8230;\r
 439 </dt>\r
 440 <dd>\r
 441 <p>\r
 442         Files to be committed.  The meaning of these is\r
 443         different between <tt>--include</tt> and <tt>--only</tt>.  Without\r
 444         either, it defaults <tt>--only</tt> semantics.\r
 445 </p>\r
 446 </dd>\r
 447 </dl>\r
 448 <p>If you make a commit and then found a mistake immediately after\r
 449 that, you can recover from it with <a href="git-reset.html">git-reset(1)</a>.</p>\r
 450 </div>\r
 451 <h2>Discussion</h2>\r
 452 <div class="sectionbody">\r
 453 <p><tt>git commit</tt> without _any_ parameter commits the tree structure\r
 454 recorded by the current index file.  This is a whole-tree commit\r
 455 even the command is invoked from a subdirectory.</p>\r
 456 <p><tt>git commit --include paths&#8230;</tt> is equivalent to</p>\r
 457 <div class="literalblock">\r
 458 <div class="content">\r
 459 <pre><tt>git update-index --remove paths...\r
 460 git commit</tt></pre>\r
 461 </div></div>\r
 462 <p>That is, update the specified paths to the index and then commit\r
 463 the whole tree.</p>\r
 464 <p><tt>git commit paths&#8230;</tt> largely bypasses the index file and\r
 465 commits only the changes made to the specified paths.  It has\r
 466 however several safety valves to prevent confusion.</p>\r
 467 <ol>\r
 468 <li>\r
 469 <p>\r
 470 It refuses to run during a merge (i.e. when\r
 471   <tt>$GIT_DIR/MERGE_HEAD</tt> exists), and reminds trained git users\r
 472   that the traditional semantics now needs -i flag.\r
 473 </p>\r
 474 </li>\r
 475 <li>\r
 476 <p>\r
 477 It refuses to run if named <tt>paths&#8230;</tt> are different in HEAD\r
 478   and the index (ditto about reminding).  Added paths are OK.\r
 479   This is because an earlier <tt>git diff</tt> (not <tt>git diff HEAD</tt>)\r
 480   would have shown the differences since the last <tt>git\r
 481   update-index paths&#8230;</tt> to the user, and an inexperienced user\r
 482   may mistakenly think that the changes between the index and\r
 483   the HEAD (i.e. earlier changes made before the last <tt>git\r
 484   update-index paths&#8230;</tt> was done) are not being committed.\r
 485 </p>\r
 486 </li>\r
 487 <li>\r
 488 <p>\r
 489 It reads HEAD commit into a temporary index file, updates the\r
 490   specified <tt>paths&#8230;</tt> and makes a commit.  At the same time,\r
 491   the real index file is also updated with the same <tt>paths&#8230;</tt>.\r
 492 </p>\r
 493 </li>\r
 494 </ol>\r
 495 <p><tt>git commit --all</tt> updates the index file with _all_ changes to\r
 496 the working tree, and makes a whole-tree commit, regardless of\r
 497 which subdirectory the command is invoked in.</p>\r
 498 </div>\r
 499 <h2>Author</h2>\r
 500 <div class="sectionbody">\r
 501 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and\r
 502 Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 503 </div>\r
 504 <h2>GIT</h2>\r
 505 <div class="sectionbody">\r
 506 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 507 </div>\r
 508 <div id="footer">\r
 509 <div id="footer-text">\r
 510 Last updated 05-Apr-2006 23:07:59 UTC\r
 511 </div>\r
 512 </div>\r
 513 </body>\r
 514 </html>\r