git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Documentation: consolidate submodule.<name>.update

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Sep 25, 2017, 22:22 UTC
Message-ID
<20170925222229.GG27425@aiede.mtv.corp.google.com>
In-Reply-To
<CAGZ79kZZJe=EYh7wecAWneVKrWoBLrPoWuMWmC219vzWVzP6mA@mail.gmail.com>
Stefan Beller wrote:
> On Mon, Sep 25, 2017 at 12:17 PM, Brandon Williams <bmwill@google.com> wrote:
>> On 09/25, Stefan Beller wrote:
Show 30 quoted lines
>>> Have one place to explain the effects of setting submodule.<name>.update
>>> instead of two.
>>>
>>> Signed-off-by: Stefan Beller <sbeller@google.com>
>>> ---
>>>>> I disagree.  Actually, I think the git-config(1) blurb could just
>>>>> point here, and that the text here ought to be clear about what
>>>>> commands it affects and how an end user would use it.
>>>>
>>>> I tend to agree with the consolidation.
>>>
>>> Something like this?
>>
>> I like the consolidation, its easier to keep up to date when its only in
>> one place.
>
> After thinking about it further, I'd like to withdraw this patch
> for now.
>
> The reason is that this would also forward point to
> git-submodule.txt, such that we'd still have 2 places
> in which it is explained. The current situation with explaining
> it in 3 places is not too bad as each place hints at their specific
> circumstance:
> git-submodule.txt explains the values to set itself.
> gitmodules.txt explains what the possible fields in that file are,
>   and regarding this field it points out it is ignored in the init call.
> config.txt: actually describe the effects of the setting.
>
> I think we can keep it as-is for now.
Sorry, I got lost.  Which state is as-is?

As a user, how do I find out what submodule.*.update is going to do and which commands will respect it?

Maybe we should work on first wordsmithing the doc and then figuring out where it goes? The current state of the doc with (?) three different texts, all wrong, doesn't seem like a good state to preserve.

Thanks, Jonathan

Previous: Stefan BellerNext: Stefan Beller
Message 9 of 12 in “Documentation/config: clarify the meaning of submodule.<name>.update”
  1. Documentation/config: clarify the meaning of submodule.<name>.updateStefan Beller, Sep 22, 2017
  2. Jonathan NiederSep 22, 2017
  3. [PATCHv2] Documentation/config: clarify the meaning of submodule.<name>.updateStefan Beller, Sep 22, 2017
  4. Jonathan NiederSep 22, 2017
  5. Junio C HamanoSep 23, 2017
  6. Documentation: consolidate submodule.<name>.updateStefan Beller, Sep 25, 2017
  7. Brandon WilliamsSep 25, 2017
  8. Stefan BellerSep 25, 2017
  9. Jonathan NiederSep 25, 2017
  10. Stefan BellerSep 25, 2017
  11. Jonathan NiederSep 25, 2017
  12. Junio C HamanoSep 26, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.