git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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.
Previous: Christian CouderNext: Patrick Steinhardt
Message 2 of 3 in “fast-export: standardize usage string and SYNOPSIS”
  1. fast-export: standardize usage string and SYNOPSISChristian Couder, Jul 13, 2026
  2. Junio C HamanoJul 13, 2026
  3. Patrick SteinhardtJul 14, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.