Skip to contentSkip to conversation

RelNotes/2.16: Fix submodule recursing argument

PATCH In review Stefan Beller 2 participants 2 messages Dec 7, 2017 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 RelNotes/2.16: Fix submodule recursing argument

Some commands take a plain --recursive flag as an indication to recurse into submodules, git-clone is a notable user facing example, an internal example is in builtin/submodule--helper. Other commands such as git-merge take the --recursive flag to indicate recursing in their specific area of expertise.

Given these examples it is evident, that such a flag is too generic as we can think of other recursive applications as well: recursing into trees is another example.

That is why any submodule related recursing tries to use the explicit --recurse-submodules instead. Any occurrences of the genric recurse flag are historic accidents.

---

Junio, feel free to just squash this into a future update of the release notes.

Thanks,
Stefan

 Documentation/RelNotes/2.16.0.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RelNotes/2.16.0.txt +1 -1
index 431bd5e34a..8fbc233e56 100644
@@ -275,7 +275,7 @@ Fixes since v2.15
    ask the underlying "git fetch" to go over IPv4/IPv6, which has been
    corrected.
 
- * "git checkout --recursive" may overwrite and rewind the history of
+ * "git checkout --recurse-submodules" may overwrite and rewind the history of
    the branch that happens to be checked out in submodule
    repositories, which might not be desirable.  Detach the HEAD but
    still allow the recursive checkout to succeed in such a case.
Signature · 1 line
2.15.1.424.g9478a66081-goog
#1 lore raw
Quoted 5 lines · Stefan Beller

Junio, feel free to just squash this into a future update
of the release notes.
...
- * "git checkout --recursive" may overwrite and rewind the history of
+ * "git checkout --recurse-submodules" may overwrite and rewind the history of

Thanks.