| blob | 24bf5fd2534e610c31439523866108ae7e48f8b1 |
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-submodule(1) Manual Page
407 </h1>
410 <p>git-submodule -
411 Initialize, update or inspect submodules
412 </p>
413 </div>
414 </div>
424 <em>git submodule</em> [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>…]
428 </div></div>
429 </div>
433 a dedicated subdirectory of the source tree, always pointed
434 at a particular commit.</p></div>
436 for branches of the same project; submodules are meant for
437 different projects you would like to make part of your source tree,
438 while the history of the two projects still stays completely
439 independent and you cannot modify the contents of the submodule
440 from within the main project.
441 If you want to merge the project histories and want to treat the
442 aggregated whole as a single project from then on, you may want to
444 instead of treating the other project as a submodule. Directories
445 that come from both projects can be cloned and checked out as a whole
446 if you choose to go that route.</p></div>
448 in the main repository that refers to a particular commit object
449 within the inner repository that is completely separate.
451 tree assigns a logical name to the submodule and describes
452 the default URL the submodule shall be cloned from.
453 The logical name can be used for overriding this URL within your
456 gitmodules file for you, as well as inspect the status of your
457 submodules and update them.
459 is to be used. However, when pulling a tree containing submodules,
460 these will not be checked out by default;
462 checked out and at appropriate revision in your working tree.
463 You can briefly inspect the up-to-date status of your submodules
466 subcommand.</p></div>
467 </div>
472 add
473 </dt>
474 <dd>
475 <p>
476 Add the given repository as a submodule at the given path
477 to the changeset to be committed next to the current
478 project: the current project is termed the "superproject".
479 </p>
485 <div class="paragraph"><p><repository> is the URL of the new submodule’s origin repository.
486 This may be either an absolute URL, or (if it begins with ./
487 or ../), the location relative to the superproject’s origin
488 repository. If the superproject doesn’t have an origin configured
489 the superproject is its own authoritative upstream and the current
490 working directory is used instead.</p></div>
494 exist and is already a valid git repository, then this is added
495 to the changeset without cloning. This second form is provided
496 to ease creating a new submodule from scratch, and presumes
497 the user will later push the submodule to the given URL.</p></div>
499 use by subsequent users cloning the superproject. If the URL is
500 given relative to the superproject’s repository, the presumption
501 is the superproject and submodule repositories will be kept
502 together in the same relative location, and only the
503 superproject’s URL needs to be provided: git-submodule will correctly
504 locate the submodule using the relative URL in .gitmodules.</p></div>
505 </dd>
507 status
508 </dt>
509 <dd>
510 <p>
511 Show the status of the submodules. This will print the SHA-1 of the
512 currently checked out commit for each submodule, along with the
516 does not match the SHA-1 found in the index of the containing
519 </p>
520 <div class="paragraph"><p>If <em>--recursive</em> is specified, this command will recurse into nested
521 submodules, and show their status as well.</p></div>
522 </dd>
524 init
525 </dt>
526 <dd>
527 <p>
528 Initialize the submodules, i.e. register each submodule name
529 and url found in .gitmodules into .git/config.
531 This command does not alter existing information in .git/config.
532 You can then customize the submodule clone URLs in .git/config
536 any submodule locations.
537 </p>
538 </dd>
540 update
541 </dt>
542 <dd>
543 <p>
544 Update the registered submodules, i.e. clone missing submodules and
545 checkout the commit specified in the index of the containing repository.
549 </p>
551 setting as stored in .gitmodules, you can automatically initialize the
552 submodule with the --init option.</p></div>
553 <div class="paragraph"><p>If <em>--recursive</em> is specified, this command will recurse into the
554 registered submodules, and update any nested submodules within.</p></div>
555 </dd>
557 summary
558 </dt>
559 <dd>
560 <p>
561 Show commit summary between the given commit (defaults to HEAD) and
562 working tree/index. For a submodule in question, a series of commits
563 in the submodule between the given super project commit and the
564 index or working tree (switched by --cached) are shown. If the option
565 --files is given, show the series of commits in the submodule between
566 the index of the super project and the working tree of the submodule
567 (this option doesn’t allow to use the --cached option or to provide an
568 explicit commit).
569 </p>
570 </dd>
572 foreach
573 </dt>
574 <dd>
575 <p>
576 Evaluates an arbitrary shell command in each checked out submodule.
577 The command has access to the variables $name, $path, $sha1 and
578 $toplevel:
579 $name is the name of the relevant submodule section in .gitmodules,
580 $path is the name of the submodule directory relative to the
581 superproject, $sha1 is the commit as recorded in the superproject,
582 and $toplevel is the absolute path to the top-level of the superproject.
583 Any submodules defined in the superproject but not checked out are
584 ignored by this command. Unless given --quiet, foreach prints the name
585 of each submodule before evaluating the command.
586 If --recursive is given, submodules are traversed recursively (i.e.
587 the given shell command is evaluated in nested submodules as well).
588 A non-zero return from the command in any submodule causes
590 to the end of the command.
591 </p>
594 commit for each submodule.</p></div>
595 </dd>
597 sync
598 </dt>
599 <dd>
600 <p>
601 Synchronizes submodules' remote URL configuration setting
602 to the value specified in .gitmodules. It will only affect those
603 submodules which already have an url entry in .git/config (that is the
604 case when they are initialized or freshly added). This is useful when
605 submodule URLs change upstream and you need to update your local
606 repositories accordingly.
607 </p>
610 </dd>
611 </dl></div>
612 </div>
617 -q
618 </dt>
620 --quiet
621 </dt>
622 <dd>
623 <p>
624 Only print error messages.
625 </p>
626 </dd>
628 -b
629 </dt>
631 --branch
632 </dt>
633 <dd>
634 <p>
635 Branch of repository to add as submodule.
636 </p>
637 </dd>
639 -f
640 </dt>
642 --force
643 </dt>
644 <dd>
645 <p>
646 This option is only valid for add and update commands.
647 When running add, allow adding an otherwise ignored submodule path.
648 When running update, throw away local changes in submodules when
649 switching to a different commit.
650 </p>
651 </dd>
653 --cached
654 </dt>
655 <dd>
656 <p>
657 This option is only valid for status and summary commands. These
658 commands typically use the commit found in the submodule HEAD, but
659 with this option, the commit stored in the index is used instead.
660 </p>
661 </dd>
663 --files
664 </dt>
665 <dd>
666 <p>
667 This option is only valid for the summary command. This command
668 compares the commit in the index with that in the submodule HEAD
669 when this option is used.
670 </p>
671 </dd>
673 -n
674 </dt>
676 --summary-limit
677 </dt>
678 <dd>
679 <p>
680 This option is only valid for the summary command.
681 Limit the summary size (number of commits shown in total).
682 Giving 0 will disable the summary; a negative number means unlimited
683 (the default). This limit only applies to modified submodules. The
684 size is always limited to 1 for added/deleted/typechanged submodules.
685 </p>
686 </dd>
688 -N
689 </dt>
691 --no-fetch
692 </dt>
693 <dd>
694 <p>
695 This option is only valid for the update command.
696 Don’t fetch new objects from the remote site.
697 </p>
698 </dd>
700 --merge
701 </dt>
702 <dd>
703 <p>
704 This option is only valid for the update command.
705 Merge the commit recorded in the superproject into the current branch
706 of the submodule. If this option is given, the submodule’s HEAD will
707 not be detached. If a merge failure prevents this process, you will
708 have to resolve the resulting conflicts within the submodule with the
709 usual conflict resolution tools.
711 implicit.
712 </p>
713 </dd>
715 --rebase
716 </dt>
717 <dd>
718 <p>
719 This option is only valid for the update command.
720 Rebase the current branch onto the commit recorded in the
721 superproject. If this option is given, the submodule’s HEAD will not
722 be detached. If a merge failure prevents this process, you will have
725 implicit.
726 </p>
727 </dd>
730 </dt>
731 <dd>
732 <p>
733 This option is only valid for add and update commands. These
734 commands sometimes need to clone a remote repository. In this case,
736 </p>
737 <div class="paragraph"><p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note
738 for <a href="git-clone.html">git-clone(1)</a>'s --reference and --shared options carefully.</p></div>
739 </dd>
741 --recursive
742 </dt>
743 <dd>
744 <p>
745 This option is only valid for foreach, update and status commands.
746 Traverse submodules recursively. The operation is performed not
747 only in the submodules of the current repo, but also
748 in any nested submodules inside those submodules (and so on).
749 </p>
750 </dd>
753 </dt>
754 <dd>
755 <p>
756 Paths to submodule(s). When specified this will restrict the command
757 to only operate on the submodules found at the specified paths.
758 (This argument is required with add).
759 </p>
760 </dd>
761 </dl></div>
762 </div>
765 <div class="paragraph"><p>When initializing submodules, a .gitmodules file in the top-level directory
766 of the containing repository is used to find the url of each submodule.
769 for details.</p></div>
770 </div>
774 </div>
778 </div>
779 </div>
780 </body>
781 </html>