[PATCH v6 0/5] teach submodules to know they're submodules

[Emily Shaffer <emilyshaffer@google.com>]

For the original cover letter, see
https://lore.kernel.org/git/20210611225428.1208973-1-emilyshaffer%40google.com.

CI run: https://github.com/nasamuffin/git/actions/runs/1780282431

Since v6:

I've dropped the fifth commit to use this new config for `git rev-parse
--show-superproject-working-tree`. I think it did more harm than good -
that tool uses an odd way to determine whether the superproject is
actually the superproject, anyways.

I poked a little bit at trying to find some benchmark to demonstrate
that "submodule.superprojectGitDir" is actually faster - but I didn't
end up able to write one without writing a ton of new code to traverse
the filesystem. To be honest, I'm not all that interested in performance
- I want the config added for correctness, instead.

So, the only real changes between v6 and v7 are some documentation
changes suggested by Jonathan Tan
(https://lore.kernel.org/git/20211117234300.2598132-1-jonathantanmy%40google.com).

Since v5:

A couple things. Firstly, a semantics change *back* to the semantics of
v3 - we map from gitdir to gitdir, *not* from common dir to common dir,
so that theoretically a submodule with multiple worktrees in multiple
superproject worktrees will be able to figure out which worktree of the
superproject it's in. (Realistically, that's not really possible right
now, but I'd like to change that soon.)

Secondly, a rewording of comments and commit messages to indicate that
this isn't a cache of some expensive operation, but rather intended to
be the source of truth for all submodules. I also added a fifth commit
rewriting `git rev-parse --show-superproject-working-tree` to
demonstrate what that means in practice - but from a practical
standpoint, I'm a little worried about that fifth patch. More details in
the patch 5 description.

I did discuss Ævar's idea of relying on in-process filesystem digging to
find the superproject's gitdir with the rest of the Google team, but in
the end decided that there are some worries about filesystem digging in
this way (namely, some ugly interactions with network drives that are
actually already an issue for Googler Linux machines). Plus, the allure
of being able to definitively know that we're a submodule is pretty
strong. ;) But overall, this is the direction I'd prefer to keep going
in, rather than trying to guess from the filesystem going forward.

Since v4:

The only real change here is a slight semantics change to map from
<submodule gitdir> to <superproject common git dir>. In every case
*except* for when the superproject has a worktree, this changes nothing.
For the case when the superproject has a worktree, this means that now
submodules will refer to the general superproject common dir (e.g. no
worktree-specific refs or configs or whatnot).

I *think* that because a submodule should exist in the context of the
common dir, not the worktree gitdir, that is ok. However, it does mean
it would be difficult to do something like sharing a config specific to
the worktree (the initial goal of this series).

$ROOT/.git
$ROOT/.git/config.superproject <- shared by $ROOT/.git/modules/sub
$ROOT/.git/modules/sub <- points to $ROOT/.git
$ROOT/.git/worktrees/wt
$ROOT/.git/worktrees/wt/config.superproject <- contains a certain config-based pre-commit hook

If the submodule only knows about the common dir, that is tough, because
the submodule would basically have to guess which worktree it's in from
its own path. There would be no way for '$WT/sub' to inherit
'$ROOT/.git/worktrees/wt/config.superproject'.

That said... right now, we don't support submodules in worktrees very
well at all. A submodule in a worktree will get a brand new gitdir in
$ROOT/.git/worktrees/modules/ (and that brand new gitdir would point to
the super's common dir). So I think we can punt on this entire question
until we teach submodules and worktrees to play more gracefully together
(it's on my long list...), and at that time we can probably introduce a
pointer from $ROOT/.git/modules/sub/worktrees/wt/ to
$ROOT/.git/worktrees/wt/....

Or, to summarize the long ramble above: "this is still kind of weird
with worktrees, but let's fix it later when we fix worktrees more
thoroughly".

(More rambling about worktree weirdness here:
https://lore.kernel.org/git/YYRaII8YWVxlBqsF%40google.com )


Since v3, a pretty major change: the semantics of
submodule.superprojectGitDir has changed, to point from the submodule's
gitdir to the superproject's gitdir (in v3 and earlier, we kept a path
from the submodule's *worktree* to the superproject's gitdir instead).
This cleans up some of the confusions about the behavior when a
submodule worktree moves around in the superproject's tree, or in a
future when we support submodules having multiple worktrees.

I also tried to simplify the tests to use 'test-tool path-utils
relative_path' everywhere - I think that makes them much more clear for
a test reader, but if you're reviewing and it isn't obvious what we're
testing for, please speak up.

I think this is pretty mature and there was a lot of general agreement
that the gitdir->gitdir association was the way to go, so please be
brutal and look for nits, leaks, etc. this round ;)
[/v4 cover letter]


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 |  9 ++++
 builtin/submodule--helper.c        | 11 ++++
 git-submodule.sh                   | 15 ++++++
 submodule.c                        | 23 +++++++++
 t/t7400-submodule-basic.sh         | 54 +++++++++++---------
 t/t7406-submodule-update.sh        | 27 ++++++++++
 t/t7412-submodule-absorbgitdirs.sh | 82 +++++++++++++++++++++++++++++-
 7 files changed, 194 insertions(+), 27 deletions(-)

Range-diff against v6:
1:  f1b08a7057 = 1:  251510c687 t7400-submodule-basic: modernize inspect() helper
2:  d46c8439ab ! 2:  1a85deb1c5 introduce submodule.superprojectGitDir record
    @@ Metadata
      ## Commit message ##
         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
    -    shortcut to the superproject's vitals, for example, configs.
    +    Teach submodules a config variable referencing to their superproject's
    +    gitdir. Git commands can rely on this reference to determine whether the
    +    current repo is a submodule to another repo. If this reference is
    +    absent, Git may assume the current repo is not a submodule.
    +
    +    In practice, some commands which specifically reference the submodule
    +    relationship, like 'git rev-parse --show-superproject-working-tree',
    +    will still search the parent directory. Other newly added or implicit
    +    behavior, such as "git status" showing the submodule's status in
    +    relation to the superproject, or a config which is shared between the
    +    superproject and the submodule, should not search the parent directory
    +    and instead rely on this "submodule.superprojectGitDir" config.
     
         By using a relative path instead of an absolute path, we can move the
         superproject directory around on the filesystem without breaking the
    @@ Commit message
         superproject's worktree gitdir (if it exists), we ensure that we can
         tell which worktree contains our submodule.
     
    -    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
    -    record to be created at other times.
    -
    -    Once this new config is reliably in place, we can use it to know
    -    definitively that we are working in a submodule, and to know which
    -    superproject we are a submodule of. This allows us to do some
    -    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.
    +    This commit teaches "git submodule add" to add the aformentioned config
    +    variable. Subsequent commits will teach other commands to do so.
     
         Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
         Helped-by: Junio C Hamano <gitster@pobox.com>
    @@ Documentation/config/submodule.txt: submodule.alternateErrorStrategy::
      	clone proceeds as if no alternate was specified.
     +
     +submodule.superprojectGitDir::
    -+	The relative path from the submodule's gitdir 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.
    ++	If this repository is a submodule, the relative path from this repo's
    ++	gitdir to its superproject's gitdir. Git commands may rely on this
    ++	reference to determine whether the current repo is a submodule to
    ++	another repo; if this reference is absent, Git will treat the current
    ++	repo as though it is not a submodule (this does not make a difference to
    ++	most Git commands). It is set automatically during submodule creation.
     
      ## builtin/submodule--helper.c ##
     @@ builtin/submodule--helper.c: static int clone_submodule(struct module_clone_data *clone_data)
3:  63ddaf5608 ! 3:  7a44b0edf9 submodule: record superproject gitdir during absorbgitdirs
    @@ Commit message
     
         Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
     
    + ## Documentation/config/submodule.txt ##
    +@@ Documentation/config/submodule.txt: submodule.superprojectGitDir::
    + 	reference to determine whether the current repo is a submodule to
    + 	another repo; if this reference is absent, Git will treat the current
    + 	repo as though it is not a submodule (this does not make a difference to
    +-	most Git commands). It is set automatically during submodule creation.
    ++	most Git commands). It is set automatically during submodule creation
    ++	and 'git submodule absorbgitdir'.
    +
      ## submodule.c ##
     @@ submodule.c: static void relocate_single_git_dir_into_superproject(const char *path)
      	char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
4:  33a582ef13 ! 4:  63e736e69d submodule: record superproject gitdir during 'update'
    @@ Commit message
     
         Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
     
    + ## Documentation/config/submodule.txt ##
    +@@ Documentation/config/submodule.txt: submodule.superprojectGitDir::
    + 	reference to determine whether the current repo is a submodule to
    + 	another repo; if this reference is absent, Git will treat the current
    + 	repo as though it is not a submodule (this does not make a difference to
    +-	most Git commands). It is set automatically during submodule creation
    +-	and 'git submodule absorbgitdir'.
    ++	most Git commands). It is set automatically during submodule creation,
    ++	update, and 'git submodule absorbgitdir'.
    +
      ## git-submodule.sh ##
     @@ git-submodule.sh: cmd_update()
      			;;
5:  a8b5d40a77 < -:  ---------- submodule: use config to find superproject worktree
-- 
2.35.0.263.gb82422642f-goog