From: Jacob Keller <jacob.e.keller@intel•com>
To: "Collin Funk" <collin.funk1@gmail•com>,
"Jean-Noël AVILA" <jn.avila@free•fr>
Cc: <git@vger•kernel.org>, Junio C Hamano <gitster@pobox•com>
Subject: Re: [PATCH v2] completion: Make sed command that generates config-list.h portable.
Date: Mon, 2 Jun 2025 14:42:27 -0700 [thread overview]
Message-ID: <e6a4b604-c5b7-450a-b4f5-3863441e0c6e@intel.com> (raw)
In-Reply-To: <875xhducs7.fsf@gmail.com>
On 6/2/2025 1:08 PM, Collin Funk wrote:
> Jean-Noël AVILA <jn.avila@free•fr> writes:
>
>> Your commit message has some issues:
>>
>> * upper case in "Make": prefixed commits message must be lower case
>> * to be correct, the bug was already there at the first introduction of the
>> generate-configlist.sh script (3ac68a9). The '\n' was there, and the generated
>> .h file had two wrong strings such as
>> "gitcvs.dbUserngitcvs.dbPass" . My patch only put it in light by breaking the
>> build.
>
> Thanks, I will keep that in mind for V3.
>
>> Maybe an alternative way of fixing the issue is to just rework the
>> documentation on the two spots where a comma is used and put each config
>> variable on its own line.
>>
>> What do you think?
>
> Regarding readability, it is not any worse than it was originally. But
> maybe that is because you are much better at sed than me. :)
>
> But we could put configurations on seperate lines like so:
>
> diff --git a/Documentation/config/gitcvs.adoc b/Documentation/config/gitcvs.adoc
> index 02da427fd9..31d7be3992 100644
> --- a/Documentation/config/gitcvs.adoc
> +++ b/Documentation/config/gitcvs.adoc
> @@ -47,7 +47,8 @@ gitcvs.dbDriver::
> May not contain double colons (`:`). Default: 'SQLite'.
> See linkgit:git-cvsserver[1].
>
> -gitcvs.dbUser, gitcvs.dbPass::
> +gitcvs.dbUser::
> +gitcvs.dbPass::
> Database user and password. Only useful if setting `gitcvs.dbDriver`,
> since SQLite has no concept of database users and/or passwords.
> 'gitcvs.dbUser' supports variable substitution (see
> diff --git a/Documentation/config/http.adoc b/Documentation/config/http.adoc
> index 67393282fa..9da5c298cc 100644
> --- a/Documentation/config/http.adoc
> +++ b/Documentation/config/http.adoc
> @@ -289,7 +289,8 @@ for most push problems, but can increase memory consumption
> significantly since the entire buffer is allocated even for small
> pushes.
>
> -http.lowSpeedLimit, http.lowSpeedTime::
> +http.lowSpeedLimit::
> +http.lowSpeedTime::
> If the HTTP transfer speed, in bytes per second, is less than
> 'http.lowSpeedLimit' for longer than 'http.lowSpeedTime' seconds,
> the transfer is aborted.
>
> This is similar to how options are documented, for example:
>
> $ head Documentation/pretty-options.adoc
> --pretty[=<format>]::
> --format=<format>::
>
> Pretty-print the contents of the commit logs in a given format,
> where '<format>' can be one of 'oneline', 'short', 'medium',
> 'full', 'fuller', 'reference', 'email', 'raw', 'format:<string>'
> and 'tformat:<string>'. When '<format>' is none of the above,
> and has '%placeholder' in it, it acts as if
> '--pretty=tformat:<format>' were given.
>
> Then go back to the simpler sed expression before your most recent
> commit. I will wait for others thoughts before posting v3.
>
I like this approach.
> Thanks,
> Collin
>
next prev parent reply other threads:[~2025-06-02 21:42 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-02 18:41 [PATCH] completion: Make sed command that generates config-list.h portable Collin Funk
2025-06-02 19:05 ` Brad Smith
2025-06-02 19:05 ` Jean-Noël AVILA
2025-06-02 19:20 ` Collin Funk
2025-06-02 19:26 ` [PATCH v2] " Collin Funk
2025-06-02 19:49 ` Jean-Noël AVILA
2025-06-02 20:08 ` Collin Funk
2025-06-02 21:42 ` Jacob Keller [this message]
2025-06-02 22:35 ` Collin Funk
2025-06-03 0:21 ` Junio C Hamano
2025-06-03 0:49 ` [PATCH] CodingGuidelines: document formatting required by generate-configlist.sh Collin Funk
2025-06-03 14:54 ` Junio C Hamano
2025-06-03 18:56 ` Collin Funk
2025-06-03 20:43 ` Junio C Hamano
2025-06-03 22:49 ` Collin Funk
2025-06-03 22:45 ` [PATCH v2] CodingGuidelines: document formatting of similar config variables Collin Funk
2025-06-03 23:57 ` Junio C Hamano
2025-06-02 22:31 ` [PATCH v3] completion: make sed command that generates config-list.h portable Collin Funk
2025-06-02 23:05 ` Keller, Jacob E
2025-06-03 0:17 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e6a4b604-c5b7-450a-b4f5-3863441e0c6e@intel.com \
--to=jacob.e.keller@intel$(echo .)com \
--cc=collin.funk1@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=jn.avila@free$(echo .)fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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