| blob | 0d6173d412375566247db643a047e18dc8c660bc |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-add(1) Manual Page
407 </h1>
410 <p>git-add -
411 Add file contents to the index
412 </p>
413 </div>
414 </div>
418 <div class="verseblock-content"><em>git add</em> [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
419 [--edit | -e] [--all | [--update | -u]] [--intent-to-add | -N]
420 [--refresh] [--ignore-errors] [--ignore-missing] [--]
423 </div></div>
424 </div>
428 the working tree, to prepare the content staged for the next commit.
429 It typically adds the current content of existing paths as a whole,
430 but with some options it can also be used to add content with
431 only part of the changes made to the working tree files applied, or
432 remove paths that do not exist in the working tree anymore.</p></div>
433 <div class="paragraph"><p>The "index" holds a snapshot of the content of the working tree, and it
434 is this snapshot that is taken as the contents of the next commit. Thus
435 after making any changes to the working directory, and before running
437 modified files to the index.</p></div>
439 adds the content of the specified file(s) at the time the add command is
440 run; if you want subsequent changes included in the next commit, then
442 <div class="paragraph"><p>The <tt>git status</tt> command can be used to obtain a summary of which
443 files have changes that are staged for the next commit.</p></div>
444 <div class="paragraph"><p>The <tt>git add</tt> command will not add ignored files by default. If any
446 will fail with a list of ignored files. Ignored files reached by
447 directory recursion or filename globbing performed by Git (quote your
450 <div class="paragraph"><p>Please see <a href="git-commit.html">git-commit(1)</a> for alternative ways to add content to a
451 commit.</p></div>
452 </div>
458 </dt>
459 <dd>
460 <p>
462 be given to add all matching files. Also a
465 directory, recursively.
466 </p>
467 </dd>
469 -n
470 </dt>
472 --dry-run
473 </dt>
474 <dd>
475 <p>
476 Don’t actually add the file(s), just show if they exist and/or will
477 be ignored.
478 </p>
479 </dd>
481 -v
482 </dt>
484 --verbose
485 </dt>
486 <dd>
487 <p>
488 Be verbose.
489 </p>
490 </dd>
492 -f
493 </dt>
495 --force
496 </dt>
497 <dd>
498 <p>
499 Allow adding otherwise ignored files.
500 </p>
501 </dd>
503 -i
504 </dt>
506 --interactive
507 </dt>
508 <dd>
509 <p>
510 Add modified contents in the working tree interactively to
511 the index. Optional path arguments may be supplied to limit
512 operation to a subset of the working tree. See “Interactive
513 mode” for details.
514 </p>
515 </dd>
517 -p
518 </dt>
520 --patch
521 </dt>
522 <dd>
523 <p>
524 Interactively choose hunks of patch between the index and the
525 work tree and add them to the index. This gives the user a chance
526 to review the difference before adding modified contents to the
527 index.
528 </p>
532 </dd>
534 -e, --edit
535 </dt>
536 <dd>
537 <p>
538 Open the diff vs. the index in an editor and let the user
539 edit it. After the editor was closed, adjust the hunk headers
540 and apply the patch to the index.
541 </p>
543 apply, or even to modify the contents of lines to be staged. This can be
544 quicker and more flexible than using the interactive hunk selector.
545 However, it is easy to confuse oneself and create a patch that does not
546 apply to the index. See EDITING PATCHES below.</p></div>
547 </dd>
549 -u
550 </dt>
552 --update
553 </dt>
554 <dd>
555 <p>
557 the index rather than the working tree. That means that it
558 will never stage new files, but that it will stage modified
559 new contents of tracked files and that it will remove files
560 from the index if the corresponding files in the working tree
561 have been removed.
562 </p>
564 update all tracked files in the current directory and its
565 subdirectories.</p></div>
566 </dd>
568 -A
569 </dt>
571 --all
572 </dt>
573 <dd>
574 <p>
576 working tree in addition to the index. That means that it
577 will find new files as well as staging modified content and
578 removing files that are no longer in the working tree.
579 </p>
580 </dd>
582 -N
583 </dt>
585 --intent-to-add
586 </dt>
587 <dd>
588 <p>
589 Record only the fact that the path will be added later. An entry
590 for the path is placed in the index with no content. This is
591 useful for, among other things, showing the unstaged content of
593 -a</tt>.
594 </p>
595 </dd>
597 --refresh
598 </dt>
599 <dd>
600 <p>
601 Don’t add the file(s), but only refresh their stat()
602 information in the index.
603 </p>
604 </dd>
606 --ignore-errors
607 </dt>
608 <dd>
609 <p>
610 If some files could not be added because of errors indexing
611 them, do not abort the operation, but continue adding the
612 others. The command shall still exit with non-zero status.
613 </p>
614 </dd>
616 --ignore-missing
617 </dt>
618 <dd>
619 <p>
620 This option can only be used together with --dry-run. By using
621 this option the user can check if any of the given files would
622 be ignored, no matter if they are already present in the work
623 tree or not.
624 </p>
625 </dd>
627 --
628 </dt>
629 <dd>
630 <p>
631 This option can be used to separate command-line options from
632 the list of files, (useful when filenames might be mistaken
633 for command-line options).
634 </p>
635 </dd>
636 </dl></div>
637 </div>
640 <div class="paragraph"><p>The optional configuration variable <tt>core.excludesfile</tt> indicates a path to a
641 file containing patterns of file names to exclude from git-add, similar to
642 $GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
643 those in info/exclude. See <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.</p></div>
644 </div>
648 <li>
649 <p>
651 and its subdirectories:
652 </p>
656 </div></div>
658 example; this lets the command include the files from
660 </li>
661 <li>
662 <p>
663 Considers adding content from all git-*.sh scripts:
664 </p>
668 </div></div>
670 listing the files explicitly), it does not consider
672 </li>
673 </ul></div>
674 </div>
679 interactive command loop.</p></div>
681 gives a prompt "What now> ". In general, when the prompt ends
683 and type return, like this:</p></div>
686 <pre><tt> *** Commands ***
690 </div></div>
691 <div class="paragraph"><p>You also could say <tt>s</tt> or <tt>sta</tt> or <tt>status</tt> above as long as the
692 choice is unique.</p></div>
693 <div class="paragraph"><p>The main command loop has 6 subcommands (plus help and quit).</p></div>
696 status
697 </dt>
698 <dd>
699 <p>
700 This shows the change between HEAD and index (i.e. what will be
702 working tree files (i.e. what you could stage further before
704 looks like this:
705 </p>
708 <pre><tt> staged unstaged path
709 1: binary nothing foo.png
711 </div></div>
713 binary so line count cannot be shown) and there is no
714 difference between indexed copy and the working tree
715 version (if the working tree version were also different,
718 and 35 lines deleted if you commit what is in the index, but
719 working tree file has further modifications (one addition and
720 one deletion).</p></div>
721 </dd>
723 update
724 </dt>
725 <dd>
726 <p>
727 This shows the status information and issues an "Update>>"
729 make more than one selection, concatenated with whitespace or
730 comma. Also you can say ranges. E.g. "2-5 7,9" to choose
732 omitted, all remaining patches are taken. E.g. "7-" to choose
734 </p>
736 like this:</p></div>
739 <pre><tt> staged unstaged path
740 1: binary nothing foo.png
742 </div></div>
744 like this:</p></div>
748 </div></div>
750 contents of working tree files for selected paths in the index.</p></div>
751 </dd>
753 revert
754 </dt>
755 <dd>
756 <p>
758 information for selected paths are reverted to that of the
759 HEAD version. Reverting new paths makes them untracked.
760 </p>
761 </dd>
763 add untracked
764 </dt>
765 <dd>
766 <p>
769 </p>
770 </dd>
772 patch
773 </dt>
774 <dd>
775 <p>
777 After choosing the path, it presents the diff between the index
778 and the working tree file and asks you if you want to stage
779 the change of each hunk. You can say:
780 </p>
783 <pre><tt>y - stage this hunk
784 n - do not stage this hunk
785 q - quit; do not stage this hunk nor any of the remaining ones
786 a - stage this hunk and all later hunks in the file
787 d - do not stage this hunk nor any of the later hunks in the file
788 g - select a hunk to go to
789 / - search for a hunk matching the given regex
790 j - leave this hunk undecided, see next undecided hunk
791 J - leave this hunk undecided, see next hunk
792 k - leave this hunk undecided, see previous undecided hunk
793 K - leave this hunk undecided, see previous hunk
794 s - split the current hunk into smaller hunks
795 e - manually edit the current hunk
796 ? - print help</tt></pre>
797 </div></div>
799 that was chosen, the index is updated with the selected hunks.</p></div>
800 </dd>
802 diff
803 </dt>
804 <dd>
805 <p>
806 This lets you review what will be committed (i.e. between
807 HEAD and index).
808 </p>
809 </dd>
810 </dl></div>
811 </div>
814 <div class="paragraph"><p>Invoking <tt>git add -e</tt> or selecting <tt>e</tt> from the interactive hunk
815 selector will open a patch in your editor; after the editor exits, the
816 result is applied to the index. You are free to make arbitrary changes
817 to the patch, but note that some changes may have confusing results, or
818 even result in a patch that cannot be applied. If you want to abort the
819 operation entirely (i.e., stage nothing new in the index), simply delete
820 all lines of the patch. The list below describes some common things you
821 may see in a patch, and which editing operations make sense on them.</p></div>
824 added content
825 </dt>
826 <dd>
827 <p>
828 Added content is represented by lines beginning with "+". You can
829 prevent staging any addition lines by deleting them.
830 </p>
831 </dd>
833 removed content
834 </dt>
835 <dd>
836 <p>
837 Removed content is represented by lines beginning with "-". You can
839 </p>
840 </dd>
842 modified content
843 </dt>
844 <dd>
845 <p>
846 Modified content is represented by "-" lines (removing the old content)
847 followed by "+" lines (adding the replacement content). You can
849 removing "+" lines. Beware that modifying only half of the pair is
850 likely to introduce confusing changes to the index.
851 </p>
852 </dd>
853 </dl></div>
854 <div class="paragraph"><p>There are also more complex operations that can be performed. But beware
855 that because the patch is applied only to the index and not the working
856 tree, the working tree will appear to "undo" the change in the index.
857 For example, introducing a new line into the index that is in neither
858 the HEAD nor the working tree will stage the new line for commit, but
859 the line will appear to be reverted in the working tree.</p></div>
860 <div class="paragraph"><p>Avoid using these constructs, or do so with extreme caution.</p></div>
863 removing untouched content
864 </dt>
865 <dd>
866 <p>
867 Content which does not differ between the index and working tree may be
868 shown on context lines, beginning with a " " (space). You can stage
869 context lines for removal by converting the space to a "-". The
870 resulting working tree file will appear to re-add the content.
871 </p>
872 </dd>
874 modifying existing content
875 </dt>
876 <dd>
877 <p>
878 One can also modify context lines by staging them for removal (by
880 Similarly, one can modify "+" lines for existing additions or
881 modifications. In all cases, the new modification will appear reverted
882 in the working tree.
883 </p>
884 </dd>
886 new content
887 </dt>
888 <dd>
889 <p>
890 You may also add new content that does not exist in the patch; simply
891 add new lines, each starting with "+". The addition will appear
892 reverted in the working tree.
893 </p>
894 </dd>
895 </dl></div>
896 <div class="paragraph"><p>There are also several operations which should be avoided entirely, as
897 they will make the patch impossible to apply:</p></div>
899 <li>
900 <p>
902 </p>
903 </li>
904 <li>
905 <p>
906 deleting context or removal lines
907 </p>
908 </li>
909 <li>
910 <p>
911 modifying the contents of context or removal lines
912 </p>
913 </li>
914 </ul></div>
915 </div>
924 </div>
927 <div class="paragraph"><p>Written by Linus Torvalds <<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>></p></div>
928 </div>
931 <div class="paragraph"><p>Documentation by Junio C Hamano and the git-list <<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>>.</p></div>
932 </div>
936 </div>
940 </div>
941 </div>
942 </body>
943 </html>