mirror of
https://github.com/git/git
synced 2024-08-27 11:39:22 +00:00
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 3266de10
).
Rearrange them into logical groups under subheadings.
Suggested-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: John Keeping <john@keeping.me.uk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
c8a9f3d385
commit
29b1b21f07
|
@ -32,34 +32,45 @@ the frontend program in use.
|
|||
|
||||
OPTIONS
|
||||
-------
|
||||
--date-format=<fmt>::
|
||||
Specify the type of dates the frontend will supply to
|
||||
fast-import within `author`, `committer` and `tagger` commands.
|
||||
See ``Date Formats'' below for details about which formats
|
||||
are supported, and their syntax.
|
||||
|
||||
--force::
|
||||
Force updating modified existing branches, even if doing
|
||||
so would cause commits to be lost (as the new commit does
|
||||
not contain the old commit).
|
||||
|
||||
--max-pack-size=<n>::
|
||||
Maximum size of each output packfile.
|
||||
The default is unlimited.
|
||||
--quiet::
|
||||
Disable all non-fatal output, making fast-import silent when it
|
||||
is successful. This option disables the output shown by
|
||||
\--stats.
|
||||
|
||||
--big-file-threshold=<n>::
|
||||
Maximum size of a blob that fast-import will attempt to
|
||||
create a delta for, expressed in bytes. The default is 512m
|
||||
(512 MiB). Some importers may wish to lower this on systems
|
||||
with constrained memory.
|
||||
--stats::
|
||||
Display some basic statistics about the objects fast-import has
|
||||
created, the packfiles they were stored into, and the
|
||||
memory used by fast-import during this run. Showing this output
|
||||
is currently the default, but can be disabled with \--quiet.
|
||||
|
||||
--depth=<n>::
|
||||
Maximum delta depth, for blob and tree deltification.
|
||||
Default is 10.
|
||||
Options for Frontends
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
--active-branches=<n>::
|
||||
Maximum number of branches to maintain active at once.
|
||||
See ``Memory Utilization'' below for details. Default is 5.
|
||||
--cat-blob-fd=<fd>::
|
||||
Specify the file descriptor that will be written to
|
||||
when the `cat-blob` command is encountered in the stream.
|
||||
The default behaviour is to write to `stdout`.
|
||||
|
||||
--date-format=<fmt>::
|
||||
Specify the type of dates the frontend will supply to
|
||||
fast-import within `author`, `committer` and `tagger` commands.
|
||||
See ``Date Formats'' below for details about which formats
|
||||
are supported, and their syntax.
|
||||
|
||||
--done::
|
||||
Terminate with error if there is no `done` command at the end of
|
||||
the stream. This option might be useful for detecting errors
|
||||
that cause the frontend to terminate before it has started to
|
||||
write a stream.
|
||||
|
||||
Locations of Marks Files
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
--export-marks=<file>::
|
||||
Dumps the internal marks table to <file> when complete.
|
||||
|
@ -93,18 +104,22 @@ OPTIONS
|
|||
Relative and non-relative marks may be combined by interweaving
|
||||
--(no-)-relative-marks with the --(import|export)-marks= options.
|
||||
|
||||
Performance and Compression Tuning
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
--cat-blob-fd=<fd>::
|
||||
Specify the file descriptor that will be written to
|
||||
when the `cat-blob` command is encountered in the stream.
|
||||
The default behaviour is to write to `stdout`.
|
||||
--active-branches=<n>::
|
||||
Maximum number of branches to maintain active at once.
|
||||
See ``Memory Utilization'' below for details. Default is 5.
|
||||
|
||||
--done::
|
||||
Terminate with error if there is no `done` command at the
|
||||
end of the stream.
|
||||
This option might be useful for detecting errors that
|
||||
cause the frontend to terminate before it has started to
|
||||
write a stream.
|
||||
--big-file-threshold=<n>::
|
||||
Maximum size of a blob that fast-import will attempt to
|
||||
create a delta for, expressed in bytes. The default is 512m
|
||||
(512 MiB). Some importers may wish to lower this on systems
|
||||
with constrained memory.
|
||||
|
||||
--depth=<n>::
|
||||
Maximum delta depth, for blob and tree deltification.
|
||||
Default is 10.
|
||||
|
||||
--export-pack-edges=<file>::
|
||||
After creating a packfile, print a line of data to
|
||||
|
@ -115,16 +130,9 @@ Relative and non-relative marks may be combined by interweaving
|
|||
as these commits can be used as edge points during calls
|
||||
to 'git pack-objects'.
|
||||
|
||||
--quiet::
|
||||
Disable all non-fatal output, making fast-import silent when it
|
||||
is successful. This option disables the output shown by
|
||||
\--stats.
|
||||
|
||||
--stats::
|
||||
Display some basic statistics about the objects fast-import has
|
||||
created, the packfiles they were stored into, and the
|
||||
memory used by fast-import during this run. Showing this output
|
||||
is currently the default, but can be disabled with \--quiet.
|
||||
--max-pack-size=<n>::
|
||||
Maximum size of each output packfile.
|
||||
The default is unlimited.
|
||||
|
||||
|
||||
Performance
|
||||
|
|
Loading…
Reference in a new issue