v2.5.5 release
[git-osx-installer.git] / src / git-checkpoint.html
blob79356570fd632e8001b2cd35403eb026b43c76c1
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="application/xhtml+xml; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.6.6" />
7 <title>git-checkpoint(1)</title>
8 <style type="text/css">
9 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11 /* Default font. */
12 body {
13 font-family: Georgia,serif;
16 /* Title font. */
17 h1, h2, h3, h4, h5, h6,
18 div.title, caption.title,
19 thead, p.table.header,
20 #toctitle,
21 #author, #revnumber, #revdate, #revremark,
22 #footer {
23 font-family: Arial,Helvetica,sans-serif;
26 body {
27 margin: 1em 5% 1em 5%;
30 a {
31 color: blue;
32 text-decoration: underline;
34 a:visited {
35 color: fuchsia;
38 em {
39 font-style: italic;
40 color: navy;
43 strong {
44 font-weight: bold;
45 color: #083194;
48 h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
55 h1, h2, h3 {
56 border-bottom: 2px solid silver;
58 h2 {
59 padding-top: 0.5em;
61 h3 {
62 float: left;
64 h3 + * {
65 clear: left;
67 h5 {
68 font-size: 1.0em;
71 div.sectionbody {
72 margin-left: 0;
75 hr {
76 border: 1px solid silver;
79 p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
84 ul, ol, li > p {
85 margin-top: 0;
87 ul > li { color: #aaa; }
88 ul > li > * { color: black; }
90 pre {
91 padding: 0;
92 margin: 0;
95 #author {
96 color: #527bbd;
97 font-weight: bold;
98 font-size: 1.1em;
100 #email {
102 #revnumber, #revdate, #revremark {
105 #footer {
106 font-size: small;
107 border-top: 2px solid silver;
108 padding-top: 0.5em;
109 margin-top: 4.0em;
111 #footer-text {
112 float: left;
113 padding-bottom: 0.5em;
115 #footer-badges {
116 float: right;
117 padding-bottom: 0.5em;
120 #preamble {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.imageblock, div.exampleblock, div.verseblock,
125 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
126 div.admonitionblock {
127 margin-top: 1.0em;
128 margin-bottom: 1.5em;
130 div.admonitionblock {
131 margin-top: 2.0em;
132 margin-bottom: 2.0em;
133 margin-right: 10%;
134 color: #606060;
137 div.content { /* Block element content. */
138 padding: 0;
141 /* Block element titles. */
142 div.title, caption.title {
143 color: #527bbd;
144 font-weight: bold;
145 text-align: left;
146 margin-top: 1.0em;
147 margin-bottom: 0.5em;
149 div.title + * {
150 margin-top: 0;
153 td div.title:first-child {
154 margin-top: 0.0em;
156 div.content div.title:first-child {
157 margin-top: 0.0em;
159 div.content + div.title {
160 margin-top: 0.0em;
163 div.sidebarblock > div.content {
164 background: #ffffee;
165 border: 1px solid #dddddd;
166 border-left: 4px solid #f0f0f0;
167 padding: 0.5em;
170 div.listingblock > div.content {
171 border: 1px solid #dddddd;
172 border-left: 5px solid #f0f0f0;
173 background: #f8f8f8;
174 padding: 0.5em;
177 div.quoteblock, div.verseblock {
178 padding-left: 1.0em;
179 margin-left: 1.0em;
180 margin-right: 10%;
181 border-left: 5px solid #f0f0f0;
182 color: #888;
185 div.quoteblock > div.attribution {
186 padding-top: 0.5em;
187 text-align: right;
190 div.verseblock > pre.content {
191 font-family: inherit;
192 font-size: inherit;
194 div.verseblock > div.attribution {
195 padding-top: 0.75em;
196 text-align: left;
198 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
199 div.verseblock + div.attribution {
200 text-align: left;
203 div.admonitionblock .icon {
204 vertical-align: top;
205 font-size: 1.1em;
206 font-weight: bold;
207 text-decoration: underline;
208 color: #527bbd;
209 padding-right: 0.5em;
211 div.admonitionblock td.content {
212 padding-left: 0.5em;
213 border-left: 3px solid #dddddd;
216 div.exampleblock > div.content {
217 border-left: 3px solid #dddddd;
218 padding-left: 0.5em;
221 div.imageblock div.content { padding-left: 0; }
222 span.image img { border-style: none; }
223 a.image:visited { color: white; }
225 dl {
226 margin-top: 0.8em;
227 margin-bottom: 0.8em;
229 dt {
230 margin-top: 0.5em;
231 margin-bottom: 0;
232 font-style: normal;
233 color: navy;
235 dd > *:first-child {
236 margin-top: 0.1em;
239 ul, ol {
240 list-style-position: outside;
242 ol.arabic {
243 list-style-type: decimal;
245 ol.loweralpha {
246 list-style-type: lower-alpha;
248 ol.upperalpha {
249 list-style-type: upper-alpha;
251 ol.lowerroman {
252 list-style-type: lower-roman;
254 ol.upperroman {
255 list-style-type: upper-roman;
258 div.compact ul, div.compact ol,
259 div.compact p, div.compact p,
260 div.compact div, div.compact div {
261 margin-top: 0.1em;
262 margin-bottom: 0.1em;
265 tfoot {
266 font-weight: bold;
268 td > div.verse {
269 white-space: pre;
272 div.hdlist {
273 margin-top: 0.8em;
274 margin-bottom: 0.8em;
276 div.hdlist tr {
277 padding-bottom: 15px;
279 dt.hdlist1.strong, td.hdlist1.strong {
280 font-weight: bold;
282 td.hdlist1 {
283 vertical-align: top;
284 font-style: normal;
285 padding-right: 0.8em;
286 color: navy;
288 td.hdlist2 {
289 vertical-align: top;
291 div.hdlist.compact tr {
292 margin: 0;
293 padding-bottom: 0;
296 .comment {
297 background: yellow;
300 .footnote, .footnoteref {
301 font-size: 0.8em;
304 span.footnote, span.footnoteref {
305 vertical-align: super;
308 #footnotes {
309 margin: 20px 0 20px 0;
310 padding: 7px 0 0 0;
313 #footnotes div.footnote {
314 margin: 0 0 5px 0;
317 #footnotes hr {
318 border: none;
319 border-top: 1px solid silver;
320 height: 1px;
321 text-align: left;
322 margin-left: 0;
323 width: 20%;
324 min-width: 100px;
327 div.colist td {
328 padding-right: 0.5em;
329 padding-bottom: 0.3em;
330 vertical-align: top;
332 div.colist td img {
333 margin-top: 0.3em;
336 @media print {
337 #footer-badges { display: none; }
340 #toc {
341 margin-bottom: 2.5em;
344 #toctitle {
345 color: #527bbd;
346 font-size: 1.1em;
347 font-weight: bold;
348 margin-top: 1.0em;
349 margin-bottom: 0.1em;
352 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
353 margin-top: 0;
354 margin-bottom: 0;
356 div.toclevel2 {
357 margin-left: 2em;
358 font-size: 0.9em;
360 div.toclevel3 {
361 margin-left: 4em;
362 font-size: 0.9em;
364 div.toclevel4 {
365 margin-left: 6em;
366 font-size: 0.9em;
369 span.aqua { color: aqua; }
370 span.black { color: black; }
371 span.blue { color: blue; }
372 span.fuchsia { color: fuchsia; }
373 span.gray { color: gray; }
374 span.green { color: green; }
375 span.lime { color: lime; }
376 span.maroon { color: maroon; }
377 span.navy { color: navy; }
378 span.olive { color: olive; }
379 span.purple { color: purple; }
380 span.red { color: red; }
381 span.silver { color: silver; }
382 span.teal { color: teal; }
383 span.white { color: white; }
384 span.yellow { color: yellow; }
386 span.aqua-background { background: aqua; }
387 span.black-background { background: black; }
388 span.blue-background { background: blue; }
389 span.fuchsia-background { background: fuchsia; }
390 span.gray-background { background: gray; }
391 span.green-background { background: green; }
392 span.lime-background { background: lime; }
393 span.maroon-background { background: maroon; }
394 span.navy-background { background: navy; }
395 span.olive-background { background: olive; }
396 span.purple-background { background: purple; }
397 span.red-background { background: red; }
398 span.silver-background { background: silver; }
399 span.teal-background { background: teal; }
400 span.white-background { background: white; }
401 span.yellow-background { background: yellow; }
403 span.big { font-size: 2em; }
404 span.small { font-size: 0.6em; }
406 span.underline { text-decoration: underline; }
407 span.overline { text-decoration: overline; }
408 span.line-through { text-decoration: line-through; }
412 * xhtml11 specific
414 * */
416 tt {
417 font-family: monospace;
418 font-size: inherit;
419 color: navy;
422 div.tableblock {
423 margin-top: 1.0em;
424 margin-bottom: 1.5em;
426 div.tableblock > table {
427 border: 3px solid #527bbd;
429 thead, p.table.header {
430 font-weight: bold;
431 color: #527bbd;
433 p.table {
434 margin-top: 0;
436 /* Because the table frame attribute is overriden by CSS in most browsers. */
437 div.tableblock > table[frame="void"] {
438 border-style: none;
440 div.tableblock > table[frame="hsides"] {
441 border-left-style: none;
442 border-right-style: none;
444 div.tableblock > table[frame="vsides"] {
445 border-top-style: none;
446 border-bottom-style: none;
451 * html5 specific
453 * */
455 .monospaced {
456 font-family: monospace;
457 font-size: inherit;
458 color: navy;
461 table.tableblock {
462 margin-top: 1.0em;
463 margin-bottom: 1.5em;
465 thead, p.tableblock.header {
466 font-weight: bold;
467 color: #527bbd;
469 p.tableblock {
470 margin-top: 0;
472 table.tableblock {
473 border-width: 3px;
474 border-spacing: 0px;
475 border-style: solid;
476 border-color: #527bbd;
477 border-collapse: collapse;
479 th.tableblock, td.tableblock {
480 border-width: 1px;
481 padding: 4px;
482 border-style: solid;
483 border-color: #527bbd;
486 table.tableblock.frame-topbot {
487 border-left-style: hidden;
488 border-right-style: hidden;
490 table.tableblock.frame-sides {
491 border-top-style: hidden;
492 border-bottom-style: hidden;
494 table.tableblock.frame-none {
495 border-style: hidden;
498 th.tableblock.halign-left, td.tableblock.halign-left {
499 text-align: left;
501 th.tableblock.halign-center, td.tableblock.halign-center {
502 text-align: center;
504 th.tableblock.halign-right, td.tableblock.halign-right {
505 text-align: right;
508 th.tableblock.valign-top, td.tableblock.valign-top {
509 vertical-align: top;
511 th.tableblock.valign-middle, td.tableblock.valign-middle {
512 vertical-align: middle;
514 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
515 vertical-align: bottom;
520 * manpage specific
522 * */
524 body.manpage h1 {
525 padding-top: 0.5em;
526 padding-bottom: 0.5em;
527 border-top: 2px solid silver;
528 border-bottom: 2px solid silver;
530 body.manpage h2 {
531 border-style: none;
533 body.manpage div.sectionbody {
534 margin-left: 3em;
537 @media print {
538 body.manpage div#toc { display: none; }
540 </style>
541 <script type="text/javascript">
542 /*<![CDATA[*/
543 var asciidoc = { // Namespace.
545 /////////////////////////////////////////////////////////////////////
546 // Table Of Contents generator
547 /////////////////////////////////////////////////////////////////////
549 /* Author: Mihai Bazon, September 2002
550 * http://students.infoiasi.ro/~mishoo
552 * Table Of Content generator
553 * Version: 0.4
555 * Feel free to use this script under the terms of the GNU General Public
556 * License, as long as you do not remove or alter this notice.
559 /* modified by Troy D. Hanson, September 2006. License: GPL */
560 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
562 // toclevels = 1..4.
563 toc: function (toclevels) {
565 function getText(el) {
566 var text = "";
567 for (var i = el.firstChild; i != null; i = i.nextSibling) {
568 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
569 text += i.data;
570 else if (i.firstChild != null)
571 text += getText(i);
573 return text;
576 function TocEntry(el, text, toclevel) {
577 this.element = el;
578 this.text = text;
579 this.toclevel = toclevel;
582 function tocEntries(el, toclevels) {
583 var result = new Array;
584 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
585 // Function that scans the DOM tree for header elements (the DOM2
586 // nodeIterator API would be a better technique but not supported by all
587 // browsers).
588 var iterate = function (el) {
589 for (var i = el.firstChild; i != null; i = i.nextSibling) {
590 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
591 var mo = re.exec(i.tagName);
592 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
593 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
595 iterate(i);
599 iterate(el);
600 return result;
603 var toc = document.getElementById("toc");
604 if (!toc) {
605 return;
608 // Delete existing TOC entries in case we're reloading the TOC.
609 var tocEntriesToRemove = [];
610 var i;
611 for (i = 0; i < toc.childNodes.length; i++) {
612 var entry = toc.childNodes[i];
613 if (entry.nodeName == 'div'
614 && entry.getAttribute("class")
615 && entry.getAttribute("class").match(/^toclevel/))
616 tocEntriesToRemove.push(entry);
618 for (i = 0; i < tocEntriesToRemove.length; i++) {
619 toc.removeChild(tocEntriesToRemove[i]);
622 // Rebuild TOC entries.
623 var entries = tocEntries(document.getElementById("content"), toclevels);
624 for (var i = 0; i < entries.length; ++i) {
625 var entry = entries[i];
626 if (entry.element.id == "")
627 entry.element.id = "_toc_" + i;
628 var a = document.createElement("a");
629 a.href = "#" + entry.element.id;
630 a.appendChild(document.createTextNode(entry.text));
631 var div = document.createElement("div");
632 div.appendChild(a);
633 div.className = "toclevel" + entry.toclevel;
634 toc.appendChild(div);
636 if (entries.length == 0)
637 toc.parentNode.removeChild(toc);
641 /////////////////////////////////////////////////////////////////////
642 // Footnotes generator
643 /////////////////////////////////////////////////////////////////////
645 /* Based on footnote generation code from:
646 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
649 footnotes: function () {
650 // Delete existing footnote entries in case we're reloading the footnodes.
651 var i;
652 var noteholder = document.getElementById("footnotes");
653 if (!noteholder) {
654 return;
656 var entriesToRemove = [];
657 for (i = 0; i < noteholder.childNodes.length; i++) {
658 var entry = noteholder.childNodes[i];
659 if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
660 entriesToRemove.push(entry);
662 for (i = 0; i < entriesToRemove.length; i++) {
663 noteholder.removeChild(entriesToRemove[i]);
666 // Rebuild footnote entries.
667 var cont = document.getElementById("content");
668 var spans = cont.getElementsByTagName("span");
669 var refs = {};
670 var n = 0;
671 for (i=0; i<spans.length; i++) {
672 if (spans[i].className == "footnote") {
673 n++;
674 var note = spans[i].getAttribute("data-note");
675 if (!note) {
676 // Use [\s\S] in place of . so multi-line matches work.
677 // Because JavaScript has no s (dotall) regex flag.
678 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
679 spans[i].innerHTML =
680 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
681 "' title='View footnote' class='footnote'>" + n + "</a>]";
682 spans[i].setAttribute("data-note", note);
684 noteholder.innerHTML +=
685 "<div class='footnote' id='_footnote_" + n + "'>" +
686 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
687 n + "</a>. " + note + "</div>";
688 var id =spans[i].getAttribute("id");
689 if (id != null) refs["#"+id] = n;
692 if (n == 0)
693 noteholder.parentNode.removeChild(noteholder);
694 else {
695 // Process footnoterefs.
696 for (i=0; i<spans.length; i++) {
697 if (spans[i].className == "footnoteref") {
698 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
699 href = href.match(/#.*/)[0]; // Because IE return full URL.
700 n = refs[href];
701 spans[i].innerHTML =
702 "[<a href='#_footnote_" + n +
703 "' title='View footnote' class='footnote'>" + n + "</a>]";
709 install: function(toclevels) {
710 var timerId;
712 function reinstall() {
713 asciidoc.footnotes();
714 if (toclevels) {
715 asciidoc.toc(toclevels);
719 function reinstallAndRemoveTimer() {
720 clearInterval(timerId);
721 reinstall();
724 timerId = setInterval(reinstall, 500);
725 if (document.addEventListener)
726 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
727 else
728 window.onload = reinstallAndRemoveTimer;
732 asciidoc.install();
733 /*]]>*/
734 </script>
735 </head>
736 <body class="manpage">
737 <div id="header">
738 <h1>
739 git-checkpoint(1) Manual Page
740 </h1>
741 <h2>NAME</h2>
742 <div class="sectionbody">
743 <p>git-checkpoint -
744 Stash the changes in a dirty working directory away
745 </p>
746 </div>
747 </div>
748 <div id="content">
749 <div class="sect1">
750 <h2 id="_synopsis">SYNOPSIS</h2>
751 <div class="sectionbody">
752 <div class="verseblock">
753 <pre class="content"><em>git checkpoint</em> [&lt;message&gt;]</pre>
754 <div class="attribution">
755 </div></div>
756 </div>
757 </div>
758 <div class="sect1">
759 <h2 id="_description">DESCRIPTION</h2>
760 <div class="sectionbody">
761 <div class="paragraph"><p>Use <tt>git checkpoint</tt> when you want to record the current state of the
762 working directory and the index, but do NOT want to go back to a clean
763 working directory. The command saves your local modifications away
764 without touching the index or working directory.</p></div>
765 <div class="paragraph"><p>The modifications stashed away by this command can be listed with
766 <tt>git stash list</tt>, inspected with <tt>git stash show</tt>, and restored
767 (potentially on top of a different commit) with <tt>git stash apply</tt>.
768 A stash is by default listed as "WIP on <em>branchname</em> &#8230;", but
769 you can give a more descriptive message on the command line when
770 you create one.</p></div>
771 <div class="paragraph"><p>The latest stash you created is stored in <tt>refs/stash</tt>; older
772 stashes are found in the reflog of this reference and can be named using
773 the usual reflog syntax (e.g. <tt>stash@{0}</tt> is the most recently
774 created stash, <tt>stash@{1}</tt> is the one before it, <tt>stash@{2.hours.ago}</tt>
775 is also possible).</p></div>
776 </div>
777 </div>
778 <div class="sect1">
779 <h2 id="_see_also">SEE ALSO</h2>
780 <div class="sectionbody">
781 <div class="paragraph"><p><a href="git-reflog.html">git-reflog(1)</a>,
782 <a href="git-stash.html">git-stash(1)</a></p></div>
783 </div>
784 </div>
785 </div>
786 <div id="footnotes"><hr /></div>
787 <div id="footer">
788 <div id="footer-text">
789 Last updated 2015-02-23 09:51:52 PST
790 </div>
791 </div>
792 </body>
793 </html>