| blob | e597767de9d48cb82b694b67475909eb640aaac4 |
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 | --patch] [-s] [-v] [-u<mode>] [--amend]
425 </div></div>
426 </div>
430 with a log message from the user describing the changes.</p></div>
433 <li>
434 <p>
437 files must be "added");
438 </p>
439 </li>
440 <li>
441 <p>
444 </p>
445 </li>
446 <li>
447 <p>
449 case the commit will ignore changes staged in the index, and instead
450 record the current content of the listed files (which must already
451 be known to git);
452 </p>
453 </li>
454 <li>
455 <p>
457 "add" changes from all known files (i.e. all files that are already
458 listed in the index) and to automatically "rm" files in the index
459 that have been removed from the working tree, and then perform the
460 actual commit;
461 </p>
462 </li>
463 <li>
464 <p>
466 to decide one by one which files or hunks should be part of the commit,
469 </p>
470 </li>
471 </ol></div>
473 summary of what is included by any of the above for the next
474 commit by giving the same set of parameters (options and paths).</p></div>
477 </div>
482 -a
483 </dt>
485 --all
486 </dt>
487 <dd>
488 <p>
489 Tell the command to automatically stage files that have
490 been modified and deleted, but new files you have not
491 told git about are not affected.
492 </p>
493 </dd>
495 -p
496 </dt>
498 --patch
499 </dt>
500 <dd>
501 <p>
502 Use the interactive patch selection interface to chose
504 details.
505 </p>
506 </dd>
509 </dt>
512 </dt>
513 <dd>
514 <p>
515 Take an existing commit object, and reuse the log message
516 and the authorship information (including the timestamp)
517 when creating the commit.
518 </p>
519 </dd>
522 </dt>
525 </dt>
526 <dd>
527 <p>
529 the user can further edit the commit message.
530 </p>
531 </dd>
534 </dt>
535 <dd>
536 <p>
538 The commit message will be the subject line from the specified
540 for details.
541 </p>
542 </dd>
545 </dt>
546 <dd>
547 <p>
549 The commit message subject line is taken from the specified
550 commit with a prefix of "squash! ". Can be used with additional
553 </p>
554 </dd>
556 --reset-author
557 </dt>
558 <dd>
559 <p>
560 When used with -C/-c/--amend options, or when committing after a
561 a conflicting cherry-pick, declare that the authorship of the
562 resulting commit now belongs of the committer. This also renews
563 the author timestamp.
564 </p>
565 </dd>
567 --short
568 </dt>
569 <dd>
570 <p>
571 When doing a dry-run, give the output in the short-format. See
573 </p>
574 </dd>
576 --porcelain
577 </dt>
578 <dd>
579 <p>
580 When doing a dry-run, give the output in a porcelain-ready
583 </p>
584 </dd>
586 -z
587 </dt>
588 <dd>
589 <p>
591 entries in the status output with NUL, instead of LF. If no
593 </p>
594 </dd>
597 </dt>
600 </dt>
601 <dd>
602 <p>
604 read the message from the standard input.
605 </p>
606 </dd>
609 </dt>
610 <dd>
611 <p>
612 Override the commit author. Specify an explicit author using the
613 standard <tt>A U Thor <<a href="mailto:author@example.com">author@example.com</a>></tt> format. Otherwise <author>
614 is assumed to be a pattern and is used to search for an existing
616 the commit author is then copied from the first such commit found.
617 </p>
618 </dd>
621 </dt>
622 <dd>
623 <p>
624 Override the author date used in the commit.
625 </p>
626 </dd>
629 </dt>
632 </dt>
633 <dd>
634 <p>
636 </p>
637 </dd>
640 </dt>
643 </dt>
644 <dd>
645 <p>
646 Use the contents of the given file as the initial version
647 of the commit message. The editor is invoked and you can
648 make subsequent changes. If a message is specified using
651 </p>
652 </dd>
654 -s
655 </dt>
657 --signoff
658 </dt>
659 <dd>
660 <p>
661 Add Signed-off-by line by the committer at the end of the commit
662 log message.
663 </p>
664 </dd>
666 -n
667 </dt>
669 --no-verify
670 </dt>
671 <dd>
672 <p>
673 This option bypasses the pre-commit and commit-msg hooks.
675 </p>
676 </dd>
678 --allow-empty
679 </dt>
680 <dd>
681 <p>
682 Usually recording a commit that has the exact same tree as its
683 sole parent commit is a mistake, and the command prevents you
684 from making such a commit. This option bypasses the safety, and
685 is primarily for use by foreign SCM interface scripts.
686 </p>
687 </dd>
689 --allow-empty-message
690 </dt>
691 <dd>
692 <p>
693 Like --allow-empty this command is primarily for use by foreign
694 SCM interface scripts. It allows you to create a commit with an
695 empty commit message without using plumbing commands like
697 </p>
698 </dd>
701 </dt>
702 <dd>
703 <p>
704 This option sets how the commit message is cleaned up.
707 trailing empty lines and #commentary from the commit message
708 only if the message is to be edited. Otherwise only whitespace
712 </p>
713 </dd>
715 -e
716 </dt>
718 --edit
719 </dt>
720 <dd>
721 <p>
724 commit log message unmodified. This option lets you
725 further edit the message taken from these sources.
726 </p>
727 </dd>
729 --amend
730 </dt>
731 <dd>
732 <p>
733 Used to amend the tip of the current branch. Prepare the tree
734 object you would want to replace the latest commit as usual
735 (this includes the usual -i/-o and explicit paths), and the
736 commit log editor is seeded with the commit message from the
737 tip of the current branch. The commit you create replaces the
738 current tip — if it was a merge, it will have the parents of
739 the current tip as parents — so the current top commit is
740 discarded.
741 </p>
745 <pre><tt> $ git reset --soft HEAD^
746 $ ... do something else to come up with the right tree ...
747 $ git commit -c ORIG_HEAD</tt></pre>
748 </div></div>
751 amend a commit that has already been published. (See the "RECOVERING
753 </dd>
755 -i
756 </dt>
758 --include
759 </dt>
760 <dd>
761 <p>
762 Before making a commit out of staged contents so far,
763 stage the contents of paths given on the command line
764 as well. This is usually not what you want unless you
765 are concluding a conflicted merge.
766 </p>
767 </dd>
769 -o
770 </dt>
772 --only
773 </dt>
774 <dd>
775 <p>
776 Make a commit only from the paths specified on the
777 command line, disregarding any contents that have been
778 staged so far. This is the default mode of operation of
780 in which case this option can be omitted.
782 no paths need to be specified, which can be used to amend
783 the last commit without committing changes that have
784 already been staged.
785 </p>
786 </dd>
789 </dt>
792 </dt>
793 <dd>
794 <p>
795 Show untracked files.
796 </p>
797 <div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
798 specify the handling of untracked files; when -u is not used, the
802 <li>
803 <p>
805 </p>
806 </li>
807 <li>
808 <p>
810 </p>
811 </li>
812 <li>
813 <p>
815 </p>
818 </li>
819 </ul></div>
820 </dd>
822 -v
823 </dt>
825 --verbose
826 </dt>
827 <dd>
828 <p>
829 Show unified diff between the HEAD commit and what
830 would be committed at the bottom of the commit message
831 template. Note that this diff output doesn’t have its
833 </p>
834 </dd>
836 -q
837 </dt>
839 --quiet
840 </dt>
841 <dd>
842 <p>
843 Suppress commit summary message.
844 </p>
845 </dd>
847 --dry-run
848 </dt>
849 <dd>
850 <p>
851 Do not create a commit, but show a list of paths that are
852 to be committed, paths with local changes that will be left
853 uncommitted and paths that are untracked.
854 </p>
855 </dd>
857 --status
858 </dt>
859 <dd>
860 <p>
862 message template when using an editor to prepare the commit
863 message. Defaults to on, but can be used to override
864 configuration variable commit.status.
865 </p>
866 </dd>
868 --no-status
869 </dt>
870 <dd>
871 <p>
873 commit message template when using an editor to prepare the
874 default commit message.
875 </p>
876 </dd>
878 --
879 </dt>
880 <dd>
881 <p>
882 Do not interpret any more arguments as options.
883 </p>
884 </dd>
887 </dt>
888 <dd>
889 <p>
890 When files are given on the command line, the command
891 commits the contents of the named files, without
892 recording the changes already staged. The contents of
893 these files are also staged for the next commit on top
894 of what have been staged before.
895 </p>
896 </dd>
897 </dl></div>
898 </div>
903 support the following date formats:</p></div>
906 Git internal format
907 </dt>
908 <dd>
909 <p>
914 </p>
915 </dd>
917 RFC 2822
918 </dt>
919 <dd>
920 <p>
921 The standard email format as described by RFC 2822, for example
923 </p>
924 </dd>
926 ISO 8601
927 </dt>
928 <dd>
929 <p>
930 Time and date specified by the ISO 8601 standard, for example
933 </p>
935 <table><tr>
938 </td>
941 </tr></table>
942 </div>
943 </dd>
944 </dl></div>
945 </div>
949 your working tree are temporarily stored to a staging area
951 reverted back, only in the index but not in the working tree,
954 this file from participating in the next commit. After building
955 the state to be committed incrementally with these commands,
957 has been staged so far. This is the most basic form of the
958 command. An example:</p></div>
961 <pre><tt>$ edit hello.c
962 $ git rm goodbye.c
963 $ git add hello.c
964 $ git commit</tt></pre>
965 </div></div>
968 contents are tracked in
970 for you. That is, this example does the same as the earlier
971 example if there is no other change in your working tree:</p></div>
974 <pre><tt>$ edit hello.c
975 $ rm goodbye.c
976 $ git commit -a</tt></pre>
977 </div></div>
979 notices that you have modified hello.c and removed goodbye.c,
983 When pathnames are given, the command makes a commit that
984 only records the changes made to the named paths:</p></div>
987 <pre><tt>$ edit hello.c hello.h
988 $ git add hello.c hello.h
989 $ edit Makefile
990 $ git commit Makefile</tt></pre>
991 </div></div>
992 <div class="paragraph"><p>This makes a commit that records the modification to <tt>Makefile</tt>.
994 in the resulting commit. However, their changes are not lost — they are still staged and merely held back. After the above
995 sequence, if you do:</p></div>
999 </div></div>
1002 <div class="paragraph"><p>After a merge (initiated by <em>git merge</em> or <em>git pull</em>) stops
1003 because of conflicts, cleanly merged
1004 paths are already staged to be committed for you, and paths that
1005 conflicted are left in unmerged state. You would have to first
1007 and after fixing them manually in your working tree, you would
1011 <pre><tt>$ git status | grep unmerged
1012 unmerged: hello.c
1013 $ edit hello.c
1014 $ git add hello.c</tt></pre>
1015 </div></div>
1016 <div class="paragraph"><p>After resolving conflicts and staging the result, <tt>git ls-files -u</tt>
1017 would stop mentioning the conflicted path. When you are done,
1022 </div></div>
1024 option to save typing. One difference is that during a merge
1026 alter the order the changes are committed, because the merge
1027 should be recorded as a single commit. In fact, the command
1029 </div>
1032 <div class="paragraph"><p>Though not required, it’s a good idea to begin the commit message
1033 with a single short (less than 50 character) line summarizing the
1034 change, followed by a blank line and then a more thorough description.
1035 Tools that turn commits into email, for example, use the first line
1036 on the Subject: line and the rest of the commit in the body.</p></div>
1039 <li>
1040 <p>
1041 The pathnames recorded in the index and in the tree objects
1042 are treated as uninterpreted sequences of non-NUL bytes.
1043 What readdir(2) returns are what are recorded and compared
1044 with the data git keeps track of, which in turn are expected
1046 thing as pathname encoding translation.
1047 </p>
1048 </li>
1049 <li>
1050 <p>
1051 The contents of the blob objects are uninterpreted sequences
1052 of bytes. There is no encoding translation at the core
1053 level.
1054 </p>
1055 </li>
1056 <li>
1057 <p>
1058 The commit log messages are uninterpreted sequences of non-NUL
1059 bytes.
1060 </p>
1061 </li>
1062 </ul></div>
1064 in UTF-8, both the core and git Porcelain are designed not to
1065 force UTF-8 on projects. If all participants of a particular
1066 project find it more convenient to use legacy encodings, git
1067 does not forbid it. However, there are a few things to keep in
1068 mind.</p></div>
1070 <li>
1071 <p>
1073 a warning if the commit log message given to it does not look
1074 like a valid UTF-8 string, unless you explicitly say your
1075 project uses a legacy encoding. The way to say this is to
1077 </p>
1080 <pre><tt>[i18n]
1082 </div></div>
1085 help other people who look at them later. Lack of this header
1087 </li>
1088 <li>
1089 <p>
1092 log message into UTF-8 unless otherwise specified. You can
1093 specify the desired output encoding with
1095 </p>
1098 <pre><tt>[i18n]
1100 </div></div>
1103 </li>
1104 </ol></div>
1106 message when a commit is made to force UTF-8 at the commit
1107 object level, because re-coding to UTF-8 is not necessarily a
1108 reversible operation.</p></div>
1109 </div>
1112 <div class="paragraph"><p>The editor used to edit the commit log message will be chosen from the
1113 GIT_EDITOR environment variable, the core.editor configuration variable, the
1114 VISUAL environment variable, or the EDITOR environment variable (in that
1116 </div>
1119 <div class="paragraph"><p>This command can run <tt>commit-msg</tt>, <tt>prepare-commit-msg</tt>, <tt>pre-commit</tt>,
1121 information.</p></div>
1122 </div>
1130 </div>
1134 </div>
1138 </div>
1139 </div>
1140 </body>
1141 </html>