public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: kristofferhaugsbakk@fastmail•com
Cc: git@vger•kernel.org,
	"Kristoffer Haugsbakk" <code@khaugsbakk•name>,
	"Patrick Steinhardt" <ps@pks•im>,
	"Jean-Noël Avila" <jn.avila@free•fr>
Subject: Re: [PATCH 0/5] doc: config: update for the ps/config-subcommands series
Date: Mon, 30 Jun 2025 16:10:15 -0700	[thread overview]
Message-ID: <xmqqwm8sltbc.fsf@gitster.g> (raw)
In-Reply-To: <cover.1751310455.git.code@khaugsbakk.name> (kristofferhaugsbakk@fastmail.com's message of "Mon, 30 Jun 2025 21:10:22 +0200")

kristofferhaugsbakk@fastmail•com writes:

> From: Kristoffer Haugsbakk <code@khaugsbakk•name>
>
> Update git-config(1) according to the ps/config-subcommands series
> (fe3ccc7aab (Merge branch 'ps/config-subcommands', 2024-05-15)):
>
> 1. Document `--show-names`
> 2. Document `--value`
> 3. Mention `--value` throughout instead of the deprecated
>    `value-pattern`
> 4. Mention `--url` in the synopsis
>
> Kristoffer Haugsbakk (5):
>   doc: config: document --[no-]show-names
>   doc: config: use --value=<pattern> consistently
>   doc: config: document --[no-]value
>   doc: config: use --value instead of value-pattern
>   doc: config: mention --url in the synopsis
>
>  Documentation/git-config.adoc | 28 +++++++++++++++++++++-------
>  1 file changed, 21 insertions(+), 7 deletions(-)
>
>
> base-commit: cf6f63ea6bf35173e02e18bdc6a4ba41288acff9

Have you run tests with this series, especially t0450?

$ sh t0450-*.sh -i -v
...
expecting success of 0450.142 'config -h output and SYNOPSIS agree':
                t2s="$(adoc_to_synopsis "$builtin")" &&
                if test "$builtin" = "merge-tree"
                then
                        test_when_finished "rm -f t2s.new" &&
                        sed -e 's/ (deprecated)$//g' <"$t2s" >t2s.new
                        t2s=t2s.new
                fi &&
                h2s="$(help_to_synopsis "$builtin")" &&

                # The *.adoc and -h use different spacing for the
                # alignment of continued usage output, normalize it.
                align_after_nl "$builtin" <"$t2s" >adoc &&
                align_after_nl "$builtin" <"$h2s" >help &&
                test_cmp adoc help

--- adoc        2025-06-30 23:09:02.715600047 +0000
+++ help        2025-06-30 23:09:02.723600026 +0000
@@ -1,7 +1,7 @@
 git config list [<file-option>] [<display-option>] [--includes]
-git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] [--url=<url>] <name>
-git config set [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>
-git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>
+git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<value>] [--fixed-value] [--default=<default>] <name>
+git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>
+git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>
 git config rename-section [<file-option>] <old-name> <new-name>
 git config remove-section [<file-option>] <name>
 git config edit [<file-option>]
not ok 142 - config -h output and SYNOPSIS agree
#
#                       t2s="$(adoc_to_synopsis "$builtin")" &&
#                       if test "$builtin" = "merge-tree"
#                       then
#                               test_when_finished "rm -f t2s.new" &&
#                               sed -e 's/ (deprecated)$//g' <"$t2s" >t2s.new
#                               t2s=t2s.new
#                       fi &&
#                       h2s="$(help_to_synopsis "$builtin")" &&
#
#                       # The *.adoc and -h use different spacing for the
#                       # alignment of continued usage output, normalize it.
#                       align_after_nl "$builtin" <"$t2s" >adoc &&
#                       align_after_nl "$builtin" <"$h2s" >help &&
#                       test_cmp adoc help
#
1..142

  parent reply	other threads:[~2025-06-30 23:10 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-30 19:10 [PATCH 0/5] doc: config: update for the ps/config-subcommands series kristofferhaugsbakk
2025-06-30 19:10 ` [PATCH 1/5] doc: config: document --[no-]show-names kristofferhaugsbakk
2025-06-30 19:10 ` [PATCH 2/5] doc: config: use --value=<pattern> consistently kristofferhaugsbakk
2025-07-01  7:27   ` Kristoffer Haugsbakk
2025-07-01  8:00   ` Kristoffer Haugsbakk
2025-06-30 19:10 ` [PATCH 3/5] doc: config: document --[no-]value kristofferhaugsbakk
2025-06-30 19:26   ` Eric Sunshine
2025-06-30 19:10 ` [PATCH 4/5] doc: config: use --value instead of value-pattern kristofferhaugsbakk
2025-06-30 19:10 ` [PATCH 5/5] doc: config: mention --url in the synopsis kristofferhaugsbakk
2025-07-01  7:09   ` Kristoffer Haugsbakk
2025-06-30 23:10 ` Junio C Hamano [this message]
2025-07-01  7:05   ` [PATCH 0/5] doc: config: update for the ps/config-subcommands series Kristoffer Haugsbakk
2025-07-01 10:01 ` Patrick Steinhardt
2025-07-01 10:15   ` Kristoffer Haugsbakk
2025-07-01 16:03     ` Junio C Hamano
2025-07-01 15:14 ` [PATCH v2 " kristofferhaugsbakk
2025-07-01 15:14   ` [PATCH v2 1/5] doc: config: document --[no-]show-names kristofferhaugsbakk
2025-07-01 15:14   ` [PATCH v2 2/5] config: use --value=<pattern> consistently kristofferhaugsbakk
2025-07-01 15:14   ` [PATCH v2 3/5] doc: config: document --[no-]value kristofferhaugsbakk
2025-07-01 15:14   ` [PATCH v2 4/5] doc: config: use --value instead of value-pattern kristofferhaugsbakk
2025-07-01 15:14   ` [PATCH v2 5/5] config: mention --url in the synopsis kristofferhaugsbakk
2025-07-01 17:32   ` [PATCH v2 0/5] doc: config: update for the ps/config-subcommands series 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=xmqqwm8sltbc.fsf@gitster.g \
    --to=gitster@pobox$(echo .)com \
    --cc=code@khaugsbakk$(echo .)name \
    --cc=git@vger$(echo .)kernel.org \
    --cc=jn.avila@free$(echo .)fr \
    --cc=kristofferhaugsbakk@fastmail$(echo .)com \
    --cc=ps@pks$(echo .)im \
    /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