Skip to content

Commit

Permalink
Merge branch 'jk/maint-fast-import-doc-reorder' into maint
Browse files Browse the repository at this point in the history
* jk/maint-fast-import-doc-reorder:
  git-fast-import(1): reorganise options
  git-fast-import(1): combine documentation of --[no-]relative-marks
  • Loading branch information
gitster committed Jan 14, 2013
2 parents 74abc17 + 29b1b21 commit 267aaa0
Showing 1 changed file with 52 additions and 46 deletions.
98 changes: 52 additions & 46 deletions Documentation/git-fast-import.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,34 +33,46 @@ 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>::
Write responses to `cat-blob` and `ls` queries to the
file descriptor <fd> instead of `stdout`. Allows `progress`
output intended for the end-user to be separated from other
output.

--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.
Expand All @@ -83,32 +95,33 @@ OPTIONS
Like --import-marks but instead of erroring out, silently
skips the file if it does not exist.

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

--no-relative-marks::
Negates a previous --relative-marks. Allows for combining
relative and non-relative marks by interweaving
--(no-)-relative-marks with the --(import|export)-marks=
options.
Performance and Compression Tuning
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

--cat-blob-fd=<fd>::
Write responses to `cat-blob` and `ls` queries to the
file descriptor <fd> instead of `stdout`. Allows `progress`
output intended for the end-user to be separated from other
output.
--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
Expand All @@ -119,16 +132,9 @@ OPTIONS
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
Expand Down

0 comments on commit 267aaa0

Please sign in to comment.