From: Emily Shaffer <emilyshaffer@google.com>
To: git@vger.kernel.org
Cc: "Emily Shaffer" <emilyshaffer@google.com>,
"Albert Cui" <albertcui@google.com>,
"Phillip Wood" <phillip.wood123@gmail.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Matheus Tavares Bernardino" <matheus.bernardino@usp.br>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Jacob Keller" <jacob.keller@gmail.com>,
"Atharva Raykar" <raykar.ath@gmail.com>,
"Jonathan Tan" <jonathantanmy@google.com>
Subject: [PATCH v3 0/4] cache parent project's gitdir in submodules
Date: Thu, 19 Aug 2021 13:09:49 -0700 [thread overview]
Message-ID: <20210819200953.2105230-1-emilyshaffer@google.com> (raw)
In-Reply-To: <20210616004508.87186-1-emilyshaffer@google.com>
Since v2, mostly documentation changes and a handful of small nits from
Junio and Jonathan Tan. Thanks for the reviews, both.
CI run here: https://github.com/nasamuffin/git/actions/runs/1147984974
- Emily
Emily Shaffer (4):
t7400-submodule-basic: modernize inspect() helper
introduce submodule.superprojectGitDir record
submodule: record superproject gitdir during absorbgitdirs
submodule: record superproject gitdir during 'update'
Documentation/config/submodule.txt | 15 ++++++++++
builtin/submodule--helper.c | 4 +++
git-submodule.sh | 10 +++++++
submodule.c | 10 +++++++
t/t7400-submodule-basic.sh | 48 ++++++++++++++----------------
t/t7406-submodule-update.sh | 10 +++++++
t/t7412-submodule-absorbgitdirs.sh | 9 +++++-
7 files changed, 79 insertions(+), 27 deletions(-)
Range-diff against v2:
1: a6718eea80 ! 1: f1236dc9d7 t7400-submodule-basic: modernize inspect() helper
@@ t/t7400-submodule-basic.sh: test_expect_success 'setup - repository to add submo
+ git -C "$dir" clean -n -d -x >untracked
}
-+
test_expect_success 'submodule add' '
- echo "refs/heads/main" >expect &&
-
@@ t/t7400-submodule-basic.sh: test_expect_success 'submodule add' '
) &&
2: 4cebe7bcb5 ! 2: 2caf9eb8ee introduce submodule.superprojectGitDir cache
@@ Metadata
Author: Emily Shaffer <emilyshaffer@google.com>
## Commit message ##
- introduce submodule.superprojectGitDir cache
+ introduce submodule.superprojectGitDir record
Teach submodules a reference to their superproject's gitdir. This allows
us to A) know that we're running from a submodule, and B) have a
@@ Commit message
superproject directory around on the filesystem without breaking the
submodule's cache.
- Since this cached value is only introduced during new submodule creation
+ Since this hint value is only introduced during new submodule creation
via `git submodule add`, though, there is more work to do to allow the
- cache to be created at other times.
+ record to be created at other times.
+
+ If the new config is present, we can do some optional value-added
+ behavior, like letting "git status" print additional info about the
+ submodule's status in relation to its superproject, or like letting the
+ superproject and submodule share an additional config file separate from
+ either one's local config.
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
+ Helped-by: Junio C Hamano <gitster@pobox.com>
## Documentation/config/submodule.txt ##
@@ Documentation/config/submodule.txt: submodule.alternateErrorStrategy::
@@ Documentation/config/submodule.txt: submodule.alternateErrorStrategy::
clone proceeds as if no alternate was specified.
+
+submodule.superprojectGitDir::
-+ The relative path from the submodule's worktree to the superproject's
-+ gitdir. This config should only be present in projects which are
-+ submodules, but is not guaranteed to be present in every submodule. It
-+ is set automatically during submodule creation.
++ The relative path from the submodule's worktree to its superproject's
++ gitdir. When Git is run in a repository, it usually makes no difference
++ whether this repository is standalone or a submodule, but if this
++ configuration variable is present, additional behavior may be possible,
++ such as "git status" printing additional information about this
++ submodule's status with respect to its superproject. This config should
++ only be present in projects which are submodules, but is not guaranteed
++ to be present in every submodule, so only optional value-added behavior
++ should be linked to it. It is set automatically during
++ submodule creation.
++
-+ In situations where more than one superproject references the same
-+ submodule worktree, the value of this config and the behavior of
-+ operations which use it are undefined. To reference a single project
-+ from multiple superprojects, it is better to create a worktree of the
-+ submodule for each superproject.
++ Because of this configuration variable, it is forbidden to use the
++ same submodule worktree shared by multiple superprojects.
## builtin/submodule--helper.c ##
@@ builtin/submodule--helper.c: static int module_clone(int argc, const char **argv, const char *prefix)
@@ t/t7400-submodule-basic.sh: test_expect_success 'setup - repository to add submo
+ git -C "$sub_dir" clean -n -d -x >untracked
}
-
+ test_expect_success 'submodule add' '
@@ t/t7400-submodule-basic.sh: test_expect_success 'submodule add' '
) &&
3: df97a9c2bb ! 3: d278568a8e submodule: cache superproject gitdir during absorbgitdirs
@@ Metadata
Author: Emily Shaffer <emilyshaffer@google.com>
## Commit message ##
- submodule: cache superproject gitdir during absorbgitdirs
+ submodule: record superproject gitdir during absorbgitdirs
- Already during 'git submodule add' we cache a pointer to the
+ Already during 'git submodule add' we record a pointer to the
superproject's gitdir. However, this doesn't help brand-new
submodules created with 'git init' and later absorbed with 'git
submodule absorbgitdir'. Let's start adding that pointer during 'git
4: a3f3be58ad ! 4: 6866c36620 submodule: cache superproject gitdir during 'update'
@@ Metadata
Author: Emily Shaffer <emilyshaffer@google.com>
## Commit message ##
- submodule: cache superproject gitdir during 'update'
+ submodule: record superproject gitdir during 'update'
- A cached path to the superproject's gitdir might be added during 'git
- submodule add', but in some cases - like submodules which were created
- before 'git submodule add' learned to cache that info - it might be
- useful to update the cache. Let's do it during 'git submodule update',
- when we already have a handle to the superproject while calling
+ A recorded hint path to the superproject's gitdir might be added during
+ 'git submodule add', but in some cases - like submodules which were
+ created before 'git submodule add' learned to record that info - it might
+ be useful to update the hint. Let's do it during 'git submodule
+ update', when we already have a handle to the superproject while calling
operations on the submodules.
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
--
2.33.0.rc2.250.ged5fa647cd-goog
next prev parent reply other threads:[~2021-08-19 20:10 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-11 22:54 [RFC PATCH 0/4] cache parent project's gitdir in submodules Emily Shaffer
2021-06-11 22:54 ` [RFC PATCH 1/4] t7400-submodule-basic: modernize inspect() helper Emily Shaffer
2021-06-14 4:52 ` Junio C Hamano
2021-06-11 22:54 ` [RFC PATCH 2/4] introduce submodule.superprojectGitDir cache Emily Shaffer
2021-06-14 5:09 ` Junio C Hamano
2021-06-15 22:00 ` Emily Shaffer
2021-06-11 22:54 ` [RFC PATCH 3/4] submodule: cache superproject gitdir during absorbgitdirs Emily Shaffer
2021-06-14 6:18 ` Junio C Hamano
2021-06-11 22:54 ` [RFC PATCH 4/4] submodule: cache superproject gitdir during 'update' Emily Shaffer
2021-06-14 6:22 ` Junio C Hamano
2021-06-15 21:27 ` Emily Shaffer
2021-06-12 20:12 ` [RFC PATCH 0/4] cache parent project's gitdir in submodules Jacob Keller
2021-06-14 7:26 ` Junio C Hamano
2021-06-15 21:18 ` Emily Shaffer
2021-06-16 0:45 ` [PATCH v2 " Emily Shaffer
2021-06-16 0:45 ` [PATCH v2 1/4] t7400-submodule-basic: modernize inspect() helper Emily Shaffer
2021-07-27 17:12 ` Jonathan Tan
2021-08-19 17:46 ` Emily Shaffer
2021-06-16 0:45 ` [PATCH v2 2/4] introduce submodule.superprojectGitDir cache Emily Shaffer
2021-06-16 4:40 ` Junio C Hamano
2021-06-16 4:43 ` Junio C Hamano
2021-06-18 0:03 ` Emily Shaffer
2021-06-18 0:00 ` Emily Shaffer
2021-07-27 17:46 ` Jonathan Tan
2021-08-19 17:53 ` Emily Shaffer
2021-10-14 19:25 ` Ævar Arnfjörð Bjarmason
2021-06-16 0:45 ` [PATCH v2 3/4] submodule: cache superproject gitdir during absorbgitdirs Emily Shaffer
2021-06-16 0:45 ` [PATCH v2 4/4] submodule: cache superproject gitdir during 'update' Emily Shaffer
2021-07-27 17:51 ` Jonathan Tan
2021-08-19 18:02 ` Emily Shaffer
2021-08-19 20:09 ` Emily Shaffer [this message]
2021-08-19 20:09 ` [PATCH v3 1/4] t7400-submodule-basic: modernize inspect() helper Emily Shaffer
2021-08-19 20:09 ` [PATCH v3 2/4] introduce submodule.superprojectGitDir record Emily Shaffer
2021-08-20 0:38 ` Derrick Stolee
2021-10-13 19:36 ` Emily Shaffer
2021-09-04 17:20 ` Matheus Tavares
2021-10-13 19:39 ` Emily Shaffer
2021-08-19 20:09 ` [PATCH v3 3/4] submodule: record superproject gitdir during absorbgitdirs Emily Shaffer
2021-08-20 0:50 ` Derrick Stolee
2021-10-13 19:42 ` Emily Shaffer
2021-09-04 17:27 ` Matheus Tavares
2021-10-14 18:40 ` Emily Shaffer
2021-08-19 20:09 ` [PATCH v3 4/4] submodule: record superproject gitdir during 'update' Emily Shaffer
2021-08-20 0:59 ` Derrick Stolee
2021-10-14 18:45 ` Emily Shaffer
2021-08-19 21:56 ` [PATCH v3 0/4] cache parent project's gitdir in submodules Junio C Hamano
2021-08-20 1:09 ` Derrick Stolee
2021-10-13 18:51 ` Emily Shaffer
2021-10-14 17:12 ` Derrick Stolee
2021-10-14 18:52 ` Emily Shaffer
2021-09-04 17:50 ` Matheus Tavares Bernardino
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=20210819200953.2105230-1-emilyshaffer@google.com \
--to=emilyshaffer@google.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=albertcui@google.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jacob.keller@gmail.com \
--cc=jonathantanmy@google.com \
--cc=jrnieder@gmail.com \
--cc=matheus.bernardino@usp.br \
--cc=phillip.wood123@gmail.com \
--cc=raykar.ath@gmail.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).