| blob | 714027cfcb9bdcff833b49bef28f0e69f178559a |
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.</p></div>
492 exist and is already a valid git repository, then this is added
493 to the changeset without cloning. This second form is provided
494 to ease creating a new submodule from scratch, and presumes
495 the user will later push the submodule to the given URL.</p></div>
497 use by subsequent users cloning the superproject. If the URL is
498 given relative to the superproject’s repository, the presumption
499 is the superproject and submodule repositories will be kept
500 together in the same relative location, and only the
501 superproject’s URL needs to be provided: git-submodule will correctly
502 locate the submodule using the relative URL in .gitmodules.</p></div>
503 </dd>
505 status
506 </dt>
507 <dd>
508 <p>
509 Show the status of the submodules. This will print the SHA-1 of the
510 currently checked out commit for each submodule, along with the
514 does not match the SHA-1 found in the index of the containing
516 </p>
517 <div class="paragraph"><p>If <em>--recursive</em> is specified, this command will recurse into nested
518 submodules, and show their status as well.</p></div>
519 </dd>
521 init
522 </dt>
523 <dd>
524 <p>
525 Initialize the submodules, i.e. register each submodule name
526 and url found in .gitmodules into .git/config.
528 This command does not alter existing information in .git/config.
529 You can then customize the submodule clone URLs in .git/config
533 any submodule locations.
534 </p>
535 </dd>
537 update
538 </dt>
539 <dd>
540 <p>
541 Update the registered submodules, i.e. clone missing submodules and
542 checkout the commit specified in the index of the containing repository.
546 </p>
548 setting as stored in .gitmodules, you can automatically initialize the
549 submodule with the --init option.</p></div>
550 <div class="paragraph"><p>If <em>--recursive</em> is specified, this command will recurse into the
551 registered submodules, and update any nested submodules within.</p></div>
552 </dd>
554 summary
555 </dt>
556 <dd>
557 <p>
558 Show commit summary between the given commit (defaults to HEAD) and
559 working tree/index. For a submodule in question, a series of commits
560 in the submodule between the given super project commit and the
561 index or working tree (switched by --cached) are shown. If the option
562 --files is given, show the series of commits in the submodule between
563 the index of the super project and the working tree of the submodule
564 (this option doesn’t allow to use the --cached option or to provide an
565 explicit commit).
566 </p>
567 </dd>
569 foreach
570 </dt>
571 <dd>
572 <p>
573 Evaluates an arbitrary shell command in each checked out submodule.
574 The command has access to the variables $name, $path, $sha1 and
575 $toplevel:
576 $name is the name of the relevant submodule section in .gitmodules,
577 $path is the name of the submodule directory relative to the
578 superproject, $sha1 is the commit as recorded in the superproject,
579 and $toplevel is the absolute path to the top-level of the superproject.
580 Any submodules defined in the superproject but not checked out are
581 ignored by this command. Unless given --quiet, foreach prints the name
582 of each submodule before evaluating the command.
583 If --recursive is given, submodules are traversed recursively (i.e.
584 the given shell command is evaluated in nested submodules as well).
585 A non-zero return from the command in any submodule causes
587 to the end of the command.
588 </p>
591 commit for each submodule.</p></div>
592 </dd>
594 sync
595 </dt>
596 <dd>
597 <p>
598 Synchronizes submodules' remote URL configuration setting
599 to the value specified in .gitmodules. This is useful when
600 submodule URLs change upstream and you need to update your local
601 repositories accordingly.
602 </p>
605 </dd>
606 </dl></div>
607 </div>
612 -q
613 </dt>
615 --quiet
616 </dt>
617 <dd>
618 <p>
619 Only print error messages.
620 </p>
621 </dd>
623 -b
624 </dt>
626 --branch
627 </dt>
628 <dd>
629 <p>
630 Branch of repository to add as submodule.
631 </p>
632 </dd>
634 -f
635 </dt>
637 --force
638 </dt>
639 <dd>
640 <p>
641 This option is only valid for the add command.
642 Allow adding an otherwise ignored submodule path.
643 </p>
644 </dd>
646 --cached
647 </dt>
648 <dd>
649 <p>
650 This option is only valid for status and summary commands. These
651 commands typically use the commit found in the submodule HEAD, but
652 with this option, the commit stored in the index is used instead.
653 </p>
654 </dd>
656 --files
657 </dt>
658 <dd>
659 <p>
660 This option is only valid for the summary command. This command
661 compares the commit in the index with that in the submodule HEAD
662 when this option is used.
663 </p>
664 </dd>
666 -n
667 </dt>
669 --summary-limit
670 </dt>
671 <dd>
672 <p>
673 This option is only valid for the summary command.
674 Limit the summary size (number of commits shown in total).
675 Giving 0 will disable the summary; a negative number means unlimited
676 (the default). This limit only applies to modified submodules. The
677 size is always limited to 1 for added/deleted/typechanged submodules.
678 </p>
679 </dd>
681 -N
682 </dt>
684 --no-fetch
685 </dt>
686 <dd>
687 <p>
688 This option is only valid for the update command.
689 Don’t fetch new objects from the remote site.
690 </p>
691 </dd>
693 --merge
694 </dt>
695 <dd>
696 <p>
697 This option is only valid for the update command.
698 Merge the commit recorded in the superproject into the current branch
699 of the submodule. If this option is given, the submodule’s HEAD will
700 not be detached. If a merge failure prevents this process, you will
701 have to resolve the resulting conflicts within the submodule with the
702 usual conflict resolution tools.
704 implicit.
705 </p>
706 </dd>
708 --rebase
709 </dt>
710 <dd>
711 <p>
712 This option is only valid for the update command.
713 Rebase the current branch onto the commit recorded in the
714 superproject. If this option is given, the submodule’s HEAD will not
715 be detached. If a merge failure prevents this process, you will have
718 implicit.
719 </p>
720 </dd>
723 </dt>
724 <dd>
725 <p>
726 This option is only valid for add and update commands. These
727 commands sometimes need to clone a remote repository. In this case,
729 </p>
730 <div class="paragraph"><p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note
731 for <a href="git-clone.html">git-clone(1)</a>'s --reference and --shared options carefully.</p></div>
732 </dd>
734 --recursive
735 </dt>
736 <dd>
737 <p>
738 This option is only valid for foreach, update and status commands.
739 Traverse submodules recursively. The operation is performed not
740 only in the submodules of the current repo, but also
741 in any nested submodules inside those submodules (and so on).
742 </p>
743 </dd>
746 </dt>
747 <dd>
748 <p>
749 Paths to submodule(s). When specified this will restrict the command
750 to only operate on the submodules found at the specified paths.
751 (This argument is required with add).
752 </p>
753 </dd>
754 </dl></div>
755 </div>
758 <div class="paragraph"><p>When initializing submodules, a .gitmodules file in the top-level directory
759 of the containing repository is used to find the url of each submodule.
762 for details.</p></div>
763 </div>
766 <div class="paragraph"><p>Written by Lars Hjemli <<a href="mailto:hjemli@gmail.com">hjemli@gmail.com</a>></p></div>
767 </div>
771 </div>
775 </div>
776 </div>
777 </body>
778 </html>