| blob | 44238ce8d00626165f582a57e86a99c5bd8785ee |
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.
614 true to make this the default behaviour.
615 </p>
616 </dd>
618 --ignore-missing
619 </dt>
620 <dd>
621 <p>
622 This option can only be used together with --dry-run. By using
623 this option the user can check if any of the given files would
624 be ignored, no matter if they are already present in the work
625 tree or not.
626 </p>
627 </dd>
629 --
630 </dt>
631 <dd>
632 <p>
633 This option can be used to separate command-line options from
634 the list of files, (useful when filenames might be mistaken
635 for command-line options).
636 </p>
637 </dd>
638 </dl></div>
639 </div>
642 <div class="paragraph"><p>The optional configuration variable <tt>core.excludesfile</tt> indicates a path to a
643 file containing patterns of file names to exclude from git-add, similar to
644 $GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
645 those in info/exclude. See <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.</p></div>
646 </div>
650 <li>
651 <p>
653 and its subdirectories:
654 </p>
658 </div></div>
660 example; this lets the command include the files from
662 </li>
663 <li>
664 <p>
665 Considers adding content from all git-*.sh scripts:
666 </p>
670 </div></div>
672 listing the files explicitly), it does not consider
674 </li>
675 </ul></div>
676 </div>
681 interactive command loop.</p></div>
683 gives a prompt "What now> ". In general, when the prompt ends
685 and type return, like this:</p></div>
688 <pre><tt> *** Commands ***
692 </div></div>
693 <div class="paragraph"><p>You also could say <tt>s</tt> or <tt>sta</tt> or <tt>status</tt> above as long as the
694 choice is unique.</p></div>
695 <div class="paragraph"><p>The main command loop has 6 subcommands (plus help and quit).</p></div>
698 status
699 </dt>
700 <dd>
701 <p>
702 This shows the change between HEAD and index (i.e. what will be
704 working tree files (i.e. what you could stage further before
706 looks like this:
707 </p>
710 <pre><tt> staged unstaged path
711 1: binary nothing foo.png
713 </div></div>
715 binary so line count cannot be shown) and there is no
716 difference between indexed copy and the working tree
717 version (if the working tree version were also different,
720 and 35 lines deleted if you commit what is in the index, but
721 working tree file has further modifications (one addition and
722 one deletion).</p></div>
723 </dd>
725 update
726 </dt>
727 <dd>
728 <p>
729 This shows the status information and issues an "Update>>"
731 make more than one selection, concatenated with whitespace or
732 comma. Also you can say ranges. E.g. "2-5 7,9" to choose
734 omitted, all remaining patches are taken. E.g. "7-" to choose
736 </p>
738 like this:</p></div>
741 <pre><tt> staged unstaged path
742 1: binary nothing foo.png
744 </div></div>
746 like this:</p></div>
750 </div></div>
752 contents of working tree files for selected paths in the index.</p></div>
753 </dd>
755 revert
756 </dt>
757 <dd>
758 <p>
760 information for selected paths are reverted to that of the
761 HEAD version. Reverting new paths makes them untracked.
762 </p>
763 </dd>
765 add untracked
766 </dt>
767 <dd>
768 <p>
771 </p>
772 </dd>
774 patch
775 </dt>
776 <dd>
777 <p>
779 After choosing the path, it presents the diff between the index
780 and the working tree file and asks you if you want to stage
781 the change of each hunk. You can say:
782 </p>
785 <pre><tt>y - stage this hunk
786 n - do not stage this hunk
787 q - quit; do not stage this hunk nor any of the remaining ones
788 a - stage this hunk and all later hunks in the file
789 d - do not stage this hunk nor any of the later hunks in the file
790 g - select a hunk to go to
791 / - search for a hunk matching the given regex
792 j - leave this hunk undecided, see next undecided hunk
793 J - leave this hunk undecided, see next hunk
794 k - leave this hunk undecided, see previous undecided hunk
795 K - leave this hunk undecided, see previous hunk
796 s - split the current hunk into smaller hunks
797 e - manually edit the current hunk
798 ? - print help</tt></pre>
799 </div></div>
801 that was chosen, the index is updated with the selected hunks.</p></div>
802 </dd>
804 diff
805 </dt>
806 <dd>
807 <p>
808 This lets you review what will be committed (i.e. between
809 HEAD and index).
810 </p>
811 </dd>
812 </dl></div>
813 </div>
816 <div class="paragraph"><p>Invoking <tt>git add -e</tt> or selecting <tt>e</tt> from the interactive hunk
817 selector will open a patch in your editor; after the editor exits, the
818 result is applied to the index. You are free to make arbitrary changes
819 to the patch, but note that some changes may have confusing results, or
820 even result in a patch that cannot be applied. If you want to abort the
821 operation entirely (i.e., stage nothing new in the index), simply delete
822 all lines of the patch. The list below describes some common things you
823 may see in a patch, and which editing operations make sense on them.</p></div>
826 added content
827 </dt>
828 <dd>
829 <p>
830 Added content is represented by lines beginning with "+". You can
831 prevent staging any addition lines by deleting them.
832 </p>
833 </dd>
835 removed content
836 </dt>
837 <dd>
838 <p>
839 Removed content is represented by lines beginning with "-". You can
841 </p>
842 </dd>
844 modified content
845 </dt>
846 <dd>
847 <p>
848 Modified content is represented by "-" lines (removing the old content)
849 followed by "+" lines (adding the replacement content). You can
851 removing "+" lines. Beware that modifying only half of the pair is
852 likely to introduce confusing changes to the index.
853 </p>
854 </dd>
855 </dl></div>
856 <div class="paragraph"><p>There are also more complex operations that can be performed. But beware
857 that because the patch is applied only to the index and not the working
858 tree, the working tree will appear to "undo" the change in the index.
859 For example, introducing a new line into the index that is in neither
860 the HEAD nor the working tree will stage the new line for commit, but
861 the line will appear to be reverted in the working tree.</p></div>
862 <div class="paragraph"><p>Avoid using these constructs, or do so with extreme caution.</p></div>
865 removing untouched content
866 </dt>
867 <dd>
868 <p>
869 Content which does not differ between the index and working tree may be
870 shown on context lines, beginning with a " " (space). You can stage
871 context lines for removal by converting the space to a "-". The
872 resulting working tree file will appear to re-add the content.
873 </p>
874 </dd>
876 modifying existing content
877 </dt>
878 <dd>
879 <p>
880 One can also modify context lines by staging them for removal (by
882 Similarly, one can modify "+" lines for existing additions or
883 modifications. In all cases, the new modification will appear reverted
884 in the working tree.
885 </p>
886 </dd>
888 new content
889 </dt>
890 <dd>
891 <p>
892 You may also add new content that does not exist in the patch; simply
893 add new lines, each starting with "+". The addition will appear
894 reverted in the working tree.
895 </p>
896 </dd>
897 </dl></div>
898 <div class="paragraph"><p>There are also several operations which should be avoided entirely, as
899 they will make the patch impossible to apply:</p></div>
901 <li>
902 <p>
904 </p>
905 </li>
906 <li>
907 <p>
908 deleting context or removal lines
909 </p>
910 </li>
911 <li>
912 <p>
913 modifying the contents of context or removal lines
914 </p>
915 </li>
916 </ul></div>
917 </div>
926 </div>
930 </div>
934 </div>
935 </div>
936 </body>
937 </html>