git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Stefan Beller <sbeller@google.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, Stefan Beller <sbeller@google.com>
Subject: [PATCH] RelNotes/2.16: Fix submodule recursing argument
Date: Thu,  7 Dec 2017 11:51:45 -0800	[thread overview]
Message-ID: <20171207195145.11965-1-sbeller@google.com> (raw)

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.

Signed-off-by: Stefan Beller <sbeller@google.com>
---

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(-)

diff --git a/Documentation/RelNotes/2.16.0.txt b/Documentation/RelNotes/2.16.0.txt
index 431bd5e34a..8fbc233e56 100644
--- a/Documentation/RelNotes/2.16.0.txt
+++ b/Documentation/RelNotes/2.16.0.txt
@@ -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.
-- 
2.15.1.424.g9478a66081-goog


             reply	other threads:[~2017-12-07 19:51 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-07 19:51 Stefan Beller [this message]
2017-12-07 20:35 ` [PATCH] RelNotes/2.16: Fix submodule recursing argument Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171207195145.11965-1-sbeller@google.com \
    --to=sbeller@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).