undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'jk/maint-fast-import-doc-reorder'

Browse Source 
* jk/maint-fast-import-doc-reorder:
  git-fast-import(1): reorganise options
  git-fast-import(1): combine documentation of --[no-]relative-marks
This commit is contained in:
Junio C Hamano 2013-01-11 18:35:07 -08:00
commit a96e8078a9
1 changed files with 52 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
Documentation/git-fast-import.txt
View File

@ -33,34 +33,46 @@ the frontend program in use.
OPTIONS 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::
Force updating modified existing branches, even if doing Force updating modified existing branches, even if doing
so would cause commits to be lost (as the new commit does so would cause commits to be lost (as the new commit does
not contain the old commit). not contain the old commit).
--max-pack-size=<n>:: --quiet::
Maximum size of each output packfile. Disable all non-fatal output, making fast-import silent when it
The default is unlimited. is successful. This option disables the output shown by
\--stats.
--big-file-threshold=<n>:: --stats::
Maximum size of a blob that fast-import will attempt to Display some basic statistics about the objects fast-import has
create a delta for, expressed in bytes. The default is 512m created, the packfiles they were stored into, and the
(512 MiB). Some importers may wish to lower this on systems memory used by fast-import during this run. Showing this output
with constrained memory. is currently the default, but can be disabled with \--quiet.
--depth=<n>:: Options for Frontends
Maximum delta depth, for blob and tree deltification. ~~~~~~~~~~~~~~~~~~~~~
Default is 10.
--active-branches=<n>:: --cat-blob-fd=<fd>::
Maximum number of branches to maintain active at once. Write responses to `cat-blob` and `ls` queries to the
See ``Memory Utilization'' below for details. Default is 5. 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>:: --export-marks=<file>::
Dumps the internal marks table to <file> when complete. Dumps the internal marks table to <file> when complete.
@ -83,32 +95,33 @@ OPTIONS
Like --import-marks but instead of erroring out, silently Like --import-marks but instead of erroring out, silently
skips the file if it does not exist. skips the file if it does not exist.
--relative-marks:: --[no-]relative-marks::
After specifying --relative-marks the paths specified After specifying --relative-marks the paths specified
with --import-marks= and --export-marks= are relative with --import-marks= and --export-marks= are relative
to an internal directory in the current repository. to an internal directory in the current repository.
In git-fast-import this means that the paths are relative In git-fast-import this means that the paths are relative
to the .git/info/fast-import directory. However, other to the .git/info/fast-import directory. However, other
importers may use a different location. 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:: Performance and Compression Tuning
Negates a previous --relative-marks. Allows for combining ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
relative and non-relative marks by interweaving
--(no-)-relative-marks with the --(import|export)-marks=
options.
--cat-blob-fd=<fd>:: --active-branches=<n>::
Write responses to `cat-blob` and `ls` queries to the Maximum number of branches to maintain active at once.
file descriptor <fd> instead of `stdout`. Allows `progress` See ``Memory Utilization'' below for details. Default is 5.
output intended for the end-user to be separated from other
output.
--done:: --big-file-threshold=<n>::
Terminate with error if there is no `done` command at the Maximum size of a blob that fast-import will attempt to
end of the stream. create a delta for, expressed in bytes. The default is 512m
This option might be useful for detecting errors that (512 MiB). Some importers may wish to lower this on systems
cause the frontend to terminate before it has started to with constrained memory.
write a stream.
--depth=<n>::
Maximum delta depth, for blob and tree deltification.
Default is 10.
--export-pack-edges=<file>:: --export-pack-edges=<file>::
After creating a packfile, print a line of data to After creating a packfile, print a line of data to
@ -119,16 +132,9 @@ OPTIONS
as these commits can be used as edge points during calls as these commits can be used as edge points during calls
to 'git pack-objects'. to 'git pack-objects'.
--quiet:: --max-pack-size=<n>::
Disable all non-fatal output, making fast-import silent when it Maximum size of each output packfile.
is successful. This option disables the output shown by The default is unlimited.
\--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.
Performance Performance