Google Git
Sign in
chromium / external / gitster / git-htmldocs / 1291d1a1ed65a3d56c1c3dae7e3d1770eeba618c / . / git-status.html
blob: c93ffbd129acbbc55ae5e785c7017d47d723a0b2 [file] [log] [blame]
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]7<meta name="generator" content="AsciiDoc 8.6.10" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]8<title>git-status(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]41 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]46 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]47}
48
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]71
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]90
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194 text-align: right;
195}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]271
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]285}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]290 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]294}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]341}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]536}
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]537
538
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]651 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]736<div id="header">
737<h1>
738git-status(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-status -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]743 Show the working tree status
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]750<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]751<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]752<pre class="content"><em>git status</em> [&lt;options&gt;&#8230;] [--] [&lt;pathspec&gt;&#8230;]</pre>
753<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]754</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]755</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]756</div>
757<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]758<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]759<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]760<div class="paragraph"><p>Displays paths that have differences between the index file and the
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]761current HEAD commit, paths that have differences between the working
762tree and the index file, and paths in the working tree that are not
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]763tracked by Git (and are not ignored by <a href="gitignore.html">gitignore(5)</a>). The first
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]764are what you <em>would</em> commit by running <code>git commit</code>; the second and
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]765third are what you <em>could</em> commit by running <em>git add</em> before running
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]766<code>git commit</code>.</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]767</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]768</div>
769<div class="sect1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]770<h2 id="_options">OPTIONS</h2>
771<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]772<div class="dlist"><dl>
773<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]774-s
775</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]776<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]777--short
778</dt>
779<dd>
780<p>
781 Give the output in the short-format.
782</p>
783</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]784<dt class="hdlist1">
Junio C Hamanof5de4cf2010-06-19 00:33:17[diff] [blame]785-b
786</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]787<dt class="hdlist1">
Junio C Hamanof5de4cf2010-06-19 00:33:17[diff] [blame]788--branch
789</dt>
790<dd>
791<p>
792 Show the branch and tracking info even in short-format.
793</p>
794</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]795<dt class="hdlist1">
Junio C Hamano967cda72017-06-30 21:49:53[diff] [blame]796--show-stash
797</dt>
798<dd>
799<p>
800 Show the number of entries currently stashed away.
801</p>
802</dd>
803<dt class="hdlist1">
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]804--porcelain[=&lt;version&gt;]
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]805</dt>
806<dd>
807<p>
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]808 Give the output in an easy-to-parse format for scripts.
809 This is similar to the short output, but will remain stable
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]810 across Git versions and regardless of user configuration. See
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]811 below for details.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]812</p>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]813<div class="paragraph"><p>The version parameter is used to specify the format version.
814This is optional and defaults to the original version <em>v1</em> format.</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]815</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]816<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]817--long
818</dt>
819<dd>
820<p>
821 Give the output in the long-format. This is the default.
822</p>
823</dd>
824<dt class="hdlist1">
Junio C Hamano8152abf2015-04-28 22:48:02[diff] [blame]825-v
826</dt>
827<dt class="hdlist1">
828--verbose
829</dt>
830<dd>
831<p>
832 In addition to the names of files that have been changed, also
833 show the textual changes that are staged to be committed
834 (i.e., like the output of <code>git diff --cached</code>). If <code>-v</code> is specified
835 twice, then also show the changes in the working tree that
836 have not yet been staged (i.e., like the output of <code>git diff</code>).
837</p>
838</dd>
839<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]840-u[&lt;mode&gt;]
841</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]842<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]843--untracked-files[=&lt;mode&gt;]
844</dt>
845<dd>
846<p>
Junio C Hamano36a4dbc2011-02-22 07:51:32[diff] [blame]847 Show untracked files.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]848</p>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]849<div class="openblock">
850<div class="content">
Junio C Hamano1eb56092015-10-05 20:39:53[diff] [blame]851<div class="paragraph"><p>The mode parameter is used to specify the handling of untracked files.
852It is optional: it defaults to <em>all</em>, and if specified, it must be
853stuck to the option (e.g. <code>-uno</code>, but not <code>-u no</code>).</p></div>
Junio C Hamano36a4dbc2011-02-22 07:51:32[diff] [blame]854<div class="paragraph"><p>The possible options are:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]855<div class="ulist"><ul>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]856<li>
857<p>
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]858<em>no</em> - Show no untracked files.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]859</p>
860</li>
861<li>
862<p>
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]863<em>normal</em> - Shows untracked files and directories.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]864</p>
865</li>
866<li>
867<p>
868<em>all</em> - Also shows individual files in untracked directories.
869</p>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]870</li>
871</ul></div>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]872<div class="paragraph"><p>When <code>-u</code> option is not used, untracked files and directories are
873shown (i.e. the same as specifying <code>normal</code>), to help you avoid
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]874forgetting to add newly created files. Because it takes extra work
875to find untracked files in the filesystem, this mode may take some
Junio C Hamanoc4e2a202015-05-26 21:38:47[diff] [blame]876time in a large working tree.
877Consider enabling untracked cache and split index if supported (see
878<code>git update-index --untracked-cache</code> and <code>git update-index
879--split-index</code>), Otherwise you can use <code>no</code> to have <code>git status</code>
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]880return more quickly without showing untracked files.</p></div>
Junio C Hamano36a4dbc2011-02-22 07:51:32[diff] [blame]881<div class="paragraph"><p>The default can be changed using the status.showUntrackedFiles
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]882configuration variable documented in <a href="git-config.html">git-config(1)</a>.</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]883</div></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]884</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]885<dt class="hdlist1">
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]886--ignore-submodules[=&lt;when&gt;]
887</dt>
888<dd>
889<p>
890 Ignore changes to submodules when looking for changes. &lt;when&gt; can be
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]891 either "none", "untracked", "dirty" or "all", which is the default.
892 Using "none" will consider the submodule modified when it either contains
893 untracked or modified files or its HEAD differs from the commit recorded
894 in the superproject and can be used to override any settings of the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]895 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]896 "untracked" is used submodules are not considered dirty when they only
897 contain untracked content (but they are still scanned for modified
898 content). Using "dirty" ignores all changes to the work tree of submodules,
899 only changes to the commits stored in the superproject are shown (this was
900 the behavior before 1.7.0). Using "all" hides all changes to submodules
901 (and suppresses the output of submodule summaries when the config option
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]902 <code>status.submoduleSummary</code> is set).
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]903</p>
904</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]905<dt class="hdlist1">
Junio C Hamanob72f6032017-11-15 05:57:08[diff] [blame]906--ignored[=&lt;mode&gt;]
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]907</dt>
908<dd>
909<p>
910 Show ignored files as well.
911</p>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]912<div class="openblock">
913<div class="content">
Junio C Hamanob72f6032017-11-15 05:57:08[diff] [blame]914<div class="paragraph"><p>The mode parameter is used to specify the handling of ignored files.
915It is optional: it defaults to <em>traditional</em>.</p></div>
916<div class="paragraph"><p>The possible options are:</p></div>
917<div class="ulist"><ul>
918<li>
919<p>
920<em>traditional</em> - Shows ignored files and directories, unless
Junio C Hamanoea1ac8d2018-07-18 20:16:48[diff] [blame]921 --untracked-files=all is specified, in which case
Junio C Hamanob72f6032017-11-15 05:57:08[diff] [blame]922 individual files in ignored directories are
923 displayed.
924</p>
925</li>
926<li>
927<p>
928<em>no</em> - Show no ignored files.
929</p>
930</li>
931<li>
932<p>
933<em>matching</em> - Shows ignored files and directories matching an
934 ignore pattern.
935</p>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]936</li>
937</ul></div>
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]938<div class="paragraph"><p>When <em>matching</em> mode is specified, paths that explicitly match an
Junio C Hamanob72f6032017-11-15 05:57:08[diff] [blame]939ignored pattern are shown. If a directory matches an ignore pattern,
940then it is shown, but not paths contained in the ignored directory. If
941a directory does not match an ignore pattern, but all contents are
942ignored, then the directory is not shown, but all contents are shown.</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]943</div></div>
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]944</dd>
945<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]946-z
947</dt>
948<dd>
949<p>
950 Terminate entries with NUL, instead of LF. This implies
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]951 the <code>--porcelain=v1</code> output format if no other format is given.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]952</p>
953</dd>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]954<dt class="hdlist1">
955--column[=&lt;options&gt;]
956</dt>
957<dt class="hdlist1">
958--no-column
959</dt>
960<dd>
961<p>
962 Display untracked files in columns. See configuration variable
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]963 column.status for option syntax.<code>--column</code> and <code>--no-column</code>
Junio C Hamano22700fb2012-05-03 23:07:25[diff] [blame]964 without options are equivalent to <em>always</em> and <em>never</em>
965 respectively.
966</p>
967</dd>
Junio C Hamano139b7d12017-10-03 07:10:59[diff] [blame]968<dt class="hdlist1">
Junio C Hamanoa25ccc42018-03-08 21:36:14[diff] [blame]969--ahead-behind
970</dt>
971<dt class="hdlist1">
972--no-ahead-behind
973</dt>
974<dd>
975<p>
976 Display or do not display detailed ahead/behind counts for the
977 branch relative to its upstream branch. Defaults to true.
978</p>
979</dd>
980<dt class="hdlist1">
Junio C Hamano309465b2018-05-30 06:32:59[diff] [blame]981--renames
982</dt>
983<dt class="hdlist1">
984--no-renames
985</dt>
986<dd>
987<p>
988 Turn on/off rename detection regardless of user configuration.
989 See also <a href="git-diff.html">git-diff(1)</a> <code>--no-renames</code>.
990</p>
991</dd>
992<dt class="hdlist1">
993--find-renames[=&lt;n&gt;]
994</dt>
995<dd>
996<p>
997 Turn on rename detection, optionally setting the similarity
998 threshold.
999 See also <a href="git-diff.html">git-diff(1)</a> <code>--find-renames</code>.
1000</p>
1001</dd>
1002<dt class="hdlist1">
Junio C Hamano139b7d12017-10-03 07:10:59[diff] [blame]1003&lt;pathspec&gt;&#8230;
1004</dt>
1005<dd>
1006<p>
1007 See the <em>pathspec</em> entry in <a href="gitglossary.html">gitglossary(7)</a>.
1008</p>
1009</dd>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1010</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1011</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1012</div>
1013<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1014<h2 id="_output">OUTPUT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1015<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]1016<div class="paragraph"><p>The output from this command is designed to be used as a commit
Junio C Hamano52b6ba32014-04-01 00:26:48[diff] [blame]1017template comment.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1018The default, long format, is designed to be human readable,
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]1019verbose and descriptive. Its contents and format are subject to change
1020at any time.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1021<div class="paragraph"><p>The paths mentioned in the output, unlike many other Git commands, are
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1022made relative to the current directory if you are working in a
1023subdirectory (this is on purpose, to help cutting and pasting). See
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1024the status.relativePaths config option below.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1025<div class="sect2">
1026<h3 id="_short_format">Short Format</h3>
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1027<div class="paragraph"><p>In the short-format, the status of each path is shown as one of these
1028forms</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1029<div class="literalblock">
1030<div class="content">
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1031<pre><code>XY PATH
1032XY ORIG_PATH -&gt; PATH</code></pre>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1033</div></div>
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1034<div class="paragraph"><p>where <code>ORIG_PATH</code> is where the renamed/copied contents came
1035from. <code>ORIG_PATH</code> is only shown when the entry is renamed or
1036copied. The <code>XY</code> is a two-letter status code.</p></div>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1037<div class="paragraph"><p>The fields (including the <code>-&gt;</code>) are separated from each other by a
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1038single space. If a filename contains whitespace or other nonprintable
1039characters, that field will be quoted in the manner of a C string
1040literal: surrounded by ASCII double quote (34) characters, and with
1041interior special characters backslash-escaped.</p></div>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1042<div class="paragraph"><p>For paths with merge conflicts, <code>X</code> and <code>Y</code> show the modification
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1043states of each side of the merge. For paths that do not have merge
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1044conflicts, <code>X</code> shows the status of the index, and <code>Y</code> shows the status
1045of the work tree. For untracked paths, <code>XY</code> are <code>??</code>. Other status
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1046codes can be interpreted as follows:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]1047<div class="ulist"><ul>
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1048<li>
1049<p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]1050' ' = unmodified
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1051</p>
1052</li>
1053<li>
1054<p>
1055<em>M</em> = modified
1056</p>
1057</li>
1058<li>
1059<p>
1060<em>A</em> = added
1061</p>
1062</li>
1063<li>
1064<p>
1065<em>D</em> = deleted
1066</p>
1067</li>
1068<li>
1069<p>
1070<em>R</em> = renamed
1071</p>
1072</li>
1073<li>
1074<p>
1075<em>C</em> = copied
1076</p>
1077</li>
1078<li>
1079<p>
1080<em>U</em> = updated but unmerged
1081</p>
1082</li>
1083</ul></div>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1084<div class="paragraph"><p>Ignored files are not listed, unless <code>--ignored</code> option is in effect,
1085in which case <code>XY</code> are <code>!!</code>.</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1086<div class="literalblock">
1087<div class="content">
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1088<pre><code>X Y Meaning
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1089-------------------------------------------------
Junio C Hamano615c3b32018-02-28 23:40:27[diff] [blame]1090 [AMD] not updated
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1091M [ MD] updated in index
1092A [ MD] added to index
Junio C Hamano615c3b32018-02-28 23:40:27[diff] [blame]1093D deleted from index
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1094R [ MD] renamed in index
1095C [ MD] copied in index
1096[MARC] index and work tree matches
1097[ MARC] M work tree changed since index
1098[ MARC] D deleted in work tree
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1099[ D] R renamed in work tree
1100[ D] C copied in work tree
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1101-------------------------------------------------
1102D D unmerged, both deleted
1103A U unmerged, added by us
1104U D unmerged, deleted by them
1105U A unmerged, added by them
1106D U unmerged, deleted by us
1107A A unmerged, both added
1108U U unmerged, both modified
1109-------------------------------------------------
1110? ? untracked
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]1111! ! ignored
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1112-------------------------------------------------</code></pre>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1113</div></div>
Junio C Hamano52a094d2017-04-20 05:35:10[diff] [blame]1114<div class="paragraph"><p>Submodules have more state and instead report
1115 M the submodule has a different HEAD than
1116 recorded in the index
1117 m the submodule has modified content
1118 ? the submodule has untracked files
1119since modified content or untracked files in a submodule cannot be added
1120via <code>git add</code> in the superproject to prepare a commit.</p></div>
1121<div class="paragraph"><p><em>m</em> and <em>?</em> are applied recursively. For example if a nested submodule
1122in a submodule contains an untracked file, this is reported as <em>?</em> as well.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]1123<div class="paragraph"><p>If -b is used the short-format status is preceded by a line</p></div>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1124<div class="literalblock">
1125<div class="content">
1126<pre><code>## branchname tracking info</code></pre>
1127</div></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1128</div>
1129<div class="sect2">
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1130<h3 id="_porcelain_format_version_1">Porcelain Format Version 1</h3>
1131<div class="paragraph"><p>Version 1 porcelain format is similar to the short format, but is guaranteed
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1132not to change in a backwards-incompatible way between Git versions or
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]1133based on user configuration. This makes it ideal for parsing by scripts.
1134The description of the short format above also describes the porcelain
1135format, with a few exceptions:</p></div>
1136<div class="olist arabic"><ol class="arabic">
1137<li>
1138<p>
1139The user&#8217;s color.status configuration is not respected; color will
1140 always be off.
1141</p>
1142</li>
1143<li>
1144<p>
1145The user&#8217;s status.relativePaths configuration is not respected; paths
1146 shown will always be relative to the repository root.
1147</p>
1148</li>
1149</ol></div>
1150<div class="paragraph"><p>There is also an alternate -z format recommended for machine parsing. In
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1151that format, the status field is the same, but some other things
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]1152change. First, the <em>-&gt;</em> is omitted from rename entries and the field
1153order is reversed (e.g <em>from -&gt; to</em> becomes <em>to from</em>). Second, a NUL
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]1154(ASCII 0) follows each filename, replacing space as a field separator
1155and the terminating newline (but a space still separates the status
1156field from the first filename). Third, filenames containing special
1157characters are not specially formatted; no quoting or
Junio C Hamanobcdb12e2012-05-10 18:45:15[diff] [blame]1158backslash-escaping is performed.</p></div>
Junio C Hamano52a094d2017-04-20 05:35:10[diff] [blame]1159<div class="paragraph"><p>Any submodule changes are reported as modified <code>M</code> instead of <code>m</code> or single <code>?</code>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1160</div>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1161<div class="sect2">
1162<h3 id="_porcelain_format_version_2">Porcelain Format Version 2</h3>
1163<div class="paragraph"><p>Version 2 format adds more detailed information about the state of
1164the worktree and changed items. Version 2 also defines an extensible
1165set of easy to parse optional headers.</p></div>
1166<div class="paragraph"><p>Header lines start with "#" and are added in response to specific
1167command line arguments. Parsers should ignore headers they
1168don&#8217;t recognize.</p></div>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]1169<div class="sect3">
1170<h4 id="_branch_headers">Branch Headers</h4>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1171<div class="paragraph"><p>If <code>--branch</code> is given, a series of header lines are printed with
1172information about the current branch.</p></div>
1173<div class="literalblock">
1174<div class="content">
1175<pre><code>Line Notes
1176------------------------------------------------------------
1177# branch.oid &lt;commit&gt; | (initial) Current commit.
1178# branch.head &lt;branch&gt; | (detached) Current branch.
1179# branch.upstream &lt;upstream_branch&gt; If upstream is set.
1180# branch.ab +&lt;ahead&gt; -&lt;behind&gt; If upstream is set and
1181 the commit is present.
1182------------------------------------------------------------</code></pre>
1183</div></div>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]1184</div>
1185<div class="sect3">
1186<h4 id="_changed_tracked_entries">Changed Tracked Entries</h4>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1187<div class="paragraph"><p>Following the headers, a series of lines are printed for tracked
1188entries. One of three different line formats may be used to describe
1189an entry depending on the type of change. Tracked entries are printed
1190in an undefined order; parsers should allow for a mixture of the 3
1191line types in any order.</p></div>
1192<div class="paragraph"><p>Ordinary changed entries have the following format:</p></div>
1193<div class="literalblock">
1194<div class="content">
1195<pre><code>1 &lt;XY&gt; &lt;sub&gt; &lt;mH&gt; &lt;mI&gt; &lt;mW&gt; &lt;hH&gt; &lt;hI&gt; &lt;path&gt;</code></pre>
1196</div></div>
1197<div class="paragraph"><p>Renamed or copied entries have the following format:</p></div>
1198<div class="literalblock">
1199<div class="content">
1200<pre><code>2 &lt;XY&gt; &lt;sub&gt; &lt;mH&gt; &lt;mI&gt; &lt;mW&gt; &lt;hH&gt; &lt;hI&gt; &lt;X&gt;&lt;score&gt; &lt;path&gt;&lt;sep&gt;&lt;origPath&gt;</code></pre>
1201</div></div>
1202<div class="literalblock">
1203<div class="content">
1204<pre><code>Field Meaning
1205--------------------------------------------------------
1206&lt;XY&gt; A 2 character field containing the staged and
1207 unstaged XY values described in the short format,
1208 with unchanged indicated by a "." rather than
1209 a space.
1210&lt;sub&gt; A 4 character field describing the submodule state.
1211 "N..." when the entry is not a submodule.
1212 "S&lt;c&gt;&lt;m&gt;&lt;u&gt;" when the entry is a submodule.
1213 &lt;c&gt; is "C" if the commit changed; otherwise ".".
1214 &lt;m&gt; is "M" if it has tracked changes; otherwise ".".
1215 &lt;u&gt; is "U" if there are untracked changes; otherwise ".".
1216&lt;mH&gt; The octal file mode in HEAD.
1217&lt;mI&gt; The octal file mode in the index.
1218&lt;mW&gt; The octal file mode in the worktree.
1219&lt;hH&gt; The object name in HEAD.
1220&lt;hI&gt; The object name in the index.
1221&lt;X&gt;&lt;score&gt; The rename or copy score (denoting the percentage
1222 of similarity between the source and target of the
1223 move or copy). For example "R100" or "C75".
1224&lt;path&gt; The pathname. In a renamed/copied entry, this
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1225 is the target path.
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1226&lt;sep&gt; When the `-z` option is used, the 2 pathnames are separated
1227 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
1228 byte separates them.
Junio C Hamano7b9cce92018-01-23 22:34:27[diff] [blame]1229&lt;origPath&gt; The pathname in the commit at HEAD or in the index.
1230 This is only present in a renamed/copied entry, and
1231 tells where the renamed/copied contents came from.
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1232--------------------------------------------------------</code></pre>
1233</div></div>
1234<div class="paragraph"><p>Unmerged entries have the following format; the first character is
1235a "u" to distinguish from ordinary changed entries.</p></div>
1236<div class="literalblock">
1237<div class="content">
1238<pre><code>u &lt;xy&gt; &lt;sub&gt; &lt;m1&gt; &lt;m2&gt; &lt;m3&gt; &lt;mW&gt; &lt;h1&gt; &lt;h2&gt; &lt;h3&gt; &lt;path&gt;</code></pre>
1239</div></div>
1240<div class="literalblock">
1241<div class="content">
1242<pre><code>Field Meaning
1243--------------------------------------------------------
1244&lt;XY&gt; A 2 character field describing the conflict type
1245 as described in the short format.
1246&lt;sub&gt; A 4 character field describing the submodule state
1247 as described above.
1248&lt;m1&gt; The octal file mode in stage 1.
1249&lt;m2&gt; The octal file mode in stage 2.
1250&lt;m3&gt; The octal file mode in stage 3.
1251&lt;mW&gt; The octal file mode in the worktree.
1252&lt;h1&gt; The object name in stage 1.
1253&lt;h2&gt; The object name in stage 2.
1254&lt;h3&gt; The object name in stage 3.
1255&lt;path&gt; The pathname.
1256--------------------------------------------------------</code></pre>
1257</div></div>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]1258</div>
1259<div class="sect3">
1260<h4 id="_other_items">Other Items</h4>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1261<div class="paragraph"><p>Following the tracked entries (and if requested), a series of
1262lines will be printed for untracked and then ignored items
1263found in the worktree.</p></div>
1264<div class="paragraph"><p>Untracked items have the following format:</p></div>
1265<div class="literalblock">
1266<div class="content">
1267<pre><code>? &lt;path&gt;</code></pre>
1268</div></div>
1269<div class="paragraph"><p>Ignored items have the following format:</p></div>
1270<div class="literalblock">
1271<div class="content">
1272<pre><code>! &lt;path&gt;</code></pre>
1273</div></div>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]1274</div>
1275<div class="sect3">
1276<h4 id="_pathname_format_notes_and_z">Pathname Format Notes and -z</h4>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1277<div class="paragraph"><p>When the <code>-z</code> option is given, pathnames are printed as is and
1278without any quoting and lines are terminated with a NUL (ASCII 0x00)
1279byte.</p></div>
Junio C Hamano0f6f3bf2017-03-13 07:01:53[diff] [blame]1280<div class="paragraph"><p>Without the <code>-z</code> option, pathnames with "unusual" characters are
1281quoted as explained for the configuration variable <code>core.quotePath</code>
1282(see <a href="git-config.html">git-config(1)</a>).</p></div>
Junio C Hamanocd451662016-09-13 00:54:09[diff] [blame]1283</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1284</div>
1285</div>
Junio C Hamanob5513772019-04-22 03:38:39[diff] [blame]1286</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1287<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1288<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]1289<div class="sectionbody">
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1290<div class="paragraph"><p>The command honors <code>color.status</code> (or <code>status.color</code>&#8201;&#8212;&#8201;they
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]1291mean the same thing and the latter is kept for backward
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1292compatibility) and <code>color.status.&lt;slot&gt;</code> configuration variables
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1293to colorize its output.</p></div>
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1294<div class="paragraph"><p>If the config variable <code>status.relativePaths</code> is set to false, then all
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]1295paths shown are relative to the repository root, not to the current
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1296directory.</p></div>
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1297<div class="paragraph"><p>If <code>status.submoduleSummary</code> is set to a non zero number or true (identical
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]1298to -1 or an unlimited number), the submodule summary will be enabled for
1299the long format and a summary of commits for modified submodules will be
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]1300shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>). Please note
1301that the summary output from the status command will be suppressed for all
Junio C Hamanod2c28482014-10-24 22:28:25[diff] [blame]1302submodules when <code>diff.ignoreSubmodules</code> is set to <em>all</em> or only for those
1303submodules where <code>submodule.&lt;name&gt;.ignore=all</code>. To also view the summary for
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]1304ignored submodules you can either use the --ignore-submodules=dirty command
1305line option or the <em>git submodule summary</em> command, which shows a similar
1306output but does not honor these settings.</p></div>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]1307</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1308</div>
1309<div class="sect1">
Junio C Hamano371470a2017-12-13 22:26:40[diff] [blame]1310<h2 id="_background_refresh">BACKGROUND REFRESH</h2>
1311<div class="sectionbody">
1312<div class="paragraph"><p>By default, <code>git status</code> will automatically refresh the index, updating
1313the cached stat information from the working tree and writing out the
1314result. Writing out the updated index is an optimization that isn&#8217;t
1315strictly necessary (<code>status</code> computes the values for itself, but writing
1316them out is just to save subsequent programs from repeating our
1317computation). When <code>status</code> is run in the background, the lock held
1318during the write may conflict with other simultaneous processes, causing
1319them to fail. Scripts running <code>status</code> in the background should consider
1320using <code>git --no-optional-locks status</code> (see <a href="git.html">git(1)</a> for details).</p></div>
1321</div>
1322</div>
1323<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1324<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]1325<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1326<div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a></p></div>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]1327</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1328</div>
1329<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1330<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1331<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1332<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]1333</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1334</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1335</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1336<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1337<div id="footer">
1338<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1339Last updated
Junio C Hamano7a46cd62020-03-15 21:57:10[diff] [blame]1340 2020-03-10 08:03:13 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1341</div>
1342</div>
1343</body>
1344</html>