Skip to content

Commit 173831e

Browse files
committed
backfill: document acceptance of revision-range in more standard manner
302aff0 (backfill: accept revision arguments, 2026-03-26) added support for passing revision arguments to 'git backfill' but documented them only with a prose sentence: You may also specify the commit limiting options from git-rev-list(1). No other command that accepts revision arguments documents them this way. Commands like log, shortlog, and replay define a formal <revision-range> entry and include rev-list-options.adoc. Commands like bundle, fast-export, and filter-branch, which pass arguments through to the revision machinery without including the full options file, still define a formal <git-rev-list-args> entry explaining what is accepted. Add a formal <revision-range> entry in the synopsis and OPTIONS section, following the convention used by other commands, and mention that commit-limiting options from git-rev-list(1) are also accepted. Signed-off-by: Elijah Newren <newren@gmail.com>
1 parent 6c76f1e commit 173831e

2 files changed

Lines changed: 13 additions & 4 deletions

File tree

Documentation/git-backfill.adoc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-backfill - Download missing objects in a partial clone
99
SYNOPSIS
1010
--------
1111
[synopsis]
12-
git backfill [--min-batch-size=<n>] [--[no-]sparse]
12+
git backfill [--min-batch-size=<n>] [--[no-]sparse] [<revision-range>]
1313

1414
DESCRIPTION
1515
-----------
@@ -43,7 +43,7 @@ smaller network calls than downloading the entire repository at clone
4343
time.
4444

4545
By default, `git backfill` downloads all blobs reachable from the `HEAD`
46-
commit. This set can be restricted or expanded using various options.
46+
commit. This set can be restricted or expanded using various options below.
4747

4848
THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR MAY CHANGE IN THE FUTURE.
4949

@@ -63,7 +63,16 @@ OPTIONS
6363
current sparse-checkout. If the sparse-checkout feature is enabled,
6464
then `--sparse` is assumed and can be disabled with `--no-sparse`.
6565

66-
You may also specify the commit limiting options from linkgit:git-rev-list[1].
66+
`<revision-range>`::
67+
Backfill only blobs reachable from commits in the specified
68+
revision range. When no _<revision-range>_ is specified, it
69+
defaults to `HEAD` (i.e. the whole history leading to the
70+
current commit). For a complete list of ways to spell
71+
_<revision-range>_, see the "Specifying Ranges" section of
72+
linkgit:gitrevisions[7].
73+
+
74+
You may also use commit-limiting options understood by
75+
linkgit:git-rev-list[1] such as `--first-parent`, `--since`, or pathspecs.
6776

6877
SEE ALSO
6978
--------

builtin/backfill.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
#include "path-walk.h"
2727

2828
static const char * const builtin_backfill_usage[] = {
29-
N_("git backfill [--min-batch-size=<n>] [--[no-]sparse]"),
29+
N_("git backfill [--min-batch-size=<n>] [--[no-]sparse] [<revision-range>]"),
3030
NULL
3131
};
3232

0 commit comments

Comments
 (0)