| blob | 9f790110eae68d1a09b31277b55dcda3eae0e66c |
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-commit(1) Manual Page
407 </h1>
410 <p>git-commit -
411 Record changes to the repository
412 </p>
413 </div>
414 </div>
418 <div class="verseblock-content"><em>git commit</em> [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
420 [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify]
424 </div></div>
425 </div>
429 with a log message from the user describing the changes.</p></div>
432 <li>
433 <p>
436 files must be "added");
437 </p>
438 </li>
439 <li>
440 <p>
443 </p>
444 </li>
445 <li>
446 <p>
448 case the commit will ignore changes staged in the index, and instead
449 record the current content of the listed files (which must already
450 be known to git);
451 </p>
452 </li>
453 <li>
454 <p>
456 "add" changes from all known files (i.e. all files that are already
457 listed in the index) and to automatically "rm" files in the index
458 that have been removed from the working tree, and then perform the
459 actual commit;
460 </p>
461 </li>
462 <li>
463 <p>
465 by one which files should be part of the commit, before finalizing the
467 </p>
468 </li>
469 </ol></div>
471 summary of what is included by any of the above for the next
472 commit by giving the same set of parameters (options and paths).</p></div>
475 </div>
480 -a
481 </dt>
483 --all
484 </dt>
485 <dd>
486 <p>
487 Tell the command to automatically stage files that have
488 been modified and deleted, but new files you have not
489 told git about are not affected.
490 </p>
491 </dd>
494 </dt>
497 </dt>
498 <dd>
499 <p>
500 Take an existing commit object, and reuse the log message
501 and the authorship information (including the timestamp)
502 when creating the commit.
503 </p>
504 </dd>
507 </dt>
510 </dt>
511 <dd>
512 <p>
514 the user can further edit the commit message.
515 </p>
516 </dd>
519 </dt>
520 <dd>
521 <p>
523 The commit message will be the subject line from the specified
525 for details.
526 </p>
527 </dd>
530 </dt>
531 <dd>
532 <p>
534 The commit message subject line is taken from the specified
535 commit with a prefix of "squash! ". Can be used with additional
538 </p>
539 </dd>
541 --reset-author
542 </dt>
543 <dd>
544 <p>
545 When used with -C/-c/--amend options, or when committing after a
546 a conflicting cherry-pick, declare that the authorship of the
547 resulting commit now belongs of the committer. This also renews
548 the author timestamp.
549 </p>
550 </dd>
552 --short
553 </dt>
554 <dd>
555 <p>
556 When doing a dry-run, give the output in the short-format. See
558 </p>
559 </dd>
561 --porcelain
562 </dt>
563 <dd>
564 <p>
565 When doing a dry-run, give the output in a porcelain-ready
568 </p>
569 </dd>
571 -z
572 </dt>
573 <dd>
574 <p>
576 entries in the status output with NUL, instead of LF. If no
578 </p>
579 </dd>
582 </dt>
585 </dt>
586 <dd>
587 <p>
589 read the message from the standard input.
590 </p>
591 </dd>
594 </dt>
595 <dd>
596 <p>
597 Override the commit author. Specify an explicit author using the
598 standard <tt>A U Thor <<a href="mailto:author@example.com">author@example.com</a>></tt> format. Otherwise <author>
599 is assumed to be a pattern and is used to search for an existing
601 the commit author is then copied from the first such commit found.
602 </p>
603 </dd>
606 </dt>
607 <dd>
608 <p>
609 Override the author date used in the commit.
610 </p>
611 </dd>
614 </dt>
617 </dt>
618 <dd>
619 <p>
621 </p>
622 </dd>
625 </dt>
628 </dt>
629 <dd>
630 <p>
631 Use the contents of the given file as the initial version
632 of the commit message. The editor is invoked and you can
633 make subsequent changes. If a message is specified using
636 </p>
637 </dd>
639 -s
640 </dt>
642 --signoff
643 </dt>
644 <dd>
645 <p>
646 Add Signed-off-by line by the committer at the end of the commit
647 log message.
648 </p>
649 </dd>
651 -n
652 </dt>
654 --no-verify
655 </dt>
656 <dd>
657 <p>
658 This option bypasses the pre-commit and commit-msg hooks.
660 </p>
661 </dd>
663 --allow-empty
664 </dt>
665 <dd>
666 <p>
667 Usually recording a commit that has the exact same tree as its
668 sole parent commit is a mistake, and the command prevents you
669 from making such a commit. This option bypasses the safety, and
670 is primarily for use by foreign SCM interface scripts.
671 </p>
672 </dd>
674 --allow-empty-message
675 </dt>
676 <dd>
677 <p>
678 Like --allow-empty this command is primarily for use by foreign
679 SCM interface scripts. It allows you to create a commit with an
680 empty commit message without using plumbing commands like
682 </p>
683 </dd>
686 </dt>
687 <dd>
688 <p>
689 This option sets how the commit message is cleaned up.
692 trailing empty lines and #commentary from the commit message
693 only if the message is to be edited. Otherwise only whitespace
697 </p>
698 </dd>
700 -e
701 </dt>
703 --edit
704 </dt>
705 <dd>
706 <p>
709 commit log message unmodified. This option lets you
710 further edit the message taken from these sources.
711 </p>
712 </dd>
714 --amend
715 </dt>
716 <dd>
717 <p>
718 Used to amend the tip of the current branch. Prepare the tree
719 object you would want to replace the latest commit as usual
720 (this includes the usual -i/-o and explicit paths), and the
721 commit log editor is seeded with the commit message from the
722 tip of the current branch. The commit you create replaces the
723 current tip — if it was a merge, it will have the parents of
724 the current tip as parents — so the current top commit is
725 discarded.
726 </p>
730 <pre><tt> $ git reset --soft HEAD^
731 $ ... do something else to come up with the right tree ...
732 $ git commit -c ORIG_HEAD</tt></pre>
733 </div></div>
736 amend a commit that has already been published. (See the "RECOVERING
738 </dd>
740 -i
741 </dt>
743 --include
744 </dt>
745 <dd>
746 <p>
747 Before making a commit out of staged contents so far,
748 stage the contents of paths given on the command line
749 as well. This is usually not what you want unless you
750 are concluding a conflicted merge.
751 </p>
752 </dd>
754 -o
755 </dt>
757 --only
758 </dt>
759 <dd>
760 <p>
761 Make a commit only from the paths specified on the
762 command line, disregarding any contents that have been
763 staged so far. This is the default mode of operation of
765 in which case this option can be omitted.
767 no paths need to be specified, which can be used to amend
768 the last commit without committing changes that have
769 already been staged.
770 </p>
771 </dd>
774 </dt>
777 </dt>
778 <dd>
779 <p>
780 Show untracked files.
781 </p>
782 <div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
783 specify the handling of untracked files; when -u is not used, the
787 <li>
788 <p>
790 </p>
791 </li>
792 <li>
793 <p>
795 </p>
796 </li>
797 <li>
798 <p>
800 </p>
803 </li>
804 </ul></div>
805 </dd>
807 -v
808 </dt>
810 --verbose
811 </dt>
812 <dd>
813 <p>
814 Show unified diff between the HEAD commit and what
815 would be committed at the bottom of the commit message
816 template. Note that this diff output doesn’t have its
818 </p>
819 </dd>
821 -q
822 </dt>
824 --quiet
825 </dt>
826 <dd>
827 <p>
828 Suppress commit summary message.
829 </p>
830 </dd>
832 --dry-run
833 </dt>
834 <dd>
835 <p>
836 Do not create a commit, but show a list of paths that are
837 to be committed, paths with local changes that will be left
838 uncommitted and paths that are untracked.
839 </p>
840 </dd>
842 --status
843 </dt>
844 <dd>
845 <p>
847 message template when using an editor to prepare the commit
848 message. Defaults to on, but can be used to override
849 configuration variable commit.status.
850 </p>
851 </dd>
853 --no-status
854 </dt>
855 <dd>
856 <p>
858 commit message template when using an editor to prepare the
859 default commit message.
860 </p>
861 </dd>
863 --
864 </dt>
865 <dd>
866 <p>
867 Do not interpret any more arguments as options.
868 </p>
869 </dd>
872 </dt>
873 <dd>
874 <p>
875 When files are given on the command line, the command
876 commits the contents of the named files, without
877 recording the changes already staged. The contents of
878 these files are also staged for the next commit on top
879 of what have been staged before.
880 </p>
881 </dd>
882 </dl></div>
883 </div>
888 support the following date formats:</p></div>
891 Git internal format
892 </dt>
893 <dd>
894 <p>
899 </p>
900 </dd>
902 RFC 2822
903 </dt>
904 <dd>
905 <p>
906 The standard email format as described by RFC 2822, for example
908 </p>
909 </dd>
911 ISO 8601
912 </dt>
913 <dd>
914 <p>
915 Time and date specified by the ISO 8601 standard, for example
918 </p>
920 <table><tr>
923 </td>
926 </tr></table>
927 </div>
928 </dd>
929 </dl></div>
930 </div>
934 your working tree are temporarily stored to a staging area
936 reverted back, only in the index but not in the working tree,
939 this file from participating in the next commit. After building
940 the state to be committed incrementally with these commands,
942 has been staged so far. This is the most basic form of the
943 command. An example:</p></div>
946 <pre><tt>$ edit hello.c
947 $ git rm goodbye.c
948 $ git add hello.c
949 $ git commit</tt></pre>
950 </div></div>
953 contents are tracked in
955 for you. That is, this example does the same as the earlier
956 example if there is no other change in your working tree:</p></div>
959 <pre><tt>$ edit hello.c
960 $ rm goodbye.c
961 $ git commit -a</tt></pre>
962 </div></div>
964 notices that you have modified hello.c and removed goodbye.c,
968 When pathnames are given, the command makes a commit that
969 only records the changes made to the named paths:</p></div>
972 <pre><tt>$ edit hello.c hello.h
973 $ git add hello.c hello.h
974 $ edit Makefile
975 $ git commit Makefile</tt></pre>
976 </div></div>
977 <div class="paragraph"><p>This makes a commit that records the modification to <tt>Makefile</tt>.
979 in the resulting commit. However, their changes are not lost — they are still staged and merely held back. After the above
980 sequence, if you do:</p></div>
984 </div></div>
987 <div class="paragraph"><p>After a merge (initiated by <em>git merge</em> or <em>git pull</em>) stops
988 because of conflicts, cleanly merged
989 paths are already staged to be committed for you, and paths that
990 conflicted are left in unmerged state. You would have to first
992 and after fixing them manually in your working tree, you would
996 <pre><tt>$ git status | grep unmerged
997 unmerged: hello.c
998 $ edit hello.c
999 $ git add hello.c</tt></pre>
1000 </div></div>
1001 <div class="paragraph"><p>After resolving conflicts and staging the result, <tt>git ls-files -u</tt>
1002 would stop mentioning the conflicted path. When you are done,
1007 </div></div>
1009 option to save typing. One difference is that during a merge
1011 alter the order the changes are committed, because the merge
1012 should be recorded as a single commit. In fact, the command
1014 </div>
1017 <div class="paragraph"><p>Though not required, it’s a good idea to begin the commit message
1018 with a single short (less than 50 character) line summarizing the
1019 change, followed by a blank line and then a more thorough description.
1020 Tools that turn commits into email, for example, use the first line
1021 on the Subject: line and the rest of the commit in the body.</p></div>
1024 <li>
1025 <p>
1026 The pathnames recorded in the index and in the tree objects
1027 are treated as uninterpreted sequences of non-NUL bytes.
1028 What readdir(2) returns are what are recorded and compared
1029 with the data git keeps track of, which in turn are expected
1031 thing as pathname encoding translation.
1032 </p>
1033 </li>
1034 <li>
1035 <p>
1036 The contents of the blob objects are uninterpreted sequences
1037 of bytes. There is no encoding translation at the core
1038 level.
1039 </p>
1040 </li>
1041 <li>
1042 <p>
1043 The commit log messages are uninterpreted sequences of non-NUL
1044 bytes.
1045 </p>
1046 </li>
1047 </ul></div>
1049 in UTF-8, both the core and git Porcelain are designed not to
1050 force UTF-8 on projects. If all participants of a particular
1051 project find it more convenient to use legacy encodings, git
1052 does not forbid it. However, there are a few things to keep in
1053 mind.</p></div>
1055 <li>
1056 <p>
1058 a warning if the commit log message given to it does not look
1059 like a valid UTF-8 string, unless you explicitly say your
1060 project uses a legacy encoding. The way to say this is to
1062 </p>
1065 <pre><tt>[i18n]
1067 </div></div>
1070 help other people who look at them later. Lack of this header
1072 </li>
1073 <li>
1074 <p>
1077 log message into UTF-8 unless otherwise specified. You can
1078 specify the desired output encoding with
1080 </p>
1083 <pre><tt>[i18n]
1085 </div></div>
1088 </li>
1089 </ol></div>
1091 message when a commit is made to force UTF-8 at the commit
1092 object level, because re-coding to UTF-8 is not necessarily a
1093 reversible operation.</p></div>
1094 </div>
1097 <div class="paragraph"><p>The editor used to edit the commit log message will be chosen from the
1098 GIT_EDITOR environment variable, the core.editor configuration variable, the
1099 VISUAL environment variable, or the EDITOR environment variable (in that
1101 </div>
1104 <div class="paragraph"><p>This command can run <tt>commit-msg</tt>, <tt>prepare-commit-msg</tt>, <tt>pre-commit</tt>,
1106 information.</p></div>
1107 </div>
1115 </div>
1119 </div>
1123 </div>
1124 </div>
1125 </body>
1126 </html>