Re: [PATCH] fast-export: standardize usage string and SYNOPSIS
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jul 13, 2026, 15:54 UTC
- Message-ID
- <xmqq4ii228dd.fsf@gitster.g>
- In-Reply-To
- <20260713124153.245268-1-christian.couder@gmail.com>
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.
Show 9 quoted lines
> 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.