| blob | 8b54d7972b87e33fdcb3f03b989b8e5375960f9d |
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, declare that the
546 authorship of the resulting commit now belongs of the committer.
547 This also renews the author timestamp.
548 </p>
549 </dd>
551 --short
552 </dt>
553 <dd>
554 <p>
555 When doing a dry-run, give the output in the short-format. See
557 </p>
558 </dd>
560 --porcelain
561 </dt>
562 <dd>
563 <p>
564 When doing a dry-run, give the output in a porcelain-ready
567 </p>
568 </dd>
570 -z
571 </dt>
572 <dd>
573 <p>
575 entries in the status output with NUL, instead of LF. If no
577 </p>
578 </dd>
581 </dt>
584 </dt>
585 <dd>
586 <p>
588 read the message from the standard input.
589 </p>
590 </dd>
593 </dt>
594 <dd>
595 <p>
596 Override the commit author. Specify an explicit author using the
597 standard <tt>A U Thor <<a href="mailto:author@example.com">author@example.com</a>></tt> format. Otherwise <author>
598 is assumed to be a pattern and is used to search for an existing
600 the commit author is then copied from the first such commit found.
601 </p>
602 </dd>
605 </dt>
606 <dd>
607 <p>
608 Override the author date used in the commit.
609 </p>
610 </dd>
613 </dt>
616 </dt>
617 <dd>
618 <p>
620 </p>
621 </dd>
624 </dt>
627 </dt>
628 <dd>
629 <p>
630 Use the contents of the given file as the initial version
631 of the commit message. The editor is invoked and you can
632 make subsequent changes. If a message is specified using
635 </p>
636 </dd>
638 -s
639 </dt>
641 --signoff
642 </dt>
643 <dd>
644 <p>
645 Add Signed-off-by line by the committer at the end of the commit
646 log message.
647 </p>
648 </dd>
650 -n
651 </dt>
653 --no-verify
654 </dt>
655 <dd>
656 <p>
657 This option bypasses the pre-commit and commit-msg hooks.
659 </p>
660 </dd>
662 --allow-empty
663 </dt>
664 <dd>
665 <p>
666 Usually recording a commit that has the exact same tree as its
667 sole parent commit is a mistake, and the command prevents you
668 from making such a commit. This option bypasses the safety, and
669 is primarily for use by foreign SCM interface scripts.
670 </p>
671 </dd>
673 --allow-empty-message
674 </dt>
675 <dd>
676 <p>
677 Like --allow-empty this command is primarily for use by foreign
678 SCM interface scripts. It allows you to create a commit with an
679 empty commit message without using plumbing commands like
681 </p>
682 </dd>
685 </dt>
686 <dd>
687 <p>
688 This option sets how the commit message is cleaned up.
691 trailing empty lines and #commentary from the commit message
692 only if the message is to be edited. Otherwise only whitespace
696 </p>
697 </dd>
699 -e
700 </dt>
702 --edit
703 </dt>
704 <dd>
705 <p>
708 commit log message unmodified. This option lets you
709 further edit the message taken from these sources.
710 </p>
711 </dd>
713 --amend
714 </dt>
715 <dd>
716 <p>
717 Used to amend the tip of the current branch. Prepare the tree
718 object you would want to replace the latest commit as usual
719 (this includes the usual -i/-o and explicit paths), and the
720 commit log editor is seeded with the commit message from the
721 tip of the current branch. The commit you create replaces the
722 current tip — if it was a merge, it will have the parents of
723 the current tip as parents — so the current top commit is
724 discarded.
725 </p>
729 <pre><tt> $ git reset --soft HEAD^
730 $ ... do something else to come up with the right tree ...
731 $ git commit -c ORIG_HEAD</tt></pre>
732 </div></div>
735 amend a commit that has already been published. (See the "RECOVERING
737 </dd>
739 -i
740 </dt>
742 --include
743 </dt>
744 <dd>
745 <p>
746 Before making a commit out of staged contents so far,
747 stage the contents of paths given on the command line
748 as well. This is usually not what you want unless you
749 are concluding a conflicted merge.
750 </p>
751 </dd>
753 -o
754 </dt>
756 --only
757 </dt>
758 <dd>
759 <p>
760 Make a commit only from the paths specified on the
761 command line, disregarding any contents that have been
762 staged so far. This is the default mode of operation of
764 in which case this option can be omitted.
766 no paths need to be specified, which can be used to amend
767 the last commit without committing changes that have
768 already been staged.
769 </p>
770 </dd>
773 </dt>
776 </dt>
777 <dd>
778 <p>
780 </p>
782 the handling of untracked files.</p></div>
785 <li>
786 <p>
788 </p>
789 </li>
790 <li>
791 <p>
793 </p>
794 </li>
795 <li>
796 <p>
798 </p>
799 <div class="paragraph"><p>See <a href="git-config.html">git-config(1)</a> for configuration variable
800 used to change the default for when the option is not
801 specified.</p></div>
802 </li>
803 </ul></div>
804 </dd>
806 -v
807 </dt>
809 --verbose
810 </dt>
811 <dd>
812 <p>
813 Show unified diff between the HEAD commit and what
814 would be committed at the bottom of the commit message
815 template. Note that this diff output doesn’t have its
817 </p>
818 </dd>
820 -q
821 </dt>
823 --quiet
824 </dt>
825 <dd>
826 <p>
827 Suppress commit summary message.
828 </p>
829 </dd>
831 --dry-run
832 </dt>
833 <dd>
834 <p>
835 Do not create a commit, but show a list of paths that are
836 to be committed, paths with local changes that will be left
837 uncommitted and paths that are untracked.
838 </p>
839 </dd>
841 --status
842 </dt>
843 <dd>
844 <p>
846 message template when using an editor to prepare the commit
847 message. Defaults to on, but can be used to override
848 configuration variable commit.status.
849 </p>
850 </dd>
852 --no-status
853 </dt>
854 <dd>
855 <p>
857 commit message template when using an editor to prepare the
858 default commit message.
859 </p>
860 </dd>
862 --
863 </dt>
864 <dd>
865 <p>
866 Do not interpret any more arguments as options.
867 </p>
868 </dd>
871 </dt>
872 <dd>
873 <p>
874 When files are given on the command line, the command
875 commits the contents of the named files, without
876 recording the changes already staged. The contents of
877 these files are also staged for the next commit on top
878 of what have been staged before.
879 </p>
880 </dd>
881 </dl></div>
882 </div>
887 support the following date formats:</p></div>
890 Git internal format
891 </dt>
892 <dd>
893 <p>
898 </p>
899 </dd>
901 RFC 2822
902 </dt>
903 <dd>
904 <p>
905 The standard email format as described by RFC 2822, for example
907 </p>
908 </dd>
910 ISO 8601
911 </dt>
912 <dd>
913 <p>
914 Time and date specified by the ISO 8601 standard, for example
917 </p>
919 <table><tr>
922 </td>
925 </tr></table>
926 </div>
927 </dd>
928 </dl></div>
929 </div>
933 your working tree are temporarily stored to a staging area
935 reverted back, only in the index but not in the working tree,
938 this file from participating in the next commit. After building
939 the state to be committed incrementally with these commands,
941 has been staged so far. This is the most basic form of the
942 command. An example:</p></div>
945 <pre><tt>$ edit hello.c
946 $ git rm goodbye.c
947 $ git add hello.c
948 $ git commit</tt></pre>
949 </div></div>
952 contents are tracked in
954 for you. That is, this example does the same as the earlier
955 example if there is no other change in your working tree:</p></div>
958 <pre><tt>$ edit hello.c
959 $ rm goodbye.c
960 $ git commit -a</tt></pre>
961 </div></div>
963 notices that you have modified hello.c and removed goodbye.c,
967 When pathnames are given, the command makes a commit that
968 only records the changes made to the named paths:</p></div>
971 <pre><tt>$ edit hello.c hello.h
972 $ git add hello.c hello.h
973 $ edit Makefile
974 $ git commit Makefile</tt></pre>
975 </div></div>
976 <div class="paragraph"><p>This makes a commit that records the modification to <tt>Makefile</tt>.
978 in the resulting commit. However, their changes are not lost — they are still staged and merely held back. After the above
979 sequence, if you do:</p></div>
983 </div></div>
986 <div class="paragraph"><p>After a merge (initiated by <em>git merge</em> or <em>git pull</em>) stops
987 because of conflicts, cleanly merged
988 paths are already staged to be committed for you, and paths that
989 conflicted are left in unmerged state. You would have to first
991 and after fixing them manually in your working tree, you would
995 <pre><tt>$ git status | grep unmerged
996 unmerged: hello.c
997 $ edit hello.c
998 $ git add hello.c</tt></pre>
999 </div></div>
1000 <div class="paragraph"><p>After resolving conflicts and staging the result, <tt>git ls-files -u</tt>
1001 would stop mentioning the conflicted path. When you are done,
1006 </div></div>
1008 option to save typing. One difference is that during a merge
1010 alter the order the changes are committed, because the merge
1011 should be recorded as a single commit. In fact, the command
1013 </div>
1016 <div class="paragraph"><p>Though not required, it’s a good idea to begin the commit message
1017 with a single short (less than 50 character) line summarizing the
1018 change, followed by a blank line and then a more thorough description.
1019 Tools that turn commits into email, for example, use the first line
1020 on the Subject: line and the rest of the commit in the body.</p></div>
1023 <li>
1024 <p>
1025 The pathnames recorded in the index and in the tree objects
1026 are treated as uninterpreted sequences of non-NUL bytes.
1027 What readdir(2) returns are what are recorded and compared
1028 with the data git keeps track of, which in turn are expected
1030 thing as pathname encoding translation.
1031 </p>
1032 </li>
1033 <li>
1034 <p>
1035 The contents of the blob objects are uninterpreted sequences
1036 of bytes. There is no encoding translation at the core
1037 level.
1038 </p>
1039 </li>
1040 <li>
1041 <p>
1042 The commit log messages are uninterpreted sequences of non-NUL
1043 bytes.
1044 </p>
1045 </li>
1046 </ul></div>
1048 in UTF-8, both the core and git Porcelain are designed not to
1049 force UTF-8 on projects. If all participants of a particular
1050 project find it more convenient to use legacy encodings, git
1051 does not forbid it. However, there are a few things to keep in
1052 mind.</p></div>
1054 <li>
1055 <p>
1057 a warning if the commit log message given to it does not look
1058 like a valid UTF-8 string, unless you explicitly say your
1059 project uses a legacy encoding. The way to say this is to
1061 </p>
1064 <pre><tt>[i18n]
1066 </div></div>
1069 help other people who look at them later. Lack of this header
1071 </li>
1072 <li>
1073 <p>
1076 log message into UTF-8 unless otherwise specified. You can
1077 specify the desired output encoding with
1079 </p>
1082 <pre><tt>[i18n]
1084 </div></div>
1087 </li>
1088 </ol></div>
1090 message when a commit is made to force UTF-8 at the commit
1091 object level, because re-coding to UTF-8 is not necessarily a
1092 reversible operation.</p></div>
1093 </div>
1096 <div class="paragraph"><p>The editor used to edit the commit log message will be chosen from the
1097 GIT_EDITOR environment variable, the core.editor configuration variable, the
1098 VISUAL environment variable, or the EDITOR environment variable (in that
1100 </div>
1103 <div class="paragraph"><p>This command can run <tt>commit-msg</tt>, <tt>prepare-commit-msg</tt>, <tt>pre-commit</tt>,
1105 information.</p></div>
1106 </div>
1114 </div>
1117 <div class="paragraph"><p>Written by Linus Torvalds <<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>> and
1119 </div>
1123 </div>
1127 </div>
1128 </div>
1129 </body>
1130 </html>