git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] Documentation/submodule: Fix submodule.<name> -> .<path> typos

From
W. Trevor King <wking@tremily.us>
Date
Mar 27, 2014, 21:06 UTC
Message-ID
<f86f6b48f1c840d50d00c591a296821e0a18ee0d.1395954229.git.wking@tremily.us>

The transition from submodule.<path>.* to submodule.<name>.* happened in 73b0898d (Teach "git submodule add" the --name option, 2012-09-30), which landed in v1.8.1-rc0 on 2012-12-03. The first submodule.<path>.branch reference landed a short time later in b9289227 (submodule add: If --branch is given, record it in .gitmodules, 2012-12-19), and I was probably just not aware of 73b0898d. The second submodule.<path>.branch reference landed in 23d25e48 (submodule: explicit local branch creation in module_clone, 2014-01-26), and is just a copy paste error. This commit updates both references to the current submodule.<name>.branch.

Reported-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: W. Trevor King <wking@tremily.us>
---
This patch is against master, because 23d25e48 hasn't landed in maint
yet.  If you want, I can split this into two patches, one against
maint fixing the b9289227 typo and another against master fixing the
23d25e48 typo.
 Documentation/git-submodule.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 46c1eeb..77588b0 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -162,7 +162,7 @@ update::
 +
 For updates that clone missing submodules, checkout-mode updates will
 create submodules with detached HEADs; all other modes will create
-submodules with a local branch named after `submodule.<path>.branch`.
+submodules with a local branch named after `submodule.<name>.branch`.
 +
 For updates that do not clone missing submodules, the submodule's HEAD
 is only touched when the remote reference does not match the
@@ -247,7 +247,7 @@ OPTIONS
 -b::
 --branch::
 	Branch of repository to add as submodule.
-	The name of the branch is recorded as `submodule.<path>.branch` in
+	The name of the branch is recorded as `submodule.<name>.branch` in
 	`.gitmodules` for `update --remote`.
 
 -f::
-- 
1.9.1.352.gd393d14.dirty
Next: Jens Lehmann
Message 1 of 5 in “Documentation/submodule: Fix submodule.<name> -> .<path> typos”
  1. Documentation/submodule: Fix submodule.<name> -> .<path> typosW. Trevor King, Mar 27, 2014
  2. Jens LehmannMar 27, 2014
  3. W. Trevor KingMar 28, 2014
  4. Jens LehmannMar 28, 2014
  5. W. Trevor KingMar 28, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.