| blob | 8bfcd32a42ab70da1ce2e77e06a79eb62efbc88c |
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 }
129 }
133 }
135 /* Block element titles. */
143 }
146 }
150 }
153 }
156 }
162 }
168 }
176 }
181 }
185 }
189 }
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
193 }
202 }
206 }
211 }
217 dl {
220 }
221 dt {
226 }
229 }
233 }
236 }
239 }
242 }
245 }
248 }
255 }
259 }
263 }
264 tfoot {
266 }
269 }
272 }
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
276 }
280 }
284 }
290 }
293 }
296 }
302 }
305 }
309 }
313 }
317 }
321 }
326 }
330 }
340 }
345 }
347 div#toc {
349 }
351 div#toctitle {
358 }
363 }
367 }
371 }
375 }
376 /* Overrides for manpage documents */
377 h1 {
382 }
383 h2 {
385 }
388 }
392 }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
400 }
407 }
413 }
418 }
422 }
426 }
431 }
433 /* IE6 sets dynamically generated links as visited. */
435 </style>
437 /*<![CDATA[*/
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
468 }
470 }
476 }
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
490 }
492 }
493 }
494 }
497 }
512 }
515 },
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
547 }
548 }
552 // Process footnoterefs.
561 }
562 }
563 }
564 }
566 }
567 /*]]>*/
568 </script>
569 </head>
570 <body>
572 <h1>
573 git-submodule(1) Manual Page
574 </h1>
577 <p>git-submodule -
578 Initialize, update or inspect submodules
579 </p>
580 </div>
581 </div>
597 </div></div>
598 </div>
602 a dedicated subdirectory of the source tree, always pointed
603 at a particular commit.</p></div>
605 for branches of the same project; submodules are meant for
606 different projects you would like to make part of your source tree,
607 while the history of the two projects still stays completely
608 independent and you cannot modify the contents of the submodule
609 from within the main project.
610 If you want to merge the project histories and want to treat the
611 aggregated whole as a single project from then on, you may want to
613 instead of treating the other project as a submodule. Directories
614 that come from both projects can be cloned and checked out as a whole
615 if you choose to go that route.</p></div>
617 in the main repository that refers to a particular commit object
618 within the inner repository that is completely separate.
620 tree assigns a logical name to the submodule and describes
621 the default URL the submodule shall be cloned from.
622 The logical name can be used for overriding this URL within your
625 gitmodules file for you, as well as inspect the status of your
626 submodules and update them.
628 is to be used. However, when pulling a tree containing submodules,
629 these will not be checked out by default;
631 checked out and at appropriate revision in your working tree.
632 You can briefly inspect the up-to-date status of your submodules
635 subcommand.</p></div>
636 </div>
641 add
642 </dt>
643 <dd>
644 <p>
645 Add the given repository as a submodule at the given path
646 to the changeset to be committed next to the current
647 project: the current project is termed the "superproject".
648 </p>
654 <div class="paragraph"><p><repository> is the URL of the new submodule’s origin repository.
655 This may be either an absolute URL, or (if it begins with ./
656 or ../), the location relative to the superproject’s origin
657 repository. If the superproject doesn’t have an origin configured
658 the superproject is its own authoritative upstream and the current
659 working directory is used instead.</p></div>
663 exist and is already a valid git repository, then this is added
664 to the changeset without cloning. This second form is provided
665 to ease creating a new submodule from scratch, and presumes
666 the user will later push the submodule to the given URL.</p></div>
668 use by subsequent users cloning the superproject. If the URL is
669 given relative to the superproject’s repository, the presumption
670 is the superproject and submodule repositories will be kept
671 together in the same relative location, and only the
672 superproject’s URL needs to be provided: git-submodule will correctly
673 locate the submodule using the relative URL in .gitmodules.</p></div>
674 </dd>
676 status
677 </dt>
678 <dd>
679 <p>
680 Show the status of the submodules. This will print the SHA-1 of the
681 currently checked out commit for each submodule, along with the
685 does not match the SHA-1 found in the index of the containing
688 </p>
689 <div class="paragraph"><p>If <tt>--recursive</tt> is specified, this command will recurse into nested
690 submodules, and show their status as well.</p></div>
692 submodules with respect to the commit recorded in the index or the HEAD,
693 <a href="git-status.html">git-status(1)</a> and <a href="git-diff.html">git-diff(1)</a> will provide that information
695 </dd>
697 init
698 </dt>
699 <dd>
700 <p>
701 Initialize the submodules, i.e. register each submodule name
702 and url found in .gitmodules into .git/config.
704 .git/config.
706 This command does not alter existing information in .git/config.
707 You can then customize the submodule clone URLs in .git/config
711 any submodule locations.
712 </p>
713 </dd>
715 update
716 </dt>
717 <dd>
718 <p>
719 Update the registered submodules, i.e. clone missing submodules and
720 checkout the commit specified in the index of the containing repository.
724 </p>
726 setting as stored in .gitmodules, you can automatically initialize the
728 <div class="paragraph"><p>If <tt>--recursive</tt> is specified, this command will recurse into the
729 registered submodules, and update any nested submodules within.</p></div>
730 <div class="paragraph"><p>If the configuration key <tt>submodule.$name.update</tt> is set to <tt>none</tt> the
733 </dd>
735 summary
736 </dt>
737 <dd>
738 <p>
739 Show commit summary between the given commit (defaults to HEAD) and
740 working tree/index. For a submodule in question, a series of commits
741 in the submodule between the given super project commit and the
744 the index of the super project and the working tree of the submodule
746 explicit commit).
747 </p>
748 <div class="paragraph"><p>Using the <tt>--submodule=log</tt> option with <a href="git-diff.html">git-diff(1)</a> will provide that
749 information too.</p></div>
750 </dd>
752 foreach
753 </dt>
754 <dd>
755 <p>
756 Evaluates an arbitrary shell command in each checked out submodule.
757 The command has access to the variables $name, $path, $sha1 and
758 $toplevel:
759 $name is the name of the relevant submodule section in .gitmodules,
760 $path is the name of the submodule directory relative to the
761 superproject, $sha1 is the commit as recorded in the superproject,
762 and $toplevel is the absolute path to the top-level of the superproject.
763 Any submodules defined in the superproject but not checked out are
765 of each submodule before evaluating the command.
767 the given shell command is evaluated in nested submodules as well).
768 A non-zero return from the command in any submodule causes
770 to the end of the command.
771 </p>
774 commit for each submodule.</p></div>
775 </dd>
777 sync
778 </dt>
779 <dd>
780 <p>
781 Synchronizes submodules' remote URL configuration setting
782 to the value specified in .gitmodules. It will only affect those
783 submodules which already have an url entry in .git/config (that is the
784 case when they are initialized or freshly added). This is useful when
785 submodule URLs change upstream and you need to update your local
786 repositories accordingly.
787 </p>
790 </dd>
791 </dl></div>
792 </div>
797 -q
798 </dt>
800 --quiet
801 </dt>
802 <dd>
803 <p>
804 Only print error messages.
805 </p>
806 </dd>
808 -b
809 </dt>
811 --branch
812 </dt>
813 <dd>
814 <p>
815 Branch of repository to add as submodule.
816 </p>
817 </dd>
819 -f
820 </dt>
822 --force
823 </dt>
824 <dd>
825 <p>
826 This option is only valid for add and update commands.
827 When running add, allow adding an otherwise ignored submodule path.
828 When running update, throw away local changes in submodules when
829 switching to a different commit.
830 </p>
831 </dd>
833 --cached
834 </dt>
835 <dd>
836 <p>
837 This option is only valid for status and summary commands. These
838 commands typically use the commit found in the submodule HEAD, but
839 with this option, the commit stored in the index is used instead.
840 </p>
841 </dd>
843 --files
844 </dt>
845 <dd>
846 <p>
847 This option is only valid for the summary command. This command
848 compares the commit in the index with that in the submodule HEAD
849 when this option is used.
850 </p>
851 </dd>
853 -n
854 </dt>
856 --summary-limit
857 </dt>
858 <dd>
859 <p>
860 This option is only valid for the summary command.
861 Limit the summary size (number of commits shown in total).
862 Giving 0 will disable the summary; a negative number means unlimited
863 (the default). This limit only applies to modified submodules. The
864 size is always limited to 1 for added/deleted/typechanged submodules.
865 </p>
866 </dd>
868 -N
869 </dt>
871 --no-fetch
872 </dt>
873 <dd>
874 <p>
875 This option is only valid for the update command.
876 Don’t fetch new objects from the remote site.
877 </p>
878 </dd>
880 --merge
881 </dt>
882 <dd>
883 <p>
884 This option is only valid for the update command.
885 Merge the commit recorded in the superproject into the current branch
886 of the submodule. If this option is given, the submodule’s HEAD will
887 not be detached. If a merge failure prevents this process, you will
888 have to resolve the resulting conflicts within the submodule with the
889 usual conflict resolution tools.
891 implicit.
892 </p>
893 </dd>
895 --rebase
896 </dt>
897 <dd>
898 <p>
899 This option is only valid for the update command.
900 Rebase the current branch onto the commit recorded in the
901 superproject. If this option is given, the submodule’s HEAD will not
902 be detached. If a merge failure prevents this process, you will have
905 implicit.
906 </p>
907 </dd>
909 --init
910 </dt>
911 <dd>
912 <p>
913 This option is only valid for the update command.
914 Initialize all submodules for which "git submodule init" has not been
915 called so far before updating.
916 </p>
917 </dd>
920 </dt>
921 <dd>
922 <p>
923 This option is only valid for add and update commands. These
924 commands sometimes need to clone a remote repository. In this case,
926 </p>
927 <div class="paragraph"><p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note
928 for <a href="git-clone.html">git-clone(1)</a>'s <tt>--reference</tt> and <tt>--shared</tt> options carefully.</p></div>
929 </dd>
931 --recursive
932 </dt>
933 <dd>
934 <p>
935 This option is only valid for foreach, update and status commands.
936 Traverse submodules recursively. The operation is performed not
937 only in the submodules of the current repo, but also
938 in any nested submodules inside those submodules (and so on).
939 </p>
940 </dd>
943 </dt>
944 <dd>
945 <p>
946 Paths to submodule(s). When specified this will restrict the command
947 to only operate on the submodules found at the specified paths.
948 (This argument is required with add).
949 </p>
950 </dd>
951 </dl></div>
952 </div>
955 <div class="paragraph"><p>When initializing submodules, a .gitmodules file in the top-level directory
956 of the containing repository is used to find the url of each submodule.
959 for details.</p></div>
960 </div>
964 </div>
965 </div>
970 </div>
971 </div>
972 </body>
973 </html>