From: Junio C Hamano <gitster@pobox.com>
To: Christian Couder <christian.couder@gmail.com>
Cc: git@vger.kernel.org, Patrick Steinhardt <ps@pks.im>,
Elijah Newren <newren@gmail.com>, Jeff King <peff@peff.net>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Justin Tobler <jltobler@gmail.com>,
Christian Couder <chriscool@tuxfamily.org>
Subject: Re: [PATCH] fast-export: standardize usage string and SYNOPSIS
Date: Mon, 13 Jul 2026 08:54:06 -0700 [thread overview]
Message-ID: <xmqq4ii228dd.fsf@gitster.g> (raw)
In-Reply-To: <20260713124153.245268-1-christian.couder@gmail.com> (Christian Couder's message of "Mon, 13 Jul 2026 14:41:53 +0200")
Christian Couder <christian.couder@gmail.com> writes:
> The output of `git fast-export -h` currently starts with:
> ...
> This also enables us to remove fast-export from
> "t/t0450/adoc-help-mismatches".
Improving consistency and eliminating special cases are both
positive steps forward. Nice work.
> diff --git a/Documentation/git-fast-export.adoc b/Documentation/git-fast-export.adoc
> index 297b57bb2e..719aeca244 100644
> --- a/Documentation/git-fast-export.adoc
> +++ b/Documentation/git-fast-export.adoc
> @@ -9,7 +9,7 @@ git-fast-export - Git data exporter
> SYNOPSIS
> --------
> [verse]
> -'git fast-export' [<options>] | 'git fast-import'
While this was well-intentioned (demonstrating a typical usage
pattern to show readers that the command's output is meant to be
consumed by 'fast-import'), it is highly unusual for a synopsis.
Examples of this nature are better suited for the body of the manual
pages.
> +'git fast-export' [<options>] [<revision-range>] [[--] <path>...]
This updated version is much more consistent with other manual
pages.
Nice. Will queue. Thanks.
next prev parent reply other threads:[~2026-07-13 15:54 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-13 12:41 [PATCH] fast-export: standardize usage string and SYNOPSIS Christian Couder
2026-07-13 15:54 ` Junio C Hamano [this message]
2026-07-14 8:54 ` Patrick Steinhardt
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=xmqq4ii228dd.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=chriscool@tuxfamily.org \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=jltobler@gmail.com \
--cc=newren@gmail.com \
--cc=peff@peff.net \
--cc=ps@pks.im \
--cc=sandals@crustytoothpaste.net \
/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