git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Petar Vutov <pvutov@imap.cc>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc: remove mentions of .gitmodules !command syntax
Date: Wed, 12 Jul 2023 13:33:55 -0700	[thread overview]
Message-ID: <xmqqa5w0swcs.fsf@gitster.g> (raw)
In-Reply-To: <7090349c-4485-d5c4-1f26-190974864f72@imap.cc> (Petar Vutov's message of "Wed, 12 Jul 2023 20:48:10 +0200")

Petar Vutov <pvutov@imap.cc> writes:

> On 7/12/23 19:54, Junio C Hamano wrote:
>> Perhaps
>>      "... available via the ... configuration variable, and cannot
>> be
>>      used in the .gitmodules file"
>> would have helped you?
>> Thanks.
>
> I think that addition is good and makes the intent clearer.
>
> But it's slightly wrong - only 'custom command' cannot be used in
> .gitmodules. 'none' is legal (and mentioned in the gitmodules doc as
> such).

Hmph, that will be a bugfix for fc01a5d2 (submodule update
documentation: don't repeat ourselves, 2016-12-27).  I think you are
technically correct.

    Side note: but is there a useful use case to set it to 'none' in
    ".gitmodules" in the first place?  If there is not, saying that
    "'none' is only useful in the configuration files" is not quite
    wrong per-se.

>  	merge;; the commit recorded in the superproject will be merged
>  	    into the current branch in the submodule.
>
> -The following 'update' procedures are only available via the
> -`submodule.<name>.update` configuration variable:
> -
>  	custom command;; arbitrary shell command that takes a single
>  	    argument (the sha1 of the commit recorded in the
>  	    superproject) is executed. When `submodule.<name>.update`
>  	    is set to '!command', the remainder after the exclamation mark
>  	    is the custom command.
> ++
> +Custom commands are only available via the `submodule.<name>.update`
> +configuration variable. They cannot be used in the .gitmodules file.

Sounds good.  s/available/allowed/, perhaps.

>  	none;; the submodule is not updated.
> ++
> +The `none` update procedure is only available via the .gitmodules file
> +or the `submodule.<name>.update` configuration variable.

This side we do not need "only" anywhere in the sentence, do we?

Thanks.

  reply	other threads:[~2023-07-12 20:34 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-12 16:02 [PATCH] doc: remove mentions of .gitmodules !command syntax pvutov
2023-07-12 16:40 ` Junio C Hamano
2023-07-12 17:30   ` Petar Vutov
2023-07-12 17:54     ` Junio C Hamano
2023-07-12 18:48       ` Petar Vutov
2023-07-12 20:33         ` Junio C Hamano [this message]
2023-07-13 19:20           ` Petar Vutov
2023-07-13 19:33             ` Junio C Hamano
2023-07-13 19:33     ` [PATCH v3 1/1] docs: highlight that .gitmodules does not support !command pvutov
2023-07-13 19:38       ` Junio C Hamano
2023-07-13 19:46       ` Petar Vutov
2023-07-13 19:55         ` Junio C Hamano
2023-07-13 20:34           ` Petar Vutov
2023-07-13 20:55             ` Junio C Hamano
2023-07-13 21:37               ` Junio C Hamano
2023-07-13 21:47                 ` Petar Vutov
2023-07-13 22:28                   ` Junio C Hamano
2023-07-14 22:03                 ` Petar Vutov
2023-07-25 18:17                   ` Junio C Hamano
2023-07-25 21:22                     ` [PATCH v5] doc: " pvutov
2023-07-25 21:56                       ` Junio C Hamano
2023-07-13 20:34       ` [PATCH v4] docs: " pvutov

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

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

  git send-email \
    --in-reply-to=xmqqa5w0swcs.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=pvutov@imap.cc \
    /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.
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 NNTP newsgroup(s).