On 6/2/2025 1:08 PM, Collin Funk wrote: > Jean-Noël AVILA <jn.avila@xxxxxxx> 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 >
