Skip to content

Commit a96e807

Browse files
committed
Merge branch 'jk/maint-fast-import-doc-reorder'
* jk/maint-fast-import-doc-reorder: git-fast-import(1): reorganise options git-fast-import(1): combine documentation of --[no-]relative-marks
2 parents 79637a4 + 29b1b21 commit a96e807

File tree

1 file changed

+52
-46
lines changed

1 file changed

+52
-46
lines changed

Documentation/git-fast-import.txt

Lines changed: 52 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -33,34 +33,46 @@ the frontend program in use.
3333

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

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

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

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

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

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

6577
--export-marks=<file>::
6678
Dumps the internal marks table to <file> when complete.
@@ -83,32 +95,33 @@ OPTIONS
8395
Like --import-marks but instead of erroring out, silently
8496
skips the file if it does not exist.
8597

86-
--relative-marks::
98+
--[no-]relative-marks::
8799
After specifying --relative-marks the paths specified
88100
with --import-marks= and --export-marks= are relative
89101
to an internal directory in the current repository.
90102
In git-fast-import this means that the paths are relative
91103
to the .git/info/fast-import directory. However, other
92104
importers may use a different location.
105+
+
106+
Relative and non-relative marks may be combined by interweaving
107+
--(no-)-relative-marks with the --(import|export)-marks= options.
93108

94-
--no-relative-marks::
95-
Negates a previous --relative-marks. Allows for combining
96-
relative and non-relative marks by interweaving
97-
--(no-)-relative-marks with the --(import|export)-marks=
98-
options.
109+
Performance and Compression Tuning
110+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99111

100-
--cat-blob-fd=<fd>::
101-
Write responses to `cat-blob` and `ls` queries to the
102-
file descriptor <fd> instead of `stdout`. Allows `progress`
103-
output intended for the end-user to be separated from other
104-
output.
112+
--active-branches=<n>::
113+
Maximum number of branches to maintain active at once.
114+
See ``Memory Utilization'' below for details. Default is 5.
105115

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

113126
--export-pack-edges=<file>::
114127
After creating a packfile, print a line of data to
@@ -119,16 +132,9 @@ OPTIONS
119132
as these commits can be used as edge points during calls
120133
to 'git pack-objects'.
121134

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

133139

134140
Performance

0 commit comments

Comments
 (0)