From: Junio C Hamano <gitster@pobox.com>
To: Stefan Beller <sbeller@google.com>
Cc: git@vger.kernel.org, Jens.Lehmann@web.de, hvoigt@hvoigt.net
Subject: Re: [PATCH] documentation: clarify submodule.<name>.[url, path] variables
Date: Mon, 10 Oct 2016 11:09:17 -0700 [thread overview]
Message-ID: <xmqqpon8f54i.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20161006235149.10232-1-sbeller@google.com> (Stefan Beller's message of "Thu, 6 Oct 2016 16:51:49 -0700")
Stefan Beller <sbeller@google.com> writes:
> submodule.<name>.path::
> + The path within this project for a submodule. This variable is
> + kept in the .gitmodules file. See linkgit:git-submodule[1] and
> + linkgit:gitmodules[5] for details.
What does it exactly mean to be "kept"?
Does it mean "never appears in .git/config, and when it appears it
will not be used at all"? If so we shouldn't even list it here.
I doubt there is any reason for .path to exist in .git/config; where
each submodule appears in the working tree is what is recorded in
the tree object, and the "identity" (i.e. that which links a
submodule in a tree to one of the repositories kept in
.git/modules/*) by reverse look-up of submodule.<name>.path from
in-tree .gitmodules, not from configuration, and it is not something
a per-repository configuration should be able to change at the
conceptual level.
> submodule.<name>.url::
> - The path within this project and URL for a submodule. These
> - variables are initially populated by 'git submodule init'. See
> - linkgit:git-submodule[1] and linkgit:gitmodules[5] for
> - details.
> + The URL for a submodule. This variable is copied from the .gitmodules
> + file to the git config via 'git submodule init'. The user can change
> + the configured URL before obtaining the submodule via 'git submodule
> + update'. After obtaining the submodule, this variable is kept in the
> + config as a boolean flag to indicate whether the submodule is of
> + interest to git commands. See linkgit:git-submodule[1] and
> + linkgit:gitmodules[5] for details.
I think it is great that you are describing that this serves two
purposes, but "as a boolean flag" is very misleading. It sounds as
if at some point "git submodule $something" command stores
true/false there.
- It overrides the URL suggested by the project in .gitmodules and
replace it with another URL viewed from the local environment
(e.g. the project may suggest you to use http://github.com/ while
you may have a local mirror elsewhere).
- Its presence is also used as a sign that the user is interested in
the submodule.
next prev parent reply other threads:[~2016-10-10 18:10 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-06 23:51 [PATCH] documentation: clarify submodule.<name>.[url, path] variables Stefan Beller
2016-10-10 18:09 ` Junio C Hamano [this message]
2016-10-10 18:35 ` Stefan Beller
2016-10-10 19:10 ` Junio C Hamano
2016-10-10 19:36 ` [PATCHv2] documentation: improve submodule.<name>.{url, path} description Stefan Beller
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqpon8f54i.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=Jens.Lehmann@web.de \
--cc=git@vger.kernel.org \
--cc=hvoigt@hvoigt.net \
--cc=sbeller@google.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).