]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Merge branch 'km/submodule-doc-use-sm-path'
authorJunio C Hamano <gitster@pobox.com>
Wed, 12 Feb 2020 20:41:37 +0000 (12:41 -0800)
committerJunio C Hamano <gitster@pobox.com>
Wed, 12 Feb 2020 20:41:37 +0000 (12:41 -0800)
Docfix.

* km/submodule-doc-use-sm-path:
  submodule foreach: replace $path with $sm_path in example

1  2 
Documentation/git-submodule.txt

index 5232407f68331618e5c509b91aef30ce6c6dbecd,fbcc455cae77f858a7a3350a9b15c68c456fc46d..218942acd11ffff39230a71617d119d323795299
@@@ -16,7 -16,6 +16,7 @@@ SYNOPSI
  'git submodule' [--quiet] deinit [-f|--force] (--all|[--] <path>...)
  'git submodule' [--quiet] update [<options>] [--] [<path>...]
  'git submodule' [--quiet] set-branch [<options>] [--] <path>
 +'git submodule' [--quiet] set-url [--] <path> <newurl>
  'git submodule' [--quiet] summary [<options>] [--] [<path>...]
  'git submodule' [--quiet] foreach [--recursive] <command>
  'git submodule' [--quiet] sync [--recursive] [--] [<path>...]
@@@ -81,9 -80,6 +81,9 @@@ status [--cached] [--recursive] [--] [<
        does not match the SHA-1 found in the index of the containing
        repository and `U` if the submodule has merge conflicts.
  +
 +If `--cached` is specified, this command will instead print the SHA-1
 +recorded in the superproject for each submodule.
 ++
  If `--recursive` is specified, this command will recurse into nested
  submodules, and show their status as well.
  +
@@@ -137,8 -133,7 +137,8 @@@ update [--init] [--remote] [-N|--no-fet
  +
  --
  Update the registered submodules to match what the superproject
 -expects by cloning missing submodules and updating the working tree of
 +expects by cloning missing submodules, fetching missing commits
 +in submodules and updating the working tree of
  the submodules. The "updating" can be done in several ways depending
  on command line options and the value of `submodule.<name>.update`
  configuration variable. The command line option takes precedence over
@@@ -185,11 -180,6 +185,11 @@@ set-branch (-d|--default) [--] <path>:
        `--default` option removes the submodule.<name>.branch configuration
        key, which causes the tracking branch to default to 'master'.
  
 +set-url [--] <path> <newurl>::
 +      Sets the URL of the specified submodule to <newurl>. Then, it will
 +      automatically synchronize the submodule's new remote URL
 +      configuration.
 +
  summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]::
        Show commit summary between the given commit (defaults to HEAD) and
        working tree/index. For a submodule in question, a series of commits
@@@ -229,7 -219,7 +229,7 @@@ As an example, the command below will s
  checked out commit for each submodule:
  +
  --------------
- git submodule foreach 'echo $path `git rev-parse HEAD`'
+ git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
  --------------
  
  sync [--recursive] [--] [<path>...]::
@@@ -248,7 -238,7 +248,7 @@@ registered submodules, and sync any nes
  
  absorbgitdirs::
        If a git directory of a submodule is inside the submodule,
 -      move the git directory of the submodule into its superprojects
 +      move the git directory of the submodule into its superproject's
        `$GIT_DIR/modules` path and then connect the git directory and
        its working directory by setting the `core.worktree` and adding
        a .git file pointing to the git directory embedded in the