Re: [PATCH] doc: mention that 'git submodule update' fetches missing commits

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 20, 2019, 02:51 UTC
Message-ID: <xmqq8sobdzul.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <9B605234-8F49-4FEB-9156-22367E01B08B@gmail.com>

Philippe Blain <levraiphilippeblain@gmail.com> writes:

Show 5 quoted lines

> Since 'git pull’ will fetch submodules changes, and is usually
> run first, the commits are usually already there, but I think
> it’s worth mentioning that they will be fetched if they need to.
>
> I like thoroughness in software documentation :)

Where to draw the line between being thorough and being overly verbose with trivial things is subjective, so I generally tend to side with status quo. But after re-reading the updated text, I do not think it is so bad, so let's apply it with a bit of tweak.

The lines prefixed with "++" are with my tweak, "- " are your original changes and " -" are what was in the version before your patch (I CC'ed Pratyush to show this as an example of what I meant by using combined diff to express an amended commit):

$ git diff -c HEAD HEAD@{1} HEAD^ diff --combined Documentation/git-submodule.txt index 16c765cbfa,0ed5c24dc1..4beb569ae5

--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@@ -133,8 -133,7 +133,8 @@@ update [--init] [--remote] [-N|--no-fet
  +
  --
  Update the registered submodules to match what the superproject
- expects by cloning missing submodules, fetching missing submodule commits
- and updating the working tree of
 -expects by cloning missing submodules and updating the working tree of
++expects by cloning missing submodules, fetching missing commits
++in submodules and updating the working tree of
  the submodules. The "updating" can be done in several ways depending
  on command line options and the value of `submodule.<name>.update`
  configuration variable. The command line option takes precedence over