X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-submodule.txt;h=e818e6e7895a94af0b05f04d2c8ecdae64583efd;hb=9225d7be0abab0c3b1325a733aea127b45a18625;hp=335e973a6a1d5350c1558eb68985ffe812c09212;hpb=2e13e5d89252ceef606a0a7be32dbf5bea7e5aca;p=git.git diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 335e973a6..e818e6e78 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -9,8 +9,9 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- [verse] -'git-submodule' [--quiet] [-b branch] add [] -'git-submodule' [--quiet] [--cached] [status|init|update] [--] [...] +'git-submodule' [--quiet] add [-b branch] [--] [] +'git-submodule' [--quiet] status [--cached] [--] [...] +'git-submodule' [--quiet] [init|update] [--] [...] COMMANDS @@ -28,7 +29,7 @@ add:: status:: Show the status of the submodules. This will print the SHA-1 of the currently checked out commit for each submodule, along with the - submodule path and the output of gitlink:git-describe[1] for the + submodule path and the output of linkgit:git-describe[1] for the SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not initialized and `+` if the currently checked out submodule commit does not match the SHA-1 found in the index of the containing @@ -67,8 +68,9 @@ FILES ----- When initializing submodules, a .gitmodules file in the top-level directory of the containing repository is used to find the url of each submodule. -This file should be formatted in the same way as $GIR_DIR/config. The key -to each submodule url is "submodule.$name.url". +This file should be formatted in the same way as `$GIT_DIR/config`. The key +to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] +for details. AUTHOR @@ -77,4 +79,4 @@ Written by Lars Hjemli GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite