Skip to content

Commit 29b1b21

Browse files
johnkeepinggitster
authored andcommitted
git-fast-import(1): reorganise options
The options in git-fast-import(1) are not currently arranged in a logical order, which has caused the '--done' options to be documented twice (commit 3266de1). Rearrange them into logical groups under subheadings. Suggested-by: Jonathan Nieder <[email protected]> Signed-off-by: John Keeping <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c8a9f3d commit 29b1b21

File tree

1 file changed

+47
-39
lines changed

1 file changed

+47
-39
lines changed

Documentation/git-fast-import.txt

Lines changed: 47 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,45 @@ the frontend program in use.
3232

3333
OPTIONS
3434
-------
35-
--date-format=<fmt>::
36-
Specify the type of dates the frontend will supply to
37-
fast-import within `author`, `committer` and `tagger` commands.
38-
See ``Date Formats'' below for details about which formats
39-
are supported, and their syntax.
4035

4136
--force::
4237
Force updating modified existing branches, even if doing
4338
so would cause commits to be lost (as the new commit does
4439
not contain the old commit).
4540

46-
--max-pack-size=<n>::
47-
Maximum size of each output packfile.
48-
The default is unlimited.
41+
--quiet::
42+
Disable all non-fatal output, making fast-import silent when it
43+
is successful. This option disables the output shown by
44+
\--stats.
4945

50-
--big-file-threshold=<n>::
51-
Maximum size of a blob that fast-import will attempt to
52-
create a delta for, expressed in bytes. The default is 512m
53-
(512 MiB). Some importers may wish to lower this on systems
54-
with constrained memory.
46+
--stats::
47+
Display some basic statistics about the objects fast-import has
48+
created, the packfiles they were stored into, and the
49+
memory used by fast-import during this run. Showing this output
50+
is currently the default, but can be disabled with \--quiet.
5551

56-
--depth=<n>::
57-
Maximum delta depth, for blob and tree deltification.
58-
Default is 10.
52+
Options for Frontends
53+
~~~~~~~~~~~~~~~~~~~~~
5954

60-
--active-branches=<n>::
61-
Maximum number of branches to maintain active at once.
62-
See ``Memory Utilization'' below for details. Default is 5.
55+
--cat-blob-fd=<fd>::
56+
Specify the file descriptor that will be written to
57+
when the `cat-blob` command is encountered in the stream.
58+
The default behaviour is to write to `stdout`.
59+
60+
--date-format=<fmt>::
61+
Specify the type of dates the frontend will supply to
62+
fast-import within `author`, `committer` and `tagger` commands.
63+
See ``Date Formats'' below for details about which formats
64+
are supported, and their syntax.
65+
66+
--done::
67+
Terminate with error if there is no `done` command at the end of
68+
the stream. This option might be useful for detecting errors
69+
that cause the frontend to terminate before it has started to
70+
write a stream.
71+
72+
Locations of Marks Files
73+
~~~~~~~~~~~~~~~~~~~~~~~~
6374

6475
--export-marks=<file>::
6576
Dumps the internal marks table to <file> when complete.
@@ -93,18 +104,22 @@ OPTIONS
93104
Relative and non-relative marks may be combined by interweaving
94105
--(no-)-relative-marks with the --(import|export)-marks= options.
95106

107+
Performance and Compression Tuning
108+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96109

97-
--cat-blob-fd=<fd>::
98-
Specify the file descriptor that will be written to
99-
when the `cat-blob` command is encountered in the stream.
100-
The default behaviour is to write to `stdout`.
110+
--active-branches=<n>::
111+
Maximum number of branches to maintain active at once.
112+
See ``Memory Utilization'' below for details. Default is 5.
101113

102-
--done::
103-
Terminate with error if there is no `done` command at the
104-
end of the stream.
105-
This option might be useful for detecting errors that
106-
cause the frontend to terminate before it has started to
107-
write a stream.
114+
--big-file-threshold=<n>::
115+
Maximum size of a blob that fast-import will attempt to
116+
create a delta for, expressed in bytes. The default is 512m
117+
(512 MiB). Some importers may wish to lower this on systems
118+
with constrained memory.
119+
120+
--depth=<n>::
121+
Maximum delta depth, for blob and tree deltification.
122+
Default is 10.
108123

109124
--export-pack-edges=<file>::
110125
After creating a packfile, print a line of data to
@@ -115,16 +130,9 @@ Relative and non-relative marks may be combined by interweaving
115130
as these commits can be used as edge points during calls
116131
to 'git pack-objects'.
117132

118-
--quiet::
119-
Disable all non-fatal output, making fast-import silent when it
120-
is successful. This option disables the output shown by
121-
\--stats.
122-
123-
--stats::
124-
Display some basic statistics about the objects fast-import has
125-
created, the packfiles they were stored into, and the
126-
memory used by fast-import during this run. Showing this output
127-
is currently the default, but can be disabled with \--quiet.
133+
--max-pack-size=<n>::
134+
Maximum size of each output packfile.
135+
The default is unlimited.
128136

129137

130138
Performance

0 commit comments

Comments
 (0)