Google Git
Sign in
chromium / external / gitster / git-htmldocs / ad0c76a1f57b519ff2fe90bd3e8e5037ac669c97 / . / git-add.html
blob: eeee111c1d1a357a37cc75b17407b6f06ceec03f [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]7<title>git-add(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]180 text-align: right;
181}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]182
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]256
257div.tableblock > table {
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]285
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]293}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 vertical-align: top;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-add(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-add -
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]578 Add file contents to the index
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]584<div class="sectionbody">
Junio C Hamano8b8b0f22007-08-26 22:10:26[diff] [blame]585<div class="verseblock">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]586<div class="verseblock-content"><em>git add</em> [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
Junio C Hamano52ba2952009-05-18 17:43:02[diff] [blame]587 [--edit | -e] [--all | [--update | -u]] [--intent-to-add | -N]
Junio C Hamanoafabd322010-07-19 20:26:15[diff] [blame]588 [--refresh] [--ignore-errors] [--ignore-missing] [--]
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]589 [&lt;filepattern&gt;&#8230;]</div>
590<div class="verseblock-attribution">
591</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]592</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]593<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]594<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]595<div class="paragraph"><p>This command updates the index using the current content found in
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]596the working tree, to prepare the content staged for the next commit.
597It typically adds the current content of existing paths as a whole,
598but with some options it can also be used to add content with
599only part of the changes made to the working tree files applied, or
600remove paths that do not exist in the working tree anymore.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]601<div class="paragraph"><p>The "index" holds a snapshot of the content of the working tree, and it
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]602is this snapshot that is taken as the contents of the next commit. Thus
603after making any changes to the working directory, and before running
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]604the commit command, you must use the <tt>add</tt> command to add any new or
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]605modified files to the index.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]606<div class="paragraph"><p>This command can be performed multiple times before a commit. It only
Junio C Hamano4cd1c0e2007-08-06 04:39:14[diff] [blame]607adds the content of the specified file(s) at the time the add command is
608run; if you want subsequent changes included in the next commit, then
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]609you must run <tt>git add</tt> again to add the new content to the index.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]610<div class="paragraph"><p>The <tt>git status</tt> command can be used to obtain a summary of which
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]611files have changes that are staged for the next commit.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]612<div class="paragraph"><p>The <tt>git add</tt> command will not add ignored files by default. If any
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]613ignored files were explicitly specified on the command line, <tt>git add</tt>
Junio C Hamano3c1f2c72007-08-17 07:48:05[diff] [blame]614will fail with a list of ignored files. Ignored files reached by
Junio C Hamano7d9e9bd2007-08-29 07:31:47[diff] [blame]615directory recursion or filename globbing performed by Git (quote your
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]616globs before the shell) will be silently ignored. The <em>git add</em> command can
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]617be used to add ignored files with the <tt>-f</tt> (force) option.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]618<div class="paragraph"><p>Please see <a href="git-commit.html">git-commit(1)</a> for alternative ways to add content to a
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]619commit.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]620</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]621<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]622<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]623<div class="dlist"><dl>
624<dt class="hdlist1">
Junio C Hamano8b8b0f22007-08-26 22:10:26[diff] [blame]625&lt;filepattern&gt;&#8230;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]626</dt>
627<dd>
628<p>
Junio C Hamano3d2adc72006-12-26 03:21:45[diff] [blame]629 Files to add content from. Fileglobs (e.g. <tt>*.c</tt>) can
630 be given to add all matching files. Also a
631 leading directory name (e.g. <tt>dir</tt> to add <tt>dir/file1</tt>
632 and <tt>dir/file2</tt>) can be given to add all files in the
633 directory, recursively.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]634</p>
635</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]636<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]637-n
638</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]639<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]640--dry-run
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]641</dt>
642<dd>
643<p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]644 Don&#8217;t actually add the file(s), just show if they exist and/or will
Junio C Hamanoafabd322010-07-19 20:26:15[diff] [blame]645 be ignored.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]646</p>
647</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]648<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]649-v
650</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]651<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]652--verbose
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]653</dt>
654<dd>
655<p>
656 Be verbose.
657</p>
658</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]659<dt class="hdlist1">
Junio C Hamano3d2adc72006-12-26 03:21:45[diff] [blame]660-f
661</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]662<dt class="hdlist1">
Junio C Hamano00e884a2008-06-15 05:10:38[diff] [blame]663--force
664</dt>
Junio C Hamano3d2adc72006-12-26 03:21:45[diff] [blame]665<dd>
666<p>
667 Allow adding otherwise ignored files.
668</p>
669</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]670<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]671-i
672</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]673<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]674--interactive
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]675</dt>
676<dd>
677<p>
678 Add modified contents in the working tree interactively to
Junio C Hamanoe0facb92007-12-05 10:59:48[diff] [blame]679 the index. Optional path arguments may be supplied to limit
680 operation to a subset of the working tree. See &#8220;Interactive
681 mode&#8221; for details.
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]682</p>
683</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]684<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]685-p
686</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]687<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]688--patch
Junio C Hamano8d1e4712007-12-11 08:54:21[diff] [blame]689</dt>
690<dd>
691<p>
Junio C Hamano7df6dcf2009-09-13 09:51:17[diff] [blame]692 Interactively choose hunks of patch between the index and the
693 work tree and add them to the index. This gives the user a chance
694 to review the difference before adding modified contents to the
695 index.
Junio C Hamano8d1e4712007-12-11 08:54:21[diff] [blame]696</p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]697<div class="paragraph"><p>This effectively runs <tt>add --interactive</tt>, but bypasses the
Junio C Hamanoe1b26832009-11-15 10:02:56[diff] [blame]698initial command menu and directly jumps to the <tt>patch</tt> subcommand.
699See &#8220;Interactive mode&#8221; for details.</p></div>
Junio C Hamano8d1e4712007-12-11 08:54:21[diff] [blame]700</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]701<dt class="hdlist1">
Junio C Hamano52ba2952009-05-18 17:43:02[diff] [blame]702-e, --edit
703</dt>
704<dd>
705<p>
706 Open the diff vs. the index in an editor and let the user
707 edit it. After the editor was closed, adjust the hunk headers
708 and apply the patch to the index.
709</p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]710<div class="paragraph"><p>The intent of this option is to pick and choose lines of the patch to
711apply, or even to modify the contents of lines to be staged. This can be
712quicker and more flexible than using the interactive hunk selector.
713However, it is easy to confuse oneself and create a patch that does not
714apply to the index. See EDITING PATCHES below.</p></div>
Junio C Hamano52ba2952009-05-18 17:43:02[diff] [blame]715</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]716<dt class="hdlist1">
Junio C Hamano3d30fd52007-05-08 00:32:53[diff] [blame]717-u
718</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]719<dt class="hdlist1">
Junio C Hamano00e884a2008-06-15 05:10:38[diff] [blame]720--update
721</dt>
Junio C Hamano3d30fd52007-05-08 00:32:53[diff] [blame]722<dd>
723<p>
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]724 Only match &lt;filepattern&gt; against already tracked files in
725 the index rather than the working tree. That means that it
726 will never stage new files, but that it will stage modified
727 new contents of tracked files and that it will remove files
728 from the index if the corresponding files in the working tree
729 have been removed.
Junio C Hamano3d30fd52007-05-08 00:32:53[diff] [blame]730</p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]731<div class="paragraph"><p>If no &lt;filepattern&gt; is given, default to "."; in other words,
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]732update all tracked files in the current directory and its
733subdirectories.</p></div>
Junio C Hamano3d30fd52007-05-08 00:32:53[diff] [blame]734</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]735<dt class="hdlist1">
Junio C Hamano5ba2c222008-07-21 04:33:46[diff] [blame]736-A
737</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]738<dt class="hdlist1">
Junio C Hamano5ba2c222008-07-21 04:33:46[diff] [blame]739--all
740</dt>
741<dd>
742<p>
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]743 Like <tt>-u</tt>, but match &lt;filepattern&gt; against files in the
744 working tree in addition to the index. That means that it
745 will find new files as well as staging modified content and
746 removing files that are no longer in the working tree.
Junio C Hamano5ba2c222008-07-21 04:33:46[diff] [blame]747</p>
748</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]749<dt class="hdlist1">
Junio C Hamano845880c2008-10-21 19:04:45[diff] [blame]750-N
751</dt>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]752<dt class="hdlist1">
Junio C Hamano845880c2008-10-21 19:04:45[diff] [blame]753--intent-to-add
754</dt>
755<dd>
756<p>
757 Record only the fact that the path will be added later. An entry
758 for the path is placed in the index with no content. This is
759 useful for, among other things, showing the unstaged content of
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]760 such files with <tt>git diff</tt> and committing them with <tt>git commit
761 -a</tt>.
Junio C Hamano845880c2008-10-21 19:04:45[diff] [blame]762</p>
763</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]764<dt class="hdlist1">
Junio C Hamano024b6c62007-08-14 09:43:08[diff] [blame]765--refresh
766</dt>
767<dd>
768<p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]769 Don&#8217;t add the file(s), but only refresh their stat()
Junio C Hamano024b6c62007-08-14 09:43:08[diff] [blame]770 information in the index.
771</p>
772</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]773<dt class="hdlist1">
Junio C Hamanofeeb1be2008-05-22 00:53:35[diff] [blame]774--ignore-errors
775</dt>
776<dd>
777<p>
778 If some files could not be added because of errors indexing
779 them, do not abort the operation, but continue adding the
780 others. The command shall still exit with non-zero status.
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]781 The configuration variable <tt>add.ignoreErrors</tt> can be set to
782 true to make this the default behaviour.
Junio C Hamanofeeb1be2008-05-22 00:53:35[diff] [blame]783</p>
784</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]785<dt class="hdlist1">
Junio C Hamanoafabd322010-07-19 20:26:15[diff] [blame]786--ignore-missing
787</dt>
788<dd>
789<p>
790 This option can only be used together with --dry-run. By using
791 this option the user can check if any of the given files would
792 be ignored, no matter if they are already present in the work
793 tree or not.
794</p>
795</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]796<dt class="hdlist1">
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]797--
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]798</dt>
799<dd>
800<p>
801 This option can be used to separate command-line options from
802 the list of files, (useful when filenames might be mistaken
803 for command-line options).
804</p>
805</dd>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]806</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]807</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]808<h2 id="_configuration">Configuration</h2>
Junio C Hamano9fbd4f72007-05-18 15:54:37[diff] [blame]809<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]810<div class="paragraph"><p>The optional configuration variable <tt>core.excludesfile</tt> indicates a path to a
Junio C Hamano9fbd4f72007-05-18 15:54:37[diff] [blame]811file containing patterns of file names to exclude from git-add, similar to
812$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]813those in info/exclude. See <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.</p></div>
Junio C Hamano9fbd4f72007-05-18 15:54:37[diff] [blame]814</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]815<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]816<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]817<div class="ulist"><ul>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]818<li>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]819<p>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]820Adds content from all <tt>*.txt</tt> files under <tt>Documentation</tt> directory
821and its subdirectories:
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]822</p>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]823<div class="listingblock">
824<div class="content">
Junio C Hamano78b92a82010-02-09 07:34:13[diff] [blame]825<pre><tt>$ git add Documentation/\*.txt</tt></pre>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]826</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]827<div class="paragraph"><p>Note that the asterisk <tt>*</tt> is quoted from the shell in this
Junio C Hamanof8a79222009-03-01 08:02:50[diff] [blame]828example; this lets the command include the files from
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]829subdirectories of <tt>Documentation/</tt> directory.</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]830</li>
831<li>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]832<p>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]833Considers adding content from all git-*.sh scripts:
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]834</p>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]835<div class="listingblock">
836<div class="content">
837<pre><tt>$ git add git-*.sh</tt></pre>
838</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]839<div class="paragraph"><p>Because this example lets the shell expand the asterisk (i.e. you are
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]840listing the files explicitly), it does not consider
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]841<tt>subdir/git-foo.sh</tt>.</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]842</li>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]843</ul></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]844</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]845<h2 id="_interactive_mode">Interactive mode</h2>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]846<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]847<div class="paragraph"><p>When the command enters the interactive mode, it shows the
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]848output of the <em>status</em> subcommand, and then goes into its
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]849interactive command loop.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]850<div class="paragraph"><p>The command loop shows the list of subcommands available, and
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]851gives a prompt "What now&gt; ". In general, when the prompt ends
852with a single <em>&gt;</em>, you can pick only one of the choices given
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]853and type return, like this:</p></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]854<div class="listingblock">
855<div class="content">
856<pre><tt> *** Commands ***
857 1: status 2: update 3: revert 4: add untracked
858 5: patch 6: diff 7: quit 8: help
859 What now&gt; 1</tt></pre>
860</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]861<div class="paragraph"><p>You also could say <tt>s</tt> or <tt>sta</tt> or <tt>status</tt> above as long as the
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]862choice is unique.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]863<div class="paragraph"><p>The main command loop has 6 subcommands (plus help and quit).</p></div>
864<div class="dlist"><dl>
865<dt class="hdlist1">
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]866status
867</dt>
868<dd>
869<p>
870 This shows the change between HEAD and index (i.e. what will be
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]871 committed if you say <tt>git commit</tt>), and between index and
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]872 working tree files (i.e. what you could stage further before
Junio C Hamanoae05fee2010-01-08 07:39:46[diff] [blame]873 <tt>git commit</tt> using <tt>git add</tt>) for each path. A sample output
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]874 looks like this:
875</p>
876<div class="listingblock">
877<div class="content">
878<pre><tt> staged unstaged path
879 1: binary nothing foo.png
880 2: +403/-35 +1/-1 git-add--interactive.perl</tt></pre>
881</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]882<div class="paragraph"><p>It shows that foo.png has differences from HEAD (but that is
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]883binary so line count cannot be shown) and there is no
884difference between indexed copy and the working tree
885version (if the working tree version were also different,
886<em>binary</em> would have been shown in place of <em>nothing</em>). The
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]887other file, git-add&#45;&#45;interactive.perl, has 403 lines added
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]888and 35 lines deleted if you commit what is in the index, but
889working tree file has further modifications (one addition and
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]890one deletion).</p></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]891</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]892<dt class="hdlist1">
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]893update
894</dt>
895<dd>
896<p>
Junio C Hamanof8a79222009-03-01 08:02:50[diff] [blame]897 This shows the status information and issues an "Update&gt;&gt;"
898 prompt. When the prompt ends with double <em>&gt;&gt;</em>, you can
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]899 make more than one selection, concatenated with whitespace or
900 comma. Also you can say ranges. E.g. "2-5 7,9" to choose
Junio C Hamano38ddcce2008-07-15 15:49:03[diff] [blame]901 2,3,4,5,7,9 from the list. If the second number in a range is
902 omitted, all remaining patches are taken. E.g. "7-" to choose
903 7,8,9 from the list. You can say <em>*</em> to choose everything.
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]904</p>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]905<div class="paragraph"><p>What you chose are then highlighted with <em>*</em>,
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]906like this:</p></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]907<div class="listingblock">
908<div class="content">
909<pre><tt> staged unstaged path
910 1: binary nothing foo.png
911* 2: +403/-35 +1/-1 git-add--interactive.perl</tt></pre>
912</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]913<div class="paragraph"><p>To remove selection, prefix the input with <tt>-</tt>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]914like this:</p></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]915<div class="listingblock">
916<div class="content">
917<pre><tt>Update&gt;&gt; -2</tt></pre>
918</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]919<div class="paragraph"><p>After making the selection, answer with an empty line to stage the
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]920contents of working tree files for selected paths in the index.</p></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]921</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]922<dt class="hdlist1">
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]923revert
924</dt>
925<dd>
926<p>
927 This has a very similar UI to <em>update</em>, and the staged
928 information for selected paths are reverted to that of the
929 HEAD version. Reverting new paths makes them untracked.
930</p>
931</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]932<dt class="hdlist1">
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]933add untracked
934</dt>
935<dd>
936<p>
937 This has a very similar UI to <em>update</em> and
938 <em>revert</em>, and lets you add untracked paths to the index.
939</p>
940</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]941<dt class="hdlist1">
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]942patch
943</dt>
944<dd>
945<p>
Junio C Hamanof8a79222009-03-01 08:02:50[diff] [blame]946 This lets you choose one path out of a <em>status</em> like selection.
947 After choosing the path, it presents the diff between the index
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]948 and the working tree file and asks you if you want to stage
Junio C Hamano9eb58352011-05-11 20:09:24[diff] [blame]949 the change of each hunk. You can select one of the following
950 options and type return:
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]951</p>
952<div class="literalblock">
953<div class="content">
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]954<pre><tt>y - stage this hunk
955n - do not stage this hunk
Junio C Hamanoa574a092010-06-13 19:57:10[diff] [blame]956q - quit; do not stage this hunk nor any of the remaining ones
957a - stage this hunk and all later hunks in the file
958d - do not stage this hunk nor any of the later hunks in the file
Junio C Hamano3bd66e92009-04-18 06:17:56[diff] [blame]959g - select a hunk to go to
960/ - search for a hunk matching the given regex
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]961j - leave this hunk undecided, see next undecided hunk
962J - leave this hunk undecided, see next hunk
963k - leave this hunk undecided, see previous undecided hunk
964K - leave this hunk undecided, see previous hunk
Junio C Hamanoe0facb92007-12-05 10:59:48[diff] [blame]965s - split the current hunk into smaller hunks
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]966e - manually edit the current hunk
Junio C Hamanoe0facb92007-12-05 10:59:48[diff] [blame]967? - print help</tt></pre>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]968</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]969<div class="paragraph"><p>After deciding the fate for all hunks, if there is any hunk
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]970that was chosen, the index is updated with the selected hunks.</p></div>
Junio C Hamano9eb58352011-05-11 20:09:24[diff] [blame]971<div class="paragraph"><p>You can omit having to type return here, by setting the configuration
972variable <tt>interactive.singlekey</tt> to <tt>true</tt>.</p></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]973</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]974<dt class="hdlist1">
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]975diff
976</dt>
977<dd>
978<p>
979 This lets you review what will be committed (i.e. between
980 HEAD and index).
981</p>
982</dd>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]983</dl></div>
Junio C Hamano17bbaca2006-12-25 11:36:31[diff] [blame]984</div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]985<h2 id="_editing_patches">EDITING PATCHES</h2>
986<div class="sectionbody">
987<div class="paragraph"><p>Invoking <tt>git add -e</tt> or selecting <tt>e</tt> from the interactive hunk
988selector will open a patch in your editor; after the editor exits, the
989result is applied to the index. You are free to make arbitrary changes
990to the patch, but note that some changes may have confusing results, or
991even result in a patch that cannot be applied. If you want to abort the
992operation entirely (i.e., stage nothing new in the index), simply delete
993all lines of the patch. The list below describes some common things you
994may see in a patch, and which editing operations make sense on them.</p></div>
995<div class="dlist"><dl>
996<dt class="hdlist1">
997added content
998</dt>
999<dd>
1000<p>
1001Added content is represented by lines beginning with "&#43;". You can
1002prevent staging any addition lines by deleting them.
1003</p>
1004</dd>
1005<dt class="hdlist1">
1006removed content
1007</dt>
1008<dd>
1009<p>
1010Removed content is represented by lines beginning with "-". You can
1011prevent staging their removal by converting the "-" to a " " (space).
1012</p>
1013</dd>
1014<dt class="hdlist1">
1015modified content
1016</dt>
1017<dd>
1018<p>
1019Modified content is represented by "-" lines (removing the old content)
1020followed by "&#43;" lines (adding the replacement content). You can
1021prevent staging the modification by converting "-" lines to " ", and
1022removing "&#43;" lines. Beware that modifying only half of the pair is
1023likely to introduce confusing changes to the index.
1024</p>
1025</dd>
1026</dl></div>
1027<div class="paragraph"><p>There are also more complex operations that can be performed. But beware
1028that because the patch is applied only to the index and not the working
1029tree, the working tree will appear to "undo" the change in the index.
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]1030For example, introducing a new line into the index that is in neither
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1031the HEAD nor the working tree will stage the new line for commit, but
1032the line will appear to be reverted in the working tree.</p></div>
1033<div class="paragraph"><p>Avoid using these constructs, or do so with extreme caution.</p></div>
1034<div class="dlist"><dl>
1035<dt class="hdlist1">
1036removing untouched content
1037</dt>
1038<dd>
1039<p>
1040Content which does not differ between the index and working tree may be
1041shown on context lines, beginning with a " " (space). You can stage
1042context lines for removal by converting the space to a "-". The
1043resulting working tree file will appear to re-add the content.
1044</p>
1045</dd>
1046<dt class="hdlist1">
1047modifying existing content
1048</dt>
1049<dd>
1050<p>
1051One can also modify context lines by staging them for removal (by
1052converting " " to "-") and adding a "&#43;" line with the new content.
1053Similarly, one can modify "&#43;" lines for existing additions or
1054modifications. In all cases, the new modification will appear reverted
1055in the working tree.
1056</p>
1057</dd>
1058<dt class="hdlist1">
1059new content
1060</dt>
1061<dd>
1062<p>
1063You may also add new content that does not exist in the patch; simply
1064add new lines, each starting with "&#43;". The addition will appear
1065reverted in the working tree.
1066</p>
1067</dd>
1068</dl></div>
1069<div class="paragraph"><p>There are also several operations which should be avoided entirely, as
1070they will make the patch impossible to apply:</p></div>
1071<div class="ulist"><ul>
1072<li>
1073<p>
1074adding context (" ") or removal ("-") lines
1075</p>
1076</li>
1077<li>
1078<p>
1079deleting context or removal lines
1080</p>
1081</li>
1082<li>
1083<p>
1084modifying the contents of context or removal lines
1085</p>
1086</li>
1087</ul></div>
1088</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]1089<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano2bb13102006-03-06 07:10:21[diff] [blame]1090<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1091<div class="paragraph"><p><a href="git-status.html">git-status(1)</a>
Junio C Hamanoe7935c42006-12-13 21:32:17[diff] [blame]1092<a href="git-rm.html">git-rm(1)</a>
Junio C Hamano361c1332007-11-14 12:17:22[diff] [blame]1093<a href="git-reset.html">git-reset(1)</a>
Junio C Hamanoe7935c42006-12-13 21:32:17[diff] [blame]1094<a href="git-mv.html">git-mv(1)</a>
1095<a href="git-commit.html">git-commit(1)</a>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]1096<a href="git-update-index.html">git-update-index(1)</a></p></div>
Junio C Hamano2bb13102006-03-06 07:10:21[diff] [blame]1097</div>
Junio C Hamano46a38aa2008-07-14 03:13:27[diff] [blame]1098<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1099<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1100<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1101</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1102</div>
1103<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1104<div id="footer">
1105<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]1106Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1107</div>
1108</div>
1109</body>
1110</html>