Re: [PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name

Hi Martin,

Le 2021-01-02 à 16:34, Martin Ågren a écrit :

On Sat, 2 Jan 2021 at 20:39, Philippe Blain via GitGitGadget
[off-list ref] wrote:

quoted

From: Philippe Blain <redacted>

'gitmodules.txt' is a guide about the '.gitmodules' file that describes
submodules properties, and that file must exist at the root of the
repository. This was clarified in e5b5c1d2cf (Document clarification:
gitmodules, gitattributes, 2008-08-31).

However, that commit mistakenly uses the non-existing environment
variable 'GIT_WORK_DIR' to refer to the root of the repository.

Good catch! I wonder what we should conclude from this having gone
unreported for so long.

quoted

Fix that by using the correct variable, 'GIT_WORK_TREE'. Take the
opportunity to modernize and improve the formatting of that guide.

It's a small correctness fix and some prettifying while at it. While I
read the diff and realized that it was more than just one or two
asciidoc tweaks in the immediate vicinity, I started wondering if this
should be presented the other way round: "Let's update the formatting
and fix s/DIR/TREE/ while at it." Or to split it up. But I don't think
it's worth thinking too much about -- what you have looks good to me.

quoted

@@ -32,14 +32,14 @@ submodule.<name>.path::

Just above this point, you have another s/\.gitmodules/`&`/ waiting to
be fixed.

Thanks, I added that.

quoted

  submodule.<name>.url::
         Defines a URL from which the submodule repository can be cloned.
         This may be either an absolute URL ready to be passed to

quoted

         dirty;; All changes to the submodule's work tree will be ignored, only
-           committed differences between the HEAD of the submodule and its
+           committed differences between the 'HEAD' of the submodule and its
             recorded state in the superproject are taken into account.

`git grep -B10 HEAD CodingGuidelines` suggests this should be `HEAD`,
not 'HEAD'. Maybe you followed style -- there's an instance of 'HEAD'
earlier. I think both should be `HEAD`.

Yes, `HEAD` has indeed more hits than 'HEAD'.

quoted

-If this option is also present in the submodules entry in .git/config
+If this option is also present in the submodules entry in `.git/config`
  of the superproject, the setting there will override the one found in
-.gitmodules.
+`.gitmodules`.

Should "submodules entry" be "submodule's entry"? I've never worked with
submodules, but that reading somehow seems more natural. (There are two
hits for "submodules entry" in this document -- both might be worth
looking at.)

I agree, I also added that.

Thanks,

Philippe.