From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 16 Jan 2014 21:55:37 GMT
Subject: Re: [PATCH v4 6/6] Documentation: Describe 'submodule update' modes in detail
Message-ID: <xmqqy52fy4km.fsf@gitster.dls.corp.google.com>
In-Reply-To: <20140116205521.GY2647@odin.tremily.us>

"W. Trevor King" <wking@tremily.us> writes:

>> A naïve expectation from a casual reader of the above would be "The
>> superproject's tree ought to point at the same commit as the tip of
>> the branch used in the submodule (modulo mirroring delays and
>> somesuch),
>
> What is the branch used in the submodule?  The remote subproject's
> current submodule.<name>.branch?  The local submodule's
> submodule.<name>.branch (or localBranch) branch?  The submodule's
> current HEAD?

They are good questions that such casual readers would have, and
giving answers to them in this part of the documentation would be a
good way to give them a clear picture of how the command is designed
to be used.