git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jens Lehmann <Jens.Lehmann@web.de>
To: "W. Trevor King" <wking@tremily.us>, Git <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>,
	Heiko Voigt <hvoigt@hvoigt.net>,
	Johan Herland <johan@herland.net>
Subject: Re: [PATCH] Documentation/submodule: Fix submodule.<name> -> .<path> typos
Date: Fri, 28 Mar 2014 00:15:00 +0100	[thread overview]
Message-ID: <5334B0F4.60103@web.de> (raw)
In-Reply-To: <f86f6b48f1c840d50d00c591a296821e0a18ee0d.1395954229.git.wking@tremily.us>

Am 27.03.2014 22:06, schrieb W. Trevor King:
> 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.

Nope, the distinction between path and name is way older (AFAIK it
is there from day one). That was just the point in time where you
could choose a different name without editing .gitmodules. And the
fact that the name is initialized with the path confused a lot of
people.

>  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.

This fixes the only two usages of 'submodule.<path>.*' in the
Documentation I can see in current master.

>  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::
> 

  reply	other threads:[~2014-03-27 23:15 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-27 21:06 [PATCH] Documentation/submodule: Fix submodule.<name> -> .<path> typos W. Trevor King
2014-03-27 23:15 ` Jens Lehmann [this message]
2014-03-28  2:06   ` W. Trevor King
2014-03-28 16:55     ` Jens Lehmann
2014-03-28 17:01       ` W. Trevor King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5334B0F4.60103@web.de \
    --to=jens.lehmann@web.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=hvoigt@hvoigt.net \
    --cc=johan@herland.net \
    --cc=wking@tremily.us \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).