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            [-e] [--author &lt;author&gt;] [--] [[-i | -o ]&lt;file&gt;&#8230;]</div></div>\r
 278 </div>\r
 279 <h2>DESCRIPTION</h2>\r
 280 <div class="sectionbody">\r
 281 <p>Updates the index file for given paths, or all modified files if\r
 282 <em>-a</em> is specified, and makes a commit object.  The command\r
 283 VISUAL and EDITOR environment variables to edit the commit log\r
 284 message.</p>\r
 285 <p>This command can run <tt>commit-msg</tt>, <tt>pre-commit</tt>, and\r
 286 <tt>post-commit</tt> hooks.  See <a href="hooks.html">hooks</a> for more\r
 287 information.</p>\r
 288 </div>\r
 289 <h2>OPTIONS</h2>\r
 290 <div class="sectionbody">\r
 291 <dl>\r
 292 <dt>\r
 293 -a|--all\r
 294 </dt>\r
 295 <dd>\r
 296 <p>\r
 297         Update all paths in the index file.  This flag notices\r
 298         files that have been modified and deleted, but new files\r
 299         you have not told git about are not affected.\r
 300 </p>\r
 301 </dd>\r
 302 <dt>\r
 303 -c or -C &lt;commit&gt;\r
 304 </dt>\r
 305 <dd>\r
 306 <p>\r
 307         Take existing commit object, and reuse the log message\r
 308         and the authorship information (including the timestamp)\r
 309         when creating the commit.  With <em>-C</em>, the editor is not\r
 310         invoked; with <em>-c</em> the user can further edit the commit\r
 311         message.\r
 312 </p>\r
 313 </dd>\r
 314 <dt>\r
 315 -F &lt;file&gt;\r
 316 </dt>\r
 317 <dd>\r
 318 <p>\r
 319         Take the commit message from the given file.  Use <em>-</em> to\r
 320         read the message from the standard input.\r
 321 </p>\r
 322 </dd>\r
 323 <dt>\r
 324 --author &lt;author&gt;\r
 325 </dt>\r
 326 <dd>\r
 327 <p>\r
 328         Override the author name used in the commit.  Use\r
 329         <tt>A U Thor &lt;author@example.com&gt;</tt> format.\r
 330 </p>\r
 331 </dd>\r
 332 <dt>\r
 333 -m &lt;msg&gt;\r
 334 </dt>\r
 335 <dd>\r
 336 <p>\r
 337         Use the given &lt;msg&gt; as the commit message.\r
 338 </p>\r
 339 </dd>\r
 340 <dt>\r
 341 -s|--signoff\r
 342 </dt>\r
 343 <dd>\r
 344 <p>\r
 345         Add Signed-off-by line at the end of the commit message.\r
 346 </p>\r
 347 </dd>\r
 348 <dt>\r
 349 -v|--verify\r
 350 </dt>\r
 351 <dd>\r
 352 <p>\r
 353         Look for suspicious lines the commit introduces, and\r
 354         abort committing if there is one.  The definition of\r
 355         <em>suspicious lines</em> is currently the lines that has\r
 356         trailing whitespaces, and the lines whose indentation\r
 357         has a SP character immediately followed by a TAB\r
 358         character.  This is the default.\r
 359 </p>\r
 360 </dd>\r
 361 <dt>\r
 362 -n|--no-verify\r
 363 </dt>\r
 364 <dd>\r
 365 <p>\r
 366         The opposite of <tt>--verify</tt>.\r
 367 </p>\r
 368 </dd>\r
 369 <dt>\r
 370 -e|--edit\r
 371 </dt>\r
 372 <dd>\r
 373 <p>\r
 374         The message taken from file with <tt>-F</tt>, command line with\r
 375         <tt>-m</tt>, and from file with <tt>-C</tt> are usually used as the\r
 376         commit log message unmodified.  This option lets you\r
 377         further edit the message taken from these sources.\r
 378 </p>\r
 379 </dd>\r
 380 <dt>\r
 381 -i|--include\r
 382 </dt>\r
 383 <dd>\r
 384 <p>\r
 385         Instead of committing only the files specified on the\r
 386         command line, update them in the index file and then\r
 387         commit the whole index.  This is the traditional\r
 388         behaviour.\r
 389 </p>\r
 390 </dd>\r
 391 <dt>\r
 392 -o|--only\r
 393 </dt>\r
 394 <dd>\r
 395 <p>\r
 396         Commit only the files specified on the command line.\r
 397         This format cannot be used during a merge, nor when the\r
 398         index and the latest commit does not match on the\r
 399         specified paths to avoid confusion.\r
 400 </p>\r
 401 </dd>\r
 402 <dt>\r
 403 &#8212;\r
 404 </dt>\r
 405 <dd>\r
 406 <p>\r
 407         Do not interpret any more arguments as options.\r
 408 </p>\r
 409 </dd>\r
 410 <dt>\r
 411 &lt;file&gt;&#8230;\r
 412 </dt>\r
 413 <dd>\r
 414 <p>\r
 415         Files to be committed.  The meaning of these is\r
 416         different between <tt>--include</tt> and <tt>--only</tt>.  Without\r
 417         either, it defaults <tt>--only</tt> semantics.\r
 418 </p>\r
 419 </dd>\r
 420 </dl>\r
 421 <p>If you make a commit and then found a mistake immediately after\r
 422 that, you can recover from it with <a href="git-reset.html">git-reset(1)</a>.</p>\r
 423 </div>\r
 424 <h2>Discussion</h2>\r
 425 <div class="sectionbody">\r
 426 <p><tt>git commit</tt> without _any_ parameter commits the tree structure\r
 427 recorded by the current index file.  This is a whole-tree commit\r
 428 even the command is invoked from a subdirectory.</p>\r
 429 <p><tt>git commit --include paths&#8230;</tt> is equivalent to</p>\r
 430 <div class="literalblock">\r
 431 <div class="content">\r
 432 <pre><tt>git update-index --remove paths...\r
 433 git commit</tt></pre>\r
 434 </div></div>\r
 435 <p>That is, update the specified paths to the index and then commit\r
 436 the whole tree.</p>\r
 437 <p><tt>git commit paths&#8230;</tt> largely bypasses the index file and\r
 438 commits only the changes made to the specified paths.  It has\r
 439 however several safety valves to prevent confusion.</p>\r
 440 <ol>\r
 441 <li>\r
 442 <p>\r
 443 It refuses to run during a merge (i.e. when\r
 444   <tt>$GIT_DIR/MERGE_HEAD</tt> exists), and reminds trained git users\r
 445   that the traditional semantics now needs -i flag.\r
 446 </p>\r
 447 </li>\r
 448 <li>\r
 449 <p>\r
 450 It refuses to run if named <tt>paths&#8230;</tt> are different in HEAD\r
 451   and the index (ditto about reminding).  Added paths are OK.\r
 452   This is because an earlier <tt>git diff</tt> (not <tt>git diff HEAD</tt>)\r
 453   would have shown the differences since the last <tt>git\r
 454   update-index paths&#8230;</tt> to the user, and an inexperienced user\r
 455   may mistakenly think that the changes between the index and\r
 456   the HEAD (i.e. earlier changes made before the last <tt>git\r
 457   update-index paths&#8230;</tt> was done) are not being committed.\r
 458 </p>\r
 459 </li>\r
 460 <li>\r
 461 <p>\r
 462 It reads HEAD commit into a temporary index file, updates the\r
 463   specified <tt>paths&#8230;</tt> and makes a commit.  At the same time,\r
 464   the real index file is also updated with the same <tt>paths&#8230;</tt>.\r
 465 </p>\r
 466 </li>\r
 467 </ol>\r
 468 <p><tt>git commit --all</tt> updates the index file with _all_ changes to\r
 469 the working tree, and makes a whole-tree commit, regardless of\r
 470 which subdirectory the command is invoked in.</p>\r
 471 </div>\r
 472 <h2>Author</h2>\r
 473 <div class="sectionbody">\r
 474 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and\r
 475 Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 476 </div>\r
 477 <h2>GIT</h2>\r
 478 <div class="sectionbody">\r
 479 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 480 </div>\r
 481 <div id="footer">\r
 482 <div id="footer-text">\r
 483 Last updated 14-Feb-2006 07:59:59 UTC\r
 484 </div>\r
 485 </div>\r
 486 </body>\r
 487 </html>\r