From: Siddharth Asthana <siddharthasthana31@gmail•com>
To: Junio C Hamano <gitster@pobox•com>
Cc: git@vger•kernel.org, christian.couder@gmail•com,
phillip.wood123@gmail•com, phillip.wood@dunelm•org.uk,
newren@gmail•com, ps@pks•im, karthik.188@gmail•com,
code@khaugsbakk•name, rybak.a.v@gmail•com, jltobler@gmail•com,
toon@iotcl•com, johncai86@gmail•com, johannes.schindelin@gmx•de
Subject: Re: [PATCH v3 0/3] replay: make atomic ref updates the default
Date: Wed, 15 Oct 2025 10:35:02 +0530 [thread overview]
Message-ID: <92f9bdec-28ba-45ba-a111-24963d0a300a@gmail.com> (raw)
In-Reply-To: <xmqqtt01w5jh.fsf@gitster.g>
On 15/10/25 02:43, Junio C Hamano wrote:
> When merged to 'seen', this breaks t0450; from the way the test
> breaks, I suspect that it has the same breakage if the topic gets
> tested standalone.
>
> $ make
> $ cd t
> $ sh t0450-txt-doc-vs-help.sh -i -v
> ...
> --- adoc 2025-10-14 21:02:48.680184914 +0000
> +++ help 2025-10-14 21:02:48.688184867 +0000
> @@ -1,2 +1 @@
> -(EXPERIMENTAL!) git replay ([--contained] --onto <newbase> | --advance <branch>)
> - [--update-refs[=<mode>]] <revision-range>...
> +(EXPERIMENTAL!) git replay ([--contained] --onto <newbase> | --advance <branch>) [--update-refs[=<mode>]] <revision-range>...
> not ok ...
>
> In short, "git replay -h" and the initial part of "git replay --help"
> must match.
Thanks for catching this! I actually noticed the CI was failing on
documentation
checks while testing on GitLab before sending v3 to the list. I
initially thought
it was an AsciiDoc line continuation issue and suggested adding a `+` at
the end
of the line, but Christian pointed out that the real issue was likely
the mismatch
between the synopsis and the help output from the command itself.
I split the SYNOPSIS across two lines in the documentation for readability:
(EXPERIMENTAL!) 'git replay' ([--contained] --onto <newbase> |
--advance <branch>)
[--update-refs[=<mode>]] <revision-range>...
But didn't update the usage string in builtin/replay.c to match. Your
patch adding
"\n" and the proper indentation is exactly what's needed:
"(EXPERIMENTAL!) git replay ([--contained] --onto <newbase> |
--advance <branch>)\n"
"\t\t[--update-refs[=<mode>]] <revision-range>..."
I will squash this into the next version. I should have run t0450
locally after
Christian's hint about the synopsis check - I was focused on t3650 and the
functional tests but missed this formatting requirement.
Thanks,
Siddharth
>
> Minimally you'd need to squash in something like the following
> patch. Alternatively, you could match the documentation page (which
> is shown by "git replay --help") to match what "git replay -h" gives.
>
>
> builtin/replay.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git i/builtin/replay.c w/builtin/replay.c
> index 3c618bf100..d0f0492790 100644
> --- i/builtin/replay.c
> +++ w/builtin/replay.c
> @@ -330,7 +330,7 @@ int cmd_replay(int argc,
>
> const char *const replay_usage[] = {
> N_("(EXPERIMENTAL!) git replay "
> - "([--contained] --onto <newbase> | --advance <branch>) "
> + "([--contained] --onto <newbase> | --advance <branch>)\n"
> "[--update-refs[=<mode>]] <revision-range>..."),
> NULL
> };
next prev parent reply other threads:[~2025-10-15 5:05 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-13 18:25 [PATCH v3 0/3] replay: make atomic ref updates the default Siddharth Asthana
2025-10-13 18:25 ` [PATCH v3 1/3] replay: use die_for_incompatible_opt2() for option validation Siddharth Asthana
2025-10-13 19:54 ` Junio C Hamano
2025-10-13 18:25 ` [PATCH v3 2/3] replay: make atomic ref updates the default behavior Siddharth Asthana
2025-10-13 18:25 ` [PATCH v3 3/3] replay: add replay.defaultAction config option Siddharth Asthana
2025-10-13 18:55 ` [PATCH v3 0/3] replay: make atomic ref updates the default Siddharth Asthana
2025-10-14 21:13 ` Junio C Hamano
2025-10-15 5:05 ` Siddharth Asthana [this message]
-- strict thread matches above, loose matches on Subject: below --
2025-09-26 23:08 [PATCH v2 0/1] replay: make atomic ref updates the default behavior Siddharth Asthana
2025-10-13 18:33 ` [PATCH v3 0/3] replay: make atomic ref updates the default Siddharth Asthana
2025-10-13 19:39 ` Junio C Hamano
2025-10-15 4:57 ` Siddharth Asthana
2025-10-15 10:33 ` Christian Couder
2025-10-15 14:45 ` 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=92f9bdec-28ba-45ba-a111-24963d0a300a@gmail.com \
--to=siddharthasthana31@gmail$(echo .)com \
--cc=christian.couder@gmail$(echo .)com \
--cc=code@khaugsbakk$(echo .)name \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=jltobler@gmail$(echo .)com \
--cc=johannes.schindelin@gmx$(echo .)de \
--cc=johncai86@gmail$(echo .)com \
--cc=karthik.188@gmail$(echo .)com \
--cc=newren@gmail$(echo .)com \
--cc=phillip.wood123@gmail$(echo .)com \
--cc=phillip.wood@dunelm$(echo .)org.uk \
--cc=ps@pks$(echo .)im \
--cc=rybak.a.v@gmail$(echo .)com \
--cc=toon@iotcl$(echo .)com \
/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