]> git.ipfire.org Git - thirdparty/git.git/commitdiff
fast-export: standardize usage string and SYNOPSIS
authorChristian Couder <christian.couder@gmail.com>
Mon, 13 Jul 2026 12:41:53 +0000 (14:41 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 13 Jul 2026 15:54:29 +0000 (08:54 -0700)
The output of `git fast-export -h` currently starts with:

  usage: git fast-export [<rev-list-opts>]

while the SYNOPSIS section in this command's documentation shows:

  'git fast-export' [<options>] | 'git fast-import'

Let's make both of these consistent with each other and with other Git
commands by describing the arguments with:

  [<options>] [<revision-range>] [[--] <path>...]

This takes into account the following:

  - `git fast-export` accepts both rev-list arguments and a number of
    genuine options of its own (--[no-]progress, --[no-]signed-tags,
    --[no-]signed-commits, etc).

  - `git fast-export` was the only command using `[<rev-list-opts>]`
    while many other commands describe their revision arguments as
    `[<revision-range>] [[--] <path>...]`.

  - In the DESCRIPTION section of the documentation, it's already
    mentioned several times that the output should eventually be fed to
    `git fast-import`.

This also enables us to remove fast-export from
"t/t0450/adoc-help-mismatches".

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-fast-export.adoc
builtin/fast-export.c
t/t0450/adoc-help-mismatches

index 297b57bb2efdc2455ae87e98d3ef14ae5e833751..719aeca244d53408fc64242f1b298979ef3c18e3 100644 (file)
@@ -9,7 +9,7 @@ git-fast-export - Git data exporter
 SYNOPSIS
 --------
 [verse]
-'git fast-export' [<options>] | 'git fast-import'
+'git fast-export' [<options>] [<revision-range>] [[--] <path>...]
 
 DESCRIPTION
 -----------
index 0be43104dc0d23f9cef7e4b17a58e388ce281f31..629d7c591a9d70d9d246e479fd1b594fe21852cd 100644 (file)
@@ -33,7 +33,7 @@
 #include "gpg-interface.h"
 
 static const char *const fast_export_usage[] = {
-       N_("git fast-export [<rev-list-opts>]"),
+       N_("git fast-export [<options>] [<revision-range>] [[--] <path>...]"),
        NULL
 };
 
index e8d6c13ccd0333614acf0d31c9b2613f80d1fc1b..c4a55ff4e35a4fa54ddf0087961d24f58a9a6bfc 100644 (file)
@@ -12,7 +12,6 @@ column
 credential
 credential-cache
 credential-store
-fast-export
 fast-import
 fetch-pack
 fmt-merge-msg