{"thread":{"id":"56114","subject":"[PATCH] doc: clarify description of 'submodule.recurse'","startedAt":"2021-07-16T03:03:03Z","lastAt":"2021-07-16T03:03:03Z","messageCount":1,"participants":["Philippe Blain via GitGitGadget"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"430292","messageId":"pull.997.git.1626404577534.gitgitgadget@gmail.com","threadId":"56114","inReplyTo":null,"subject":"[PATCH] doc: clarify description of 'submodule.recurse'","fromName":"Philippe Blain via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-07-16T03:02:57Z","receivedAt":"2021-07-16T03:03:03Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"From: Philippe Blain <levraiphilippeblain@gmail.com>\n\nThe doc for 'submodule.recurse' starts with \"Specifies if commands\nrecurse into submodles by default\". This is not exactly true of all\ncommands that have a '--recurse-submodules' option. For example, 'git\npull --recurse-submodules' does not run 'git pull' in each submodule,\nbut rather runs 'git submodule update --recursive' so that the submodule\nworking trees after the pull matches the commits recorded in the\nsuperproject.\n\nClarify that by just saying that it enables '--recurse-submodules'.\n\nNote that the way this setting interacts with 'fetch.recurseSubmodules'\nand 'push.recurseSubmodules', which can have other values than true or\nfalse, is already documented since 4da9e99e6e (doc: be more precise on\n(fetch|push).recurseSubmodules, 2020-04-06).\n\nSigned-off-by: Philippe Blain <levraiphilippeblain@gmail.com>\n---\n    doc: clarify description of 'submodule.recurse'\n    \n    The current wording confused at least one user [1], so let's clarify\n    that.\n    \n    [1]\n    https://stackoverflow.com/questions/4611512/is-there-a-way-to-make-git-pull-automatically-update-submodules/49427199?noredirect=1#comment119208094_49427199\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-997%2Fphil-blain%2Fsubmodule.recurse-doc-clarify-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-997/phil-blain/submodule.recurse-doc-clarify-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/997\n\n Documentation/config/submodule.txt | 5 +++--\n 1 file changed, 3 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt\nindex d7a63c8c12b..ee454f8126a 100644\n--- a/Documentation/config/submodule.txt\n+++ b/Documentation/config/submodule.txt\n@@ -58,8 +58,9 @@ submodule.active::\n \tcommands. See linkgit:gitsubmodules[7] for details.\n \n submodule.recurse::\n-\tSpecifies if commands recurse into submodules by default. This\n-\tapplies to all commands that have a `--recurse-submodules` option\n+\tA boolean indicating if commands should enable the `--recurse-submodules`\n+\toption by default.\n+\tApplies to all commands that support this option\n \t(`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,\n \t`restore` and `switch`) except `clone` and `ls-files`.\n \tDefaults to false.\n\nbase-commit: d486ca60a51c9cb1fe068803c3f540724e95e83a\n-- \ngitgitgadget\n"}]}