{"thread":{"id":"54921","subject":"[PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","startedAt":"2021-01-02T19:38:32Z","lastAt":"2021-01-06T06:06:22Z","messageCount":8,"participants":["Philippe Blain via GitGitGadget","Martin Ågren","Felipe Contreras","Philippe Blain","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"413316","messageId":"pull.942.git.git.1609616245412.gitgitgadget@gmail.com","threadId":"54921","inReplyTo":null,"subject":"[PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Philippe Blain via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-01-02T19:37:25Z","receivedAt":"2021-01-02T19:38:32Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"From: Philippe Blain <levraiphilippeblain@gmail.com>\n\n'gitmodules.txt' is a guide about the '.gitmodules' file that describes\nsubmodules properties, and that file must exist at the root of the\nrepository. This was clarified in e5b5c1d2cf (Document clarification:\ngitmodules, gitattributes, 2008-08-31).\n\nHowever, that commit mistakenly uses the non-existing environment\nvariable 'GIT_WORK_DIR' to refer to the root of the repository.\n\nFix that by using the correct variable, 'GIT_WORK_TREE'. Take the\nopportunity to modernize and improve the formatting of that guide.\n\nSigned-off-by: Philippe Blain <levraiphilippeblain@gmail.com>\n---\n    gitmodules.txt: fix 'GIT_WORK_TREE' variable name\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-942%2Fphil-blain%2Fdoc-gitmodules-envvar-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-942/phil-blain/doc-gitmodules-envvar-v1\nPull-Request: https://github.com/git/git/pull/942\n\n Documentation/gitmodules.txt | 24 ++++++++++++------------\n 1 file changed, 12 insertions(+), 12 deletions(-)\n\ndiff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\nindex 539b4e1997e..07f3af6bae4 100644\n--- a/Documentation/gitmodules.txt\n+++ b/Documentation/gitmodules.txt\n@@ -7,7 +7,7 @@ gitmodules - Defining submodule properties\n \n SYNOPSIS\n --------\n-$GIT_WORK_DIR/.gitmodules\n+$GIT_WORK_TREE/.gitmodules\n \n \n DESCRIPTION\n@@ -32,14 +32,14 @@ submodule.<name>.path::\n submodule.<name>.url::\n \tDefines a URL from which the submodule repository can be cloned.\n \tThis may be either an absolute URL ready to be passed to\n-\tlinkgit:git-clone[1] or (if it begins with ./ or ../) a location\n+\tlinkgit:git-clone[1] or (if it begins with `./` or `../`) a location\n \trelative to the superproject's origin repository.\n \n In addition, there are a number of optional keys:\n \n submodule.<name>.update::\n \tDefines the default update procedure for the named submodule,\n-\ti.e. how the submodule is updated by \"git submodule update\"\n+\ti.e. how the submodule is updated by the `git submodule update`\n \tcommand in the superproject. This is only used by `git\n \tsubmodule init` to initialize the configuration variable of\n \tthe same name. Allowed values here are 'checkout', 'rebase',\n@@ -58,13 +58,13 @@ submodule.<name>.branch::\n submodule.<name>.fetchRecurseSubmodules::\n \tThis option can be used to control recursive fetching of this\n \tsubmodule. If this option is also present in the submodules entry in\n-\t.git/config of the superproject, the setting there will override the\n-\tone found in .gitmodules.\n+\t`.git/config` of the superproject, the setting there will override the\n+\tone found in `.gitmodules`.\n \tBoth settings can be overridden on the command line by using the\n-\t\"--[no-]recurse-submodules\" option to \"git fetch\" and \"git pull\".\n+\t`--[no-]recurse-submodules` option to `git fetch` and `git pull`.\n \n submodule.<name>.ignore::\n-\tDefines under what circumstances \"git status\" and the diff family show\n+\tDefines under what circumstances `git status` and the diff family show\n \ta submodule as modified. The following values are supported:\n +\n --\n@@ -73,7 +73,7 @@ submodule.<name>.ignore::\n \t    been staged).\n \n \tdirty;; All changes to the submodule's work tree will be ignored, only\n-\t    committed differences between the HEAD of the submodule and its\n+\t    committed differences between the 'HEAD' of the submodule and its\n \t    recorded state in the superproject are taken into account.\n \n \tuntracked;; Only untracked files in submodules will be ignored.\n@@ -84,12 +84,12 @@ submodule.<name>.ignore::\n \t    differences, and modifications to tracked and untracked files are\n \t    shown. This is the default option.\n \n-If this option is also present in the submodules entry in .git/config\n+If this option is also present in the submodules entry in `.git/config`\n of the superproject, the setting there will override the one found in\n-.gitmodules.\n+`.gitmodules`.\n \n Both settings can be overridden on the command line by using the\n-\"--ignore-submodules\" option. The 'git submodule' commands are not\n+`--ignore-submodules` option. The `git submodule` commands are not\n affected by this setting.\n --\n \n@@ -102,7 +102,7 @@ submodule.<name>.shallow::\n EXAMPLES\n --------\n \n-Consider the following .gitmodules file:\n+Consider the following `.gitmodules` file:\n \n ----\n [submodule \"libfoo\"]\n\nbase-commit: 71ca53e8125e36efbda17293c50027d31681a41f\n-- \ngitgitgadget\n"},{"id":"413318","messageId":"CAN0heSqC3K6pJOr2ztz56+ZpKaMomA28rc4W5x8n0cC3K-rVgQ@mail.gmail.com","threadId":"54921","inReplyTo":"pull.942.git.git.1609616245412.gitgitgadget@gmail.com","subject":"Re: [PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2021-01-02T21:34:09Z","receivedAt":"2021-01-02T21:35:28Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"On Sat, 2 Jan 2021 at 20:39, Philippe Blain via GitGitGadget\n<gitgitgadget@gmail.com> wrote:\n>\n> From: Philippe Blain <levraiphilippeblain@gmail.com>\n>\n> 'gitmodules.txt' is a guide about the '.gitmodules' file that describes\n> submodules properties, and that file must exist at the root of the\n> repository. This was clarified in e5b5c1d2cf (Document clarification:\n> gitmodules, gitattributes, 2008-08-31).\n>\n> However, that commit mistakenly uses the non-existing environment\n> variable 'GIT_WORK_DIR' to refer to the root of the repository.\n\nGood catch! I wonder what we should conclude from this having gone\nunreported for so long.\n\n> Fix that by using the correct variable, 'GIT_WORK_TREE'. Take the\n> opportunity to modernize and improve the formatting of that guide.\n\nIt's a small correctness fix and some prettifying while at it. While I\nread the diff and realized that it was more than just one or two\nasciidoc tweaks in the immediate vicinity, I started wondering if this\nshould be presented the other way round: \"Let's update the formatting\nand fix s/DIR/TREE/ while at it.\" Or to split it up. But I don't think\nit's worth thinking too much about -- what you have looks good to me.\n\n> @@ -32,14 +32,14 @@ submodule.<name>.path::\n\nJust above this point, you have another s/\\.gitmodules/`&`/ waiting to\nbe fixed.\n\n>  submodule.<name>.url::\n>         Defines a URL from which the submodule repository can be cloned.\n>         This may be either an absolute URL ready to be passed to\n\n>         dirty;; All changes to the submodule's work tree will be ignored, only\n> -           committed differences between the HEAD of the submodule and its\n> +           committed differences between the 'HEAD' of the submodule and its\n>             recorded state in the superproject are taken into account.\n\n`git grep -B10 HEAD CodingGuidelines` suggests this should be `HEAD`,\nnot 'HEAD'. Maybe you followed style -- there's an instance of 'HEAD'\nearlier. I think both should be `HEAD`.\n\n> -If this option is also present in the submodules entry in .git/config\n> +If this option is also present in the submodules entry in `.git/config`\n>  of the superproject, the setting there will override the one found in\n> -.gitmodules.\n> +`.gitmodules`.\n\nShould \"submodules entry\" be \"submodule's entry\"? I've never worked with\nsubmodules, but that reading somehow seems more natural. (There are two\nhits for \"submodules entry\" in this document -- both might be worth\nlooking at.)\n\nThis patch looks good to me. It might be worthwhile to reroll\nto address the naked .gitmodules around line 30 and the two 'HEAD' while\nyou're in the area. As for the last comment above, it could well be\nthat the proper response is \"no, you're wrong\".\n\nMartin\n"},{"id":"413321","messageId":"5ff0ef1332a66_a76d2086d@natae.notmuch","threadId":"54921","inReplyTo":"CAN0heSqC3K6pJOr2ztz56+ZpKaMomA28rc4W5x8n0cC3K-rVgQ@mail.gmail.com","subject":"Re: [PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2021-01-02T22:09:23Z","receivedAt":"2021-01-02T22:10:07Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"Martin Ågren wrote:\n> On Sat, 2 Jan 2021 at 20:39, Philippe Blain via GitGitGadget\n> <gitgitgadget@gmail.com> wrote:\n> >\n> > From: Philippe Blain <levraiphilippeblain@gmail.com>\n> >\n> > 'gitmodules.txt' is a guide about the '.gitmodules' file that describes\n> > submodules properties, and that file must exist at the root of the\n> > repository. This was clarified in e5b5c1d2cf (Document clarification:\n> > gitmodules, gitattributes, 2008-08-31).\n> >\n> > However, that commit mistakenly uses the non-existing environment\n> > variable 'GIT_WORK_DIR' to refer to the root of the repository.\n> \n> Good catch! I wonder what we should conclude from this having gone\n> unreported for so long.\n\nThat perhaps not that many people actually read the official\ndocumentation?\n\nI've noticed the common response RTFM is not that common anymore. A lot\nof people seem to rely on Stack Overflow, blogs, and some semi-official\ndocumentation (GitHub, Atlassian, etc.).\n\nCheers.\n\n-- \nFelipe Contreras"},{"id":"413326","messageId":"2411086f-b6d6-98c3-bbb4-53ea8956c765@gmail.com","threadId":"54921","inReplyTo":"CAN0heSqC3K6pJOr2ztz56+ZpKaMomA28rc4W5x8n0cC3K-rVgQ@mail.gmail.com","subject":"Re: [PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Philippe Blain","fromEmail":"levraiphilippeblain@gmail.com","sentAt":"2021-01-03T00:33:08Z","receivedAt":"2021-01-03T00:37:34Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"Hi Martin,\n\nLe 2021-01-02 à 16:34, Martin Ågren a écrit :\n> On Sat, 2 Jan 2021 at 20:39, Philippe Blain via GitGitGadget\n> <gitgitgadget@gmail.com> wrote:\n>>\n>> From: Philippe Blain <levraiphilippeblain@gmail.com>\n>>\n>> 'gitmodules.txt' is a guide about the '.gitmodules' file that describes\n>> submodules properties, and that file must exist at the root of the\n>> repository. This was clarified in e5b5c1d2cf (Document clarification:\n>> gitmodules, gitattributes, 2008-08-31).\n>>\n>> However, that commit mistakenly uses the non-existing environment\n>> variable 'GIT_WORK_DIR' to refer to the root of the repository.\n> \n> Good catch! I wonder what we should conclude from this having gone\n> unreported for so long.\n> \n>> Fix that by using the correct variable, 'GIT_WORK_TREE'. Take the\n>> opportunity to modernize and improve the formatting of that guide.\n> \n> It's a small correctness fix and some prettifying while at it. While I\n> read the diff and realized that it was more than just one or two\n> asciidoc tweaks in the immediate vicinity, I started wondering if this\n> should be presented the other way round: \"Let's update the formatting\n> and fix s/DIR/TREE/ while at it.\" Or to split it up. But I don't think\n> it's worth thinking too much about -- what you have looks good to me.\n> \n>> @@ -32,14 +32,14 @@ submodule.<name>.path::\n> \n> Just above this point, you have another s/\\.gitmodules/`&`/ waiting to\n> be fixed.\n\nThanks, I added that.\n\n> \n>>   submodule.<name>.url::\n>>          Defines a URL from which the submodule repository can be cloned.\n>>          This may be either an absolute URL ready to be passed to\n> \n>>          dirty;; All changes to the submodule's work tree will be ignored, only\n>> -           committed differences between the HEAD of the submodule and its\n>> +           committed differences between the 'HEAD' of the submodule and its\n>>              recorded state in the superproject are taken into account.\n> \n> `git grep -B10 HEAD CodingGuidelines` suggests this should be `HEAD`,\n> not 'HEAD'. Maybe you followed style -- there's an instance of 'HEAD'\n> earlier. I think both should be `HEAD`.\n\nYes, `HEAD` has indeed more hits than 'HEAD'.\n\n> \n>> -If this option is also present in the submodules entry in .git/config\n>> +If this option is also present in the submodules entry in `.git/config`\n>>   of the superproject, the setting there will override the one found in\n>> -.gitmodules.\n>> +`.gitmodules`.\n> \n> Should \"submodules entry\" be \"submodule's entry\"? I've never worked with\n> submodules, but that reading somehow seems more natural. (There are two\n> hits for \"submodules entry\" in this document -- both might be worth\n> looking at.)\n\nI agree, I also added that.\n\nThanks,\n\nPhilippe.\n"},{"id":"413328","messageId":"CAN0heSq8Hkq43mn06o_vxQD_FW3zSg5YSFDAtuONsFAvbNiNuA@mail.gmail.com","threadId":"54921","inReplyTo":"5ff0ef1332a66_a76d2086d@natae.notmuch","subject":"Re: [PATCH] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2021-01-03T08:34:34Z","receivedAt":"2021-01-03T08:35:50Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"On Sat, 2 Jan 2021 at 23:09, Felipe Contreras\n<felipe.contreras@gmail.com> wrote:\n>\n> Martin Ågren wrote:\n\n> > Good catch! I wonder what we should conclude from this having gone\n> > unreported for so long.\n>\n> That perhaps not that many people actually read the official\n> documentation?\n>\n> I've noticed the common response RTFM is not that common anymore. A lot\n> of people seem to rely on Stack Overflow, blogs, and some semi-official\n> documentation (GitHub, Atlassian, etc.).\n\nHmm, now that you say it, I think that matches my impression. There was\na time when that seemed to be a really \"in\" answer, if not always\nentirely friendly. You're right that it seems to be quite a bit less\ncommon today.\n\nMartin\n"},{"id":"413340","messageId":"pull.942.v2.git.git.1609695736001.gitgitgadget@gmail.com","threadId":"54921","inReplyTo":"pull.942.git.git.1609616245412.gitgitgadget@gmail.com","subject":"[PATCH v2] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Philippe Blain via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-01-03T17:42:15Z","receivedAt":"2021-01-03T17:44:05Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"From: Philippe Blain <levraiphilippeblain@gmail.com>\n\n'gitmodules.txt' is a guide about the '.gitmodules' file that describes\nsubmodule properties, and that file must exist at the root of the\nrepository. This was clarified in e5b5c1d2cf (Document clarification:\ngitmodules, gitattributes, 2008-08-31).\n\nHowever, that commit mistakenly uses the non-existing environment\nvariable 'GIT_WORK_DIR' to refer to the root of the repository.\n\nFix that by using the correct variable, 'GIT_WORK_TREE'. Take the\nopportunity to modernize and improve the formatting of that guide,\nand fix a grammar mistake.\n\nSigned-off-by: Philippe Blain <levraiphilippeblain@gmail.com>\n---\n    gitmodules.txt: fix 'GIT_WORK_TREE' variable name\n    \n    Changes since v1:\n    \n     * added Martin's suggestions\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-942%2Fphil-blain%2Fdoc-gitmodules-envvar-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-942/phil-blain/doc-gitmodules-envvar-v2\nPull-Request: https://github.com/git/git/pull/942\n\nRange-diff vs v1:\n\n 1:  8fa2238f4a0 ! 1:  4fca37ea043 gitmodules.txt: fix 'GIT_WORK_TREE' variable name\n     @@ Commit message\n          gitmodules.txt: fix 'GIT_WORK_TREE' variable name\n      \n          'gitmodules.txt' is a guide about the '.gitmodules' file that describes\n     -    submodules properties, and that file must exist at the root of the\n     +    submodule properties, and that file must exist at the root of the\n          repository. This was clarified in e5b5c1d2cf (Document clarification:\n          gitmodules, gitattributes, 2008-08-31).\n      \n     @@ Commit message\n          variable 'GIT_WORK_DIR' to refer to the root of the repository.\n      \n          Fix that by using the correct variable, 'GIT_WORK_TREE'. Take the\n     -    opportunity to modernize and improve the formatting of that guide.\n     +    opportunity to modernize and improve the formatting of that guide,\n     +    and fix a grammar mistake.\n      \n          Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>\n      \n     @@ Documentation/gitmodules.txt: gitmodules - Defining submodule properties\n       \n       DESCRIPTION\n      @@ Documentation/gitmodules.txt: submodule.<name>.path::\n     + \tDefines the path, relative to the top-level directory of the Git\n     + \tworking tree, where the submodule is expected to be checked out.\n     + \tThe path name must not end with a `/`. All submodule paths must\n     +-\tbe unique within the .gitmodules file.\n     ++\tbe unique within the `.gitmodules` file.\n     + \n       submodule.<name>.url::\n       \tDefines a URL from which the submodule repository can be cloned.\n       \tThis may be either an absolute URL ready to be passed to\n     @@ Documentation/gitmodules.txt: submodule.<name>.path::\n       \tcommand in the superproject. This is only used by `git\n       \tsubmodule init` to initialize the configuration variable of\n       \tthe same name. Allowed values here are 'checkout', 'rebase',\n     +@@ Documentation/gitmodules.txt: submodule.<name>.update::\n     + \n     + submodule.<name>.branch::\n     + \tA remote branch name for tracking updates in the upstream submodule.\n     +-\tIf the option is not specified, it defaults to the remote 'HEAD'.\n     ++\tIf the option is not specified, it defaults to the remote `HEAD`.\n     + \tA special value of `.` is used to indicate that the name of the branch\n     + \tin the submodule should be the same name as the current branch in the\n     + \tcurrent repository.  See the `--remote` documentation in\n      @@ Documentation/gitmodules.txt: submodule.<name>.branch::\n     + \n       submodule.<name>.fetchRecurseSubmodules::\n       \tThis option can be used to control recursive fetching of this\n     - \tsubmodule. If this option is also present in the submodules entry in\n     +-\tsubmodule. If this option is also present in the submodules entry in\n      -\t.git/config of the superproject, the setting there will override the\n      -\tone found in .gitmodules.\n     ++\tsubmodule. If this option is also present in the submodule's entry in\n      +\t`.git/config` of the superproject, the setting there will override the\n      +\tone found in `.gitmodules`.\n       \tBoth settings can be overridden on the command line by using the\n     @@ Documentation/gitmodules.txt: submodule.<name>.ignore::\n       \n       \tdirty;; All changes to the submodule's work tree will be ignored, only\n      -\t    committed differences between the HEAD of the submodule and its\n     -+\t    committed differences between the 'HEAD' of the submodule and its\n     ++\t    committed differences between the `HEAD` of the submodule and its\n       \t    recorded state in the superproject are taken into account.\n       \n       \tuntracked;; Only untracked files in submodules will be ignored.\n     @@ Documentation/gitmodules.txt: submodule.<name>.ignore::\n       \t    shown. This is the default option.\n       \n      -If this option is also present in the submodules entry in .git/config\n     -+If this option is also present in the submodules entry in `.git/config`\n     ++If this option is also present in the submodule's entry in `.git/config`\n       of the superproject, the setting there will override the one found in\n      -.gitmodules.\n      +`.gitmodules`.\n\n\n Documentation/gitmodules.txt | 30 +++++++++++++++---------------\n 1 file changed, 15 insertions(+), 15 deletions(-)\n\ndiff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\nindex 539b4e1997e..8e333dde1ba 100644\n--- a/Documentation/gitmodules.txt\n+++ b/Documentation/gitmodules.txt\n@@ -7,7 +7,7 @@ gitmodules - Defining submodule properties\n \n SYNOPSIS\n --------\n-$GIT_WORK_DIR/.gitmodules\n+$GIT_WORK_TREE/.gitmodules\n \n \n DESCRIPTION\n@@ -27,19 +27,19 @@ submodule.<name>.path::\n \tDefines the path, relative to the top-level directory of the Git\n \tworking tree, where the submodule is expected to be checked out.\n \tThe path name must not end with a `/`. All submodule paths must\n-\tbe unique within the .gitmodules file.\n+\tbe unique within the `.gitmodules` file.\n \n submodule.<name>.url::\n \tDefines a URL from which the submodule repository can be cloned.\n \tThis may be either an absolute URL ready to be passed to\n-\tlinkgit:git-clone[1] or (if it begins with ./ or ../) a location\n+\tlinkgit:git-clone[1] or (if it begins with `./` or `../`) a location\n \trelative to the superproject's origin repository.\n \n In addition, there are a number of optional keys:\n \n submodule.<name>.update::\n \tDefines the default update procedure for the named submodule,\n-\ti.e. how the submodule is updated by \"git submodule update\"\n+\ti.e. how the submodule is updated by the `git submodule update`\n \tcommand in the superproject. This is only used by `git\n \tsubmodule init` to initialize the configuration variable of\n \tthe same name. Allowed values here are 'checkout', 'rebase',\n@@ -49,7 +49,7 @@ submodule.<name>.update::\n \n submodule.<name>.branch::\n \tA remote branch name for tracking updates in the upstream submodule.\n-\tIf the option is not specified, it defaults to the remote 'HEAD'.\n+\tIf the option is not specified, it defaults to the remote `HEAD`.\n \tA special value of `.` is used to indicate that the name of the branch\n \tin the submodule should be the same name as the current branch in the\n \tcurrent repository.  See the `--remote` documentation in\n@@ -57,14 +57,14 @@ submodule.<name>.branch::\n \n submodule.<name>.fetchRecurseSubmodules::\n \tThis option can be used to control recursive fetching of this\n-\tsubmodule. If this option is also present in the submodules entry in\n-\t.git/config of the superproject, the setting there will override the\n-\tone found in .gitmodules.\n+\tsubmodule. If this option is also present in the submodule's entry in\n+\t`.git/config` of the superproject, the setting there will override the\n+\tone found in `.gitmodules`.\n \tBoth settings can be overridden on the command line by using the\n-\t\"--[no-]recurse-submodules\" option to \"git fetch\" and \"git pull\".\n+\t`--[no-]recurse-submodules` option to `git fetch` and `git pull`.\n \n submodule.<name>.ignore::\n-\tDefines under what circumstances \"git status\" and the diff family show\n+\tDefines under what circumstances `git status` and the diff family show\n \ta submodule as modified. The following values are supported:\n +\n --\n@@ -73,7 +73,7 @@ submodule.<name>.ignore::\n \t    been staged).\n \n \tdirty;; All changes to the submodule's work tree will be ignored, only\n-\t    committed differences between the HEAD of the submodule and its\n+\t    committed differences between the `HEAD` of the submodule and its\n \t    recorded state in the superproject are taken into account.\n \n \tuntracked;; Only untracked files in submodules will be ignored.\n@@ -84,12 +84,12 @@ submodule.<name>.ignore::\n \t    differences, and modifications to tracked and untracked files are\n \t    shown. This is the default option.\n \n-If this option is also present in the submodules entry in .git/config\n+If this option is also present in the submodule's entry in `.git/config`\n of the superproject, the setting there will override the one found in\n-.gitmodules.\n+`.gitmodules`.\n \n Both settings can be overridden on the command line by using the\n-\"--ignore-submodules\" option. The 'git submodule' commands are not\n+`--ignore-submodules` option. The `git submodule` commands are not\n affected by this setting.\n --\n \n@@ -102,7 +102,7 @@ submodule.<name>.shallow::\n EXAMPLES\n --------\n \n-Consider the following .gitmodules file:\n+Consider the following `.gitmodules` file:\n \n ----\n [submodule \"libfoo\"]\n\nbase-commit: 71ca53e8125e36efbda17293c50027d31681a41f\n-- \ngitgitgadget\n"},{"id":"413342","messageId":"CAN0heSpGyHKkiod6TE5jvVc_Y2MTWVY6DLS1Dg4FvS_m71Gs4A@mail.gmail.com","threadId":"54921","inReplyTo":"pull.942.v2.git.git.1609695736001.gitgitgadget@gmail.com","subject":"Re: [PATCH v2] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2021-01-03T20:15:42Z","receivedAt":"2021-01-03T20:16:51Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"Hi Philippe,\n\nOn Sun, 3 Jan 2021 at 18:42, Philippe Blain via GitGitGadget\n<gitgitgadget@gmail.com> wrote:\n>\n>     Changes since v1:\n>\n>      * added Martin's suggestions\n\nYup, this looks good to me.\n\nMartin\n"},{"id":"413535","messageId":"xmqq8s96vbvg.fsf@gitster.c.googlers.com","threadId":"54921","inReplyTo":"CAN0heSpGyHKkiod6TE5jvVc_Y2MTWVY6DLS1Dg4FvS_m71Gs4A@mail.gmail.com","subject":"Re: [PATCH v2] gitmodules.txt: fix 'GIT_WORK_TREE' variable name","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-01-06T06:05:23Z","receivedAt":"2021-01-06T06:06:22Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Martin Ågren <martin.agren@gmail.com> writes:\n\n> Hi Philippe,\n>\n> On Sun, 3 Jan 2021 at 18:42, Philippe Blain via GitGitGadget\n> <gitgitgadget@gmail.com> wrote:\n>>\n>>     Changes since v1:\n>>\n>>      * added Martin's suggestions\n>\n> Yup, this looks good to me.\n>\n> Martin\n\nThanks, all.\n"}]}