.gitignore: "git-verify-commit" is a generated file
[git.git] / Documentation / git-fast-import.txt
1 git-fast-import(1)
2 ==================
5 ----
6 git-fast-import - Backend for fast Git data importers
10 --------
11 [verse]
12 frontend | 'git fast-import' [options]
15 -----------
16 This program is usually not what the end user wants to run directly.
17 Most end users want to use one of the existing frontend programs,
18 which parses a specific type of foreign source and feeds the contents
19 stored there to 'git fast-import'.
21 fast-import reads a mixed command/data stream from standard input and
22 writes one or more packfiles directly into the current repository.
23 When EOF is received on standard input, fast import writes out
24 updated branch and tag refs, fully updating the current repository
25 with the newly imported data.
27 The fast-import backend itself can import into an empty repository (one that
28 has already been initialized by 'git init') or incrementally
29 update an existing populated repository.  Whether or not incremental
30 imports are supported from a particular foreign source depends on
31 the frontend program in use.
35 -------
37 --force::
38         Force updating modified existing branches, even if doing
39         so would cause commits to be lost (as the new commit does
40         not contain the old commit).
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.
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.
53 Options for Frontends
54 ~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
74 Locations of Marks Files
75 ~~~~~~~~~~~~~~~~~~~~~~~~
77 --export-marks=<file>::
78         Dumps the internal marks table to <file> when complete.
79         Marks are written one per line as `:markid SHA-1`.
80         Frontends can use this file to validate imports after they
81         have been completed, or to save the marks table across
82         incremental runs.  As <file> is only opened and truncated
83         at checkpoint (or completion) the same path can also be
84         safely given to \--import-marks.
86 --import-marks=<file>::
87         Before processing any input, load the marks specified in
88         <file>.  The input file must exist, must be readable, and
89         must use the same format as produced by \--export-marks.
90         Multiple options may be supplied to import more than one
91         set of marks.  If a mark is defined to different values,
92         the last file wins.
94 --import-marks-if-exists=<file>::
95         Like --import-marks but instead of erroring out, silently
96         skips the file if it does not exist.
98 --[no-]relative-marks::
99         After specifying --relative-marks the paths specified
100         with --import-marks= and --export-marks= are relative
101         to an internal directory in the current repository.
102         In git-fast-import this means that the paths are relative
103         to the .git/info/fast-import directory. However, other
104         importers may use a different location.
106 Relative and non-relative marks may be combined by interweaving
107 --(no-)-relative-marks with the --(import|export)-marks= options.
109 Performance and Compression Tuning
110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 --active-branches=<n>::
113         Maximum number of branches to maintain active at once.
114         See ``Memory Utilization'' below for details.  Default is 5.
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.
122 --depth=<n>::
123         Maximum delta depth, for blob and tree deltification.
124         Default is 10.
126 --export-pack-edges=<file>::
127         After creating a packfile, print a line of data to
128         <file> listing the filename of the packfile and the last
129         commit on each branch that was written to that packfile.
130         This information may be useful after importing projects
131         whose total object set exceeds the 4 GiB packfile limit,
132         as these commits can be used as edge points during calls
133         to 'git pack-objects'.
135 --max-pack-size=<n>::
136         Maximum size of each output packfile.
137         The default is unlimited.
140 Performance
141 -----------
142 The design of fast-import allows it to import large projects in a minimum
143 amount of memory usage and processing time.  Assuming the frontend
144 is able to keep up with fast-import and feed it a constant stream of data,
145 import times for projects holding 10+ years of history and containing
146 100,000+ individual commits are generally completed in just 1-2
147 hours on quite modest (~$2,000 USD) hardware.
149 Most bottlenecks appear to be in foreign source data access (the
150 source just cannot extract revisions fast enough) or disk IO (fast-import
151 writes as fast as the disk will take the data).  Imports will run
152 faster if the source data is stored on a different drive than the
153 destination Git repository (due to less IO contention).
156 Development Cost
157 ----------------
158 A typical frontend for fast-import tends to weigh in at approximately 200
159 lines of Perl/Python/Ruby code.  Most developers have been able to
160 create working importers in just a couple of hours, even though it
161 is their first exposure to fast-import, and sometimes even to Git.  This is
162 an ideal situation, given that most conversion tools are throw-away
163 (use once, and never look back).
166 Parallel Operation
167 ------------------
168 Like 'git push' or 'git fetch', imports handled by fast-import are safe to
169 run alongside parallel `git repack -a -d` or `git gc` invocations,
170 or any other Git operation (including 'git prune', as loose objects
171 are never used by fast-import).
173 fast-import does not lock the branch or tag refs it is actively importing.
174 After the import, during its ref update phase, fast-import tests each
175 existing branch ref to verify the update will be a fast-forward
176 update (the commit stored in the ref is contained in the new
177 history of the commit to be written).  If the update is not a
178 fast-forward update, fast-import will skip updating that ref and instead
179 prints a warning message.  fast-import will always attempt to update all
180 branch refs, and does not stop on the first failure.
182 Branch updates can be forced with \--force, but it's recommended that
183 this only be used on an otherwise quiet repository.  Using \--force
184 is not necessary for an initial import into an empty repository.
187 Technical Discussion
188 --------------------
189 fast-import tracks a set of branches in memory.  Any branch can be created
190 or modified at any point during the import process by sending a
191 `commit` command on the input stream.  This design allows a frontend
192 program to process an unlimited number of branches simultaneously,
193 generating commits in the order they are available from the source
194 data.  It also simplifies the frontend programs considerably.
196 fast-import does not use or alter the current working directory, or any
197 file within it.  (It does however update the current Git repository,
198 as referenced by `GIT_DIR`.)  Therefore an import frontend may use
199 the working directory for its own purposes, such as extracting file
200 revisions from the foreign source.  This ignorance of the working
201 directory also allows fast-import to run very quickly, as it does not
202 need to perform any costly file update operations when switching
203 between branches.
205 Input Format
206 ------------
207 With the exception of raw file data (which Git does not interpret)
208 the fast-import input format is text (ASCII) based.  This text based
209 format simplifies development and debugging of frontend programs,
210 especially when a higher level language such as Perl, Python or
211 Ruby is being used.
213 fast-import is very strict about its input.  Where we say SP below we mean
214 *exactly* one space.  Likewise LF means one (and only one) linefeed
215 and HT one (and only one) horizontal tab.
216 Supplying additional whitespace characters will cause unexpected
217 results, such as branch names or file names with leading or trailing
218 spaces in their name, or early termination of fast-import when it encounters
219 unexpected input.
221 Stream Comments
222 ~~~~~~~~~~~~~~~
223 To aid in debugging frontends fast-import ignores any line that
224 begins with `#` (ASCII pound/hash) up to and including the line
225 ending `LF`.  A comment line may contain any sequence of bytes
226 that does not contain an LF and therefore may be used to include
227 any detailed debugging information that might be specific to the
228 frontend and useful when inspecting a fast-import data stream.
230 Date Formats
231 ~~~~~~~~~~~~
232 The following date formats are supported.  A frontend should select
233 the format it will use for this import by passing the format name
234 in the \--date-format=<fmt> command-line option.
236 `raw`::
237         This is the Git native format and is `<time> SP <offutc>`.
238         It is also fast-import's default format, if \--date-format was
239         not specified.
241 The time of the event is specified by `<time>` as the number of
242 seconds since the UNIX epoch (midnight, Jan 1, 1970, UTC) and is
243 written as an ASCII decimal integer.
245 The local offset is specified by `<offutc>` as a positive or negative
246 offset from UTC.  For example EST (which is 5 hours behind UTC)
247 would be expressed in `<tz>` by ``-0500'' while UTC is ``+0000''.
248 The local offset does not affect `<time>`; it is used only as an
249 advisement to help formatting routines display the timestamp.
251 If the local offset is not available in the source material, use
252 ``+0000'', or the most common local offset.  For example many
253 organizations have a CVS repository which has only ever been accessed
254 by users who are located in the same location and time zone.  In this
255 case a reasonable offset from UTC could be assumed.
257 Unlike the `rfc2822` format, this format is very strict.  Any
258 variation in formatting will cause fast-import to reject the value.
260 `rfc2822`::
261         This is the standard email format as described by RFC 2822.
263 An example value is ``Tue Feb 6 11:22:18 2007 -0500''.  The Git
264 parser is accurate, but a little on the lenient side.  It is the
265 same parser used by 'git am' when applying patches
266 received from email.
268 Some malformed strings may be accepted as valid dates.  In some of
269 these cases Git will still be able to obtain the correct date from
270 the malformed string.  There are also some types of malformed
271 strings which Git will parse wrong, and yet consider valid.
272 Seriously malformed strings will be rejected.
274 Unlike the `raw` format above, the time zone/UTC offset information
275 contained in an RFC 2822 date string is used to adjust the date
276 value to UTC prior to storage.  Therefore it is important that
277 this information be as accurate as possible.
279 If the source material uses RFC 2822 style dates,
280 the frontend should let fast-import handle the parsing and conversion
281 (rather than attempting to do it itself) as the Git parser has
282 been well tested in the wild.
284 Frontends should prefer the `raw` format if the source material
285 already uses UNIX-epoch format, can be coaxed to give dates in that
286 format, or its format is easily convertible to it, as there is no
287 ambiguity in parsing.
289 `now`::
290         Always use the current time and time zone.  The literal
291         `now` must always be supplied for `<when>`.
293 This is a toy format.  The current time and time zone of this system
294 is always copied into the identity string at the time it is being
295 created by fast-import.  There is no way to specify a different time or
296 time zone.
298 This particular format is supplied as it's short to implement and
299 may be useful to a process that wants to create a new commit
300 right now, without needing to use a working directory or
301 'git update-index'.
303 If separate `author` and `committer` commands are used in a `commit`
304 the timestamps may not match, as the system clock will be polled
305 twice (once for each command).  The only way to ensure that both
306 author and committer identity information has the same timestamp
307 is to omit `author` (thus copying from `committer`) or to use a
308 date format other than `now`.
310 Commands
311 ~~~~~~~~
312 fast-import accepts several commands to update the current repository
313 and control the current import process.  More detailed discussion
314 (with examples) of each command follows later.
316 `commit`::
317         Creates a new branch or updates an existing branch by
318         creating a new commit and updating the branch to point at
319         the newly created commit.
321 `tag`::
322         Creates an annotated tag object from an existing commit or
323         branch.  Lightweight tags are not supported by this command,
324         as they are not recommended for recording meaningful points
325         in time.
327 `reset`::
328         Reset an existing branch (or a new branch) to a specific
329         revision.  This command must be used to change a branch to
330         a specific revision without making a commit on it.
332 `blob`::
333         Convert raw file data into a blob, for future use in a
334         `commit` command.  This command is optional and is not
335         needed to perform an import.
337 `checkpoint`::
338         Forces fast-import to close the current packfile, generate its
339         unique SHA-1 checksum and index, and start a new packfile.
340         This command is optional and is not needed to perform
341         an import.
343 `progress`::
344         Causes fast-import to echo the entire line to its own
345         standard output.  This command is optional and is not needed
346         to perform an import.
348 `done`::
349         Marks the end of the stream. This command is optional
350         unless the `done` feature was requested using the
351         `--done` command-line option or `feature done` command.
353 `cat-blob`::
354         Causes fast-import to print a blob in 'cat-file --batch'
355         format to the file descriptor set with `--cat-blob-fd` or
356         `stdout` if unspecified.
358 `ls`::
359         Causes fast-import to print a line describing a directory
360         entry in 'ls-tree' format to the file descriptor set with
361         `--cat-blob-fd` or `stdout` if unspecified.
363 `feature`::
364         Enable the specified feature. This requires that fast-import
365         supports the specified feature, and aborts if it does not.
367 `option`::
368         Specify any of the options listed under OPTIONS that do not
369         change stream semantic to suit the frontend's needs. This
370         command is optional and is not needed to perform an import.
372 `commit`
373 ~~~~~~~~
374 Create or update a branch with a new commit, recording one logical
375 change to the project.
377 ....
378         'commit' SP <ref> LF
379         mark?
380         ('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
381         'committer' (SP <name>)? SP LT <email> GT SP <when> LF
382         data
383         ('from' SP <commit-ish> LF)?
384         ('merge' SP <commit-ish> LF)?
385         (filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
386         LF?
387 ....
389 where `<ref>` is the name of the branch to make the commit on.
390 Typically branch names are prefixed with `refs/heads/` in
391 Git, so importing the CVS branch symbol `RELENG-1_0` would use
392 `refs/heads/RELENG-1_0` for the value of `<ref>`.  The value of
393 `<ref>` must be a valid refname in Git.  As `LF` is not valid in
394 a Git refname, no quoting or escaping syntax is supported here.
396 A `mark` command may optionally appear, requesting fast-import to save a
397 reference to the newly created commit for future use by the frontend
398 (see below for format).  It is very common for frontends to mark
399 every commit they create, thereby allowing future branch creation
400 from any imported commit.
402 The `data` command following `committer` must supply the commit
403 message (see below for `data` command syntax).  To import an empty
404 commit message use a 0 length data.  Commit messages are free-form
405 and are not interpreted by Git.  Currently they must be encoded in
406 UTF-8, as fast-import does not permit other encodings to be specified.
408 Zero or more `filemodify`, `filedelete`, `filecopy`, `filerename`,
409 `filedeleteall` and `notemodify` commands
410 may be included to update the contents of the branch prior to
411 creating the commit.  These commands may be supplied in any order.
412 However it is recommended that a `filedeleteall` command precede
413 all `filemodify`, `filecopy`, `filerename` and `notemodify` commands in
414 the same commit, as `filedeleteall` wipes the branch clean (see below).
416 The `LF` after the command is optional (it used to be required).
418 `author`
419 ^^^^^^^^
420 An `author` command may optionally appear, if the author information
421 might differ from the committer information.  If `author` is omitted
422 then fast-import will automatically use the committer's information for
423 the author portion of the commit.  See below for a description of
424 the fields in `author`, as they are identical to `committer`.
426 `committer`
427 ^^^^^^^^^^^
428 The `committer` command indicates who made this commit, and when
429 they made it.
431 Here `<name>` is the person's display name (for example
432 ``Com M Itter'') and `<email>` is the person's email address
433 (``\cm@example.com'').  `LT` and `GT` are the literal less-than (\x3c)
434 and greater-than (\x3e) symbols.  These are required to delimit
435 the email address from the other fields in the line.  Note that
436 `<name>` and `<email>` are free-form and may contain any sequence
437 of bytes, except `LT`, `GT` and `LF`.  `<name>` is typically UTF-8 encoded.
439 The time of the change is specified by `<when>` using the date format
440 that was selected by the \--date-format=<fmt> command-line option.
441 See ``Date Formats'' above for the set of supported formats, and
442 their syntax.
444 `from`
445 ^^^^^^
446 The `from` command is used to specify the commit to initialize
447 this branch from.  This revision will be the first ancestor of the
448 new commit.  The state of the tree built at this commit will begin
449 with the state at the `from` commit, and be altered by the content
450 modifications in this commit.
452 Omitting the `from` command in the first commit of a new branch
453 will cause fast-import to create that commit with no ancestor. This
454 tends to be desired only for the initial commit of a project.
455 If the frontend creates all files from scratch when making a new
456 branch, a `merge` command may be used instead of `from` to start
457 the commit with an empty tree.
458 Omitting the `from` command on existing branches is usually desired,
459 as the current commit on that branch is automatically assumed to
460 be the first ancestor of the new commit.
462 As `LF` is not valid in a Git refname or SHA-1 expression, no
463 quoting or escaping syntax is supported within `<commit-ish>`.
465 Here `<commit-ish>` is any of the following:
467 * The name of an existing branch already in fast-import's internal branch
468   table.  If fast-import doesn't know the name, it's treated as a SHA-1
469   expression.
471 * A mark reference, `:<idnum>`, where `<idnum>` is the mark number.
473 The reason fast-import uses `:` to denote a mark reference is this character
474 is not legal in a Git branch name.  The leading `:` makes it easy
475 to distinguish between the mark 42 (`:42`) and the branch 42 (`42`
476 or `refs/heads/42`), or an abbreviated SHA-1 which happened to
477 consist only of base-10 digits.
479 Marks must be declared (via `mark`) before they can be used.
481 * A complete 40 byte or abbreviated commit SHA-1 in hex.
483 * Any valid Git SHA-1 expression that resolves to a commit.  See
484   ``SPECIFYING REVISIONS'' in linkgit:gitrevisions[7] for details.
486 * The special null SHA-1 (40 zeros) specifies that the branch is to be
487   removed.
489 The special case of restarting an incremental import from the
490 current branch value should be written as:
491 ----
492         from refs/heads/branch^0
493 ----
494 The `^0` suffix is necessary as fast-import does not permit a branch to
495 start from itself, and the branch is created in memory before the
496 `from` command is even read from the input.  Adding `^0` will force
497 fast-import to resolve the commit through Git's revision parsing library,
498 rather than its internal branch table, thereby loading in the
499 existing value of the branch.
501 `merge`
502 ^^^^^^^
503 Includes one additional ancestor commit.  The additional ancestry
504 link does not change the way the tree state is built at this commit.
505 If the `from` command is
506 omitted when creating a new branch, the first `merge` commit will be
507 the first ancestor of the current commit, and the branch will start
508 out with no files.  An unlimited number of `merge` commands per
509 commit are permitted by fast-import, thereby establishing an n-way merge.
510 However Git's other tools never create commits with more than 15
511 additional ancestors (forming a 16-way merge).  For this reason
512 it is suggested that frontends do not use more than 15 `merge`
513 commands per commit; 16, if starting a new, empty branch.
515 Here `<commit-ish>` is any of the commit specification expressions
516 also accepted by `from` (see above).
518 `filemodify`
519 ^^^^^^^^^^^^
520 Included in a `commit` command to add a new file or change the
521 content of an existing file.  This command has two different means
522 of specifying the content of the file.
524 External data format::
525         The data content for the file was already supplied by a prior
526         `blob` command.  The frontend just needs to connect it.
528 ....
529         'M' SP <mode> SP <dataref> SP <path> LF
530 ....
532 Here usually `<dataref>` must be either a mark reference (`:<idnum>`)
533 set by a prior `blob` command, or a full 40-byte SHA-1 of an
534 existing Git blob object.  If `<mode>` is `040000`` then
535 `<dataref>` must be the full 40-byte SHA-1 of an existing
536 Git tree object or a mark reference set with `--import-marks`.
538 Inline data format::
539         The data content for the file has not been supplied yet.
540         The frontend wants to supply it as part of this modify
541         command.
543 ....
544         'M' SP <mode> SP 'inline' SP <path> LF
545         data
546 ....
548 See below for a detailed description of the `data` command.
550 In both formats `<mode>` is the type of file entry, specified
551 in octal.  Git only supports the following modes:
553 * `100644` or `644`: A normal (not-executable) file.  The majority
554   of files in most projects use this mode.  If in doubt, this is
555   what you want.
556 * `100755` or `755`: A normal, but executable, file.
557 * `120000`: A symlink, the content of the file will be the link target.
558 * `160000`: A gitlink, SHA-1 of the object refers to a commit in
559   another repository. Git links can only be specified by SHA or through
560   a commit mark. They are used to implement submodules.
561 * `040000`: A subdirectory.  Subdirectories can only be specified by
562   SHA or through a tree mark set with `--import-marks`.
564 In both formats `<path>` is the complete path of the file to be added
565 (if not already existing) or modified (if already existing).
567 A `<path>` string must use UNIX-style directory separators (forward
568 slash `/`), may contain any byte other than `LF`, and must not
569 start with double quote (`"`).
571 A path can use C-style string quoting; this is accepted in all cases
572 and mandatory if the filename starts with double quote or contains
573 `LF`. In C-style quoting, the complete name should be surrounded with
574 double quotes, and any `LF`, backslash, or double quote characters
575 must be escaped by preceding them with a backslash (e.g.,
576 `"path/with\n, \\ and \" in it"`).
578 The value of `<path>` must be in canonical form. That is it must not:
580 * contain an empty directory component (e.g. `foo//bar` is invalid),
581 * end with a directory separator (e.g. `foo/` is invalid),
582 * start with a directory separator (e.g. `/foo` is invalid),
583 * contain the special component `.` or `..` (e.g. `foo/./bar` and
584   `foo/../bar` are invalid).
586 The root of the tree can be represented by an empty string as `<path>`.
588 It is recommended that `<path>` always be encoded using UTF-8.
590 `filedelete`
591 ^^^^^^^^^^^^
592 Included in a `commit` command to remove a file or recursively
593 delete an entire directory from the branch.  If the file or directory
594 removal makes its parent directory empty, the parent directory will
595 be automatically removed too.  This cascades up the tree until the
596 first non-empty directory or the root is reached.
598 ....
599         'D' SP <path> LF
600 ....
602 here `<path>` is the complete path of the file or subdirectory to
603 be removed from the branch.
604 See `filemodify` above for a detailed description of `<path>`.
606 `filecopy`
607 ^^^^^^^^^^^^
608 Recursively copies an existing file or subdirectory to a different
609 location within the branch.  The existing file or directory must
610 exist.  If the destination exists it will be completely replaced
611 by the content copied from the source.
613 ....
614         'C' SP <path> SP <path> LF
615 ....
617 here the first `<path>` is the source location and the second
618 `<path>` is the destination.  See `filemodify` above for a detailed
619 description of what `<path>` may look like.  To use a source path
620 that contains SP the path must be quoted.
622 A `filecopy` command takes effect immediately.  Once the source
623 location has been copied to the destination any future commands
624 applied to the source location will not impact the destination of
625 the copy.
627 `filerename`
628 ^^^^^^^^^^^^
629 Renames an existing file or subdirectory to a different location
630 within the branch.  The existing file or directory must exist. If
631 the destination exists it will be replaced by the source directory.
633 ....
634         'R' SP <path> SP <path> LF
635 ....
637 here the first `<path>` is the source location and the second
638 `<path>` is the destination.  See `filemodify` above for a detailed
639 description of what `<path>` may look like.  To use a source path
640 that contains SP the path must be quoted.
642 A `filerename` command takes effect immediately.  Once the source
643 location has been renamed to the destination any future commands
644 applied to the source location will create new files there and not
645 impact the destination of the rename.
647 Note that a `filerename` is the same as a `filecopy` followed by a
648 `filedelete` of the source location.  There is a slight performance
649 advantage to using `filerename`, but the advantage is so small
650 that it is never worth trying to convert a delete/add pair in
651 source material into a rename for fast-import.  This `filerename`
652 command is provided just to simplify frontends that already have
653 rename information and don't want bother with decomposing it into a
654 `filecopy` followed by a `filedelete`.
656 `filedeleteall`
657 ^^^^^^^^^^^^^^^
658 Included in a `commit` command to remove all files (and also all
659 directories) from the branch.  This command resets the internal
660 branch structure to have no files in it, allowing the frontend
661 to subsequently add all interesting files from scratch.
663 ....
664         'deleteall' LF
665 ....
667 This command is extremely useful if the frontend does not know
668 (or does not care to know) what files are currently on the branch,
669 and therefore cannot generate the proper `filedelete` commands to
670 update the content.
672 Issuing a `filedeleteall` followed by the needed `filemodify`
673 commands to set the correct content will produce the same results
674 as sending only the needed `filemodify` and `filedelete` commands.
675 The `filedeleteall` approach may however require fast-import to use slightly
676 more memory per active branch (less than 1 MiB for even most large
677 projects); so frontends that can easily obtain only the affected
678 paths for a commit are encouraged to do so.
680 `notemodify`
681 ^^^^^^^^^^^^
682 Included in a `commit` `<notes_ref>` command to add a new note
683 annotating a `<commit-ish>` or change this annotation contents.
684 Internally it is similar to filemodify 100644 on `<commit-ish>`
685 path (maybe split into subdirectories). It's not advised to
686 use any other commands to write to the `<notes_ref>` tree except
687 `filedeleteall` to delete all existing notes in this tree.
688 This command has two different means of specifying the content
689 of the note.
691 External data format::
692         The data content for the note was already supplied by a prior
693         `blob` command.  The frontend just needs to connect it to the
694         commit that is to be annotated.
696 ....
697         'N' SP <dataref> SP <commit-ish> LF
698 ....
700 Here `<dataref>` can be either a mark reference (`:<idnum>`)
701 set by a prior `blob` command, or a full 40-byte SHA-1 of an
702 existing Git blob object.
704 Inline data format::
705         The data content for the note has not been supplied yet.
706         The frontend wants to supply it as part of this modify
707         command.
709 ....
710         'N' SP 'inline' SP <commit-ish> LF
711         data
712 ....
714 See below for a detailed description of the `data` command.
716 In both formats `<commit-ish>` is any of the commit specification
717 expressions also accepted by `from` (see above).
719 `mark`
720 ~~~~~~
721 Arranges for fast-import to save a reference to the current object, allowing
722 the frontend to recall this object at a future point in time, without
723 knowing its SHA-1.  Here the current object is the object creation
724 command the `mark` command appears within.  This can be `commit`,
725 `tag`, and `blob`, but `commit` is the most common usage.
727 ....
728         'mark' SP ':' <idnum> LF
729 ....
731 where `<idnum>` is the number assigned by the frontend to this mark.
732 The value of `<idnum>` is expressed as an ASCII decimal integer.
733 The value 0 is reserved and cannot be used as
734 a mark.  Only values greater than or equal to 1 may be used as marks.
736 New marks are created automatically.  Existing marks can be moved
737 to another object simply by reusing the same `<idnum>` in another
738 `mark` command.
740 `tag`
741 ~~~~~
742 Creates an annotated tag referring to a specific commit.  To create
743 lightweight (non-annotated) tags see the `reset` command below.
745 ....
746         'tag' SP <name> LF
747         'from' SP <commit-ish> LF
748         'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
749         data
750 ....
752 where `<name>` is the name of the tag to create.
754 Tag names are automatically prefixed with `refs/tags/` when stored
755 in Git, so importing the CVS branch symbol `RELENG-1_0-FINAL` would
756 use just `RELENG-1_0-FINAL` for `<name>`, and fast-import will write the
757 corresponding ref as `refs/tags/RELENG-1_0-FINAL`.
759 The value of `<name>` must be a valid refname in Git and therefore
760 may contain forward slashes.  As `LF` is not valid in a Git refname,
761 no quoting or escaping syntax is supported here.
763 The `from` command is the same as in the `commit` command; see
764 above for details.
766 The `tagger` command uses the same format as `committer` within
767 `commit`; again see above for details.
769 The `data` command following `tagger` must supply the annotated tag
770 message (see below for `data` command syntax).  To import an empty
771 tag message use a 0 length data.  Tag messages are free-form and are
772 not interpreted by Git.  Currently they must be encoded in UTF-8,
773 as fast-import does not permit other encodings to be specified.
775 Signing annotated tags during import from within fast-import is not
776 supported.  Trying to include your own PGP/GPG signature is not
777 recommended, as the frontend does not (easily) have access to the
778 complete set of bytes which normally goes into such a signature.
779 If signing is required, create lightweight tags from within fast-import with
780 `reset`, then create the annotated versions of those tags offline
781 with the standard 'git tag' process.
783 `reset`
784 ~~~~~~~
785 Creates (or recreates) the named branch, optionally starting from
786 a specific revision.  The reset command allows a frontend to issue
787 a new `from` command for an existing branch, or to create a new
788 branch from an existing commit without creating a new commit.
790 ....
791         'reset' SP <ref> LF
792         ('from' SP <commit-ish> LF)?
793         LF?
794 ....
796 For a detailed description of `<ref>` and `<commit-ish>` see above
797 under `commit` and `from`.
799 The `LF` after the command is optional (it used to be required).
801 The `reset` command can also be used to create lightweight
802 (non-annotated) tags.  For example:
804 ====
805         reset refs/tags/938
806         from :938
807 ====
809 would create the lightweight tag `refs/tags/938` referring to
810 whatever commit mark `:938` references.
812 `blob`
813 ~~~~~~
814 Requests writing one file revision to the packfile.  The revision
815 is not connected to any commit; this connection must be formed in
816 a subsequent `commit` command by referencing the blob through an
817 assigned mark.
819 ....
820         'blob' LF
821         mark?
822         data
823 ....
825 The mark command is optional here as some frontends have chosen
826 to generate the Git SHA-1 for the blob on their own, and feed that
827 directly to `commit`.  This is typically more work than it's worth
828 however, as marks are inexpensive to store and easy to use.
830 `data`
831 ~~~~~~
832 Supplies raw data (for use as blob/file content, commit messages, or
833 annotated tag messages) to fast-import.  Data can be supplied using an exact
834 byte count or delimited with a terminating line.  Real frontends
835 intended for production-quality conversions should always use the
836 exact byte count format, as it is more robust and performs better.
837 The delimited format is intended primarily for testing fast-import.
839 Comment lines appearing within the `<raw>` part of `data` commands
840 are always taken to be part of the body of the data and are therefore
841 never ignored by fast-import.  This makes it safe to import any
842 file/message content whose lines might start with `#`.
844 Exact byte count format::
845         The frontend must specify the number of bytes of data.
847 ....
848         'data' SP <count> LF
849         <raw> LF?
850 ....
852 where `<count>` is the exact number of bytes appearing within
853 `<raw>`.  The value of `<count>` is expressed as an ASCII decimal
854 integer.  The `LF` on either side of `<raw>` is not
855 included in `<count>` and will not be included in the imported data.
857 The `LF` after `<raw>` is optional (it used to be required) but
858 recommended.  Always including it makes debugging a fast-import
859 stream easier as the next command always starts in column 0
860 of the next line, even if `<raw>` did not end with an `LF`.
862 Delimited format::
863         A delimiter string is used to mark the end of the data.
864         fast-import will compute the length by searching for the delimiter.
865         This format is primarily useful for testing and is not
866         recommended for real data.
868 ....
869         'data' SP '<<' <delim> LF
870         <raw> LF
871         <delim> LF
872         LF?
873 ....
875 where `<delim>` is the chosen delimiter string.  The string `<delim>`
876 must not appear on a line by itself within `<raw>`, as otherwise
877 fast-import will think the data ends earlier than it really does.  The `LF`
878 immediately trailing `<raw>` is part of `<raw>`.  This is one of
879 the limitations of the delimited format, it is impossible to supply
880 a data chunk which does not have an LF as its last byte.
882 The `LF` after `<delim> LF` is optional (it used to be required).
884 `checkpoint`
885 ~~~~~~~~~~~~
886 Forces fast-import to close the current packfile, start a new one, and to
887 save out all current branch refs, tags and marks.
889 ....
890         'checkpoint' LF
891         LF?
892 ....
894 Note that fast-import automatically switches packfiles when the current
895 packfile reaches \--max-pack-size, or 4 GiB, whichever limit is
896 smaller.  During an automatic packfile switch fast-import does not update
897 the branch refs, tags or marks.
899 As a `checkpoint` can require a significant amount of CPU time and
900 disk IO (to compute the overall pack SHA-1 checksum, generate the
901 corresponding index file, and update the refs) it can easily take
902 several minutes for a single `checkpoint` command to complete.
904 Frontends may choose to issue checkpoints during extremely large
905 and long running imports, or when they need to allow another Git
906 process access to a branch.  However given that a 30 GiB Subversion
907 repository can be loaded into Git through fast-import in about 3 hours,
908 explicit checkpointing may not be necessary.
910 The `LF` after the command is optional (it used to be required).
912 `progress`
913 ~~~~~~~~~~
914 Causes fast-import to print the entire `progress` line unmodified to
915 its standard output channel (file descriptor 1) when the command is
916 processed from the input stream.  The command otherwise has no impact
917 on the current import, or on any of fast-import's internal state.
919 ....
920         'progress' SP <any> LF
921         LF?
922 ....
924 The `<any>` part of the command may contain any sequence of bytes
925 that does not contain `LF`.  The `LF` after the command is optional.
926 Callers may wish to process the output through a tool such as sed to
927 remove the leading part of the line, for example:
929 ====
930         frontend | git fast-import | sed 's/^progress //'
931 ====
933 Placing a `progress` command immediately after a `checkpoint` will
934 inform the reader when the `checkpoint` has been completed and it
935 can safely access the refs that fast-import updated.
937 `cat-blob`
938 ~~~~~~~~~~
939 Causes fast-import to print a blob to a file descriptor previously
940 arranged with the `--cat-blob-fd` argument.  The command otherwise
941 has no impact on the current import; its main purpose is to
942 retrieve blobs that may be in fast-import's memory but not
943 accessible from the target repository.
945 ....
946         'cat-blob' SP <dataref> LF
947 ....
949 The `<dataref>` can be either a mark reference (`:<idnum>`)
950 set previously or a full 40-byte SHA-1 of a Git blob, preexisting or
951 ready to be written.
953 Output uses the same format as `git cat-file --batch`:
955 ====
956         <sha1> SP 'blob' SP <size> LF
957         <contents> LF
958 ====
960 This command can be used anywhere in the stream that comments are
961 accepted.  In particular, the `cat-blob` command can be used in the
962 middle of a commit but not in the middle of a `data` command.
964 See ``Responses To Commands'' below for details about how to read
965 this output safely.
967 `ls`
968 ~~~~
969 Prints information about the object at a path to a file descriptor
970 previously arranged with the `--cat-blob-fd` argument.  This allows
971 printing a blob from the active commit (with `cat-blob`) or copying a
972 blob or tree from a previous commit for use in the current one (with
973 `filemodify`).
975 The `ls` command can be used anywhere in the stream that comments are
976 accepted, including the middle of a commit.
978 Reading from the active commit::
979         This form can only be used in the middle of a `commit`.
980         The path names a directory entry within fast-import's
981         active commit.  The path must be quoted in this case.
983 ....
984         'ls' SP <path> LF
985 ....
987 Reading from a named tree::
988         The `<dataref>` can be a mark reference (`:<idnum>`) or the
989         full 40-byte SHA-1 of a Git tag, commit, or tree object,
990         preexisting or waiting to be written.
991         The path is relative to the top level of the tree
992         named by `<dataref>`.
994 ....
995         'ls' SP <dataref> SP <path> LF
996 ....
998 See `filemodify` above for a detailed description of `<path>`.
1000 Output uses the same format as `git ls-tree <tree> -- <path>`:
1002 ====
1003         <mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF
1004 ====
1006 The <dataref> represents the blob, tree, or commit object at <path>
1007 and can be used in later 'cat-blob', 'filemodify', or 'ls' commands.
1009 If there is no file or subtree at that path, 'git fast-import' will
1010 instead report
1012 ====
1013         missing SP <path> LF
1014 ====
1016 See ``Responses To Commands'' below for details about how to read
1017 this output safely.
1019 `feature`
1020 ~~~~~~~~~
1021 Require that fast-import supports the specified feature, or abort if
1022 it does not.
1024 ....
1025         'feature' SP <feature> ('=' <argument>)? LF
1026 ....
1028 The <feature> part of the command may be any one of the following:
1030 date-format::
1031 export-marks::
1032 relative-marks::
1033 no-relative-marks::
1034 force::
1035         Act as though the corresponding command-line option with
1036         a leading '--' was passed on the command line
1037         (see OPTIONS, above).
1039 import-marks::
1040 import-marks-if-exists::
1041         Like --import-marks except in two respects: first, only one
1042         "feature import-marks" or "feature import-marks-if-exists"
1043         command is allowed per stream; second, an --import-marks=
1044         or --import-marks-if-exists command-line option overrides
1045         any of these "feature" commands in the stream; third,
1046         "feature import-marks-if-exists" like a corresponding
1047         command-line option silently skips a nonexistent file.
1049 cat-blob::
1050 ls::
1051         Require that the backend support the 'cat-blob' or 'ls' command.
1052         Versions of fast-import not supporting the specified command
1053         will exit with a message indicating so.
1054         This lets the import error out early with a clear message,
1055         rather than wasting time on the early part of an import
1056         before the unsupported command is detected.
1058 notes::
1059         Require that the backend support the 'notemodify' (N)
1060         subcommand to the 'commit' command.
1061         Versions of fast-import not supporting notes will exit
1062         with a message indicating so.
1064 done::
1065         Error out if the stream ends without a 'done' command.
1066         Without this feature, errors causing the frontend to end
1067         abruptly at a convenient point in the stream can go
1068         undetected.  This may occur, for example, if an import
1069         front end dies in mid-operation without emitting SIGTERM
1070         or SIGKILL at its subordinate git fast-import instance.
1072 `option`
1073 ~~~~~~~~
1074 Processes the specified option so that git fast-import behaves in a
1075 way that suits the frontend's needs.
1076 Note that options specified by the frontend are overridden by any
1077 options the user may specify to git fast-import itself.
1079 ....
1080     'option' SP <option> LF
1081 ....
1083 The `<option>` part of the command may contain any of the options
1084 listed in the OPTIONS section that do not change import semantics,
1085 without the leading '--' and is treated in the same way.
1087 Option commands must be the first commands on the input (not counting
1088 feature commands), to give an option command after any non-option
1089 command is an error.
1091 The following command-line options change import semantics and may therefore
1092 not be passed as option:
1094 * date-format
1095 * import-marks
1096 * export-marks
1097 * cat-blob-fd
1098 * force
1100 `done`
1101 ~~~~~~
1102 If the `done` feature is not in use, treated as if EOF was read.
1103 This can be used to tell fast-import to finish early.
1105 If the `--done` command-line option or `feature done` command is
1106 in use, the `done` command is mandatory and marks the end of the
1107 stream.
1109 Responses To Commands
1110 ---------------------
1111 New objects written by fast-import are not available immediately.
1112 Most fast-import commands have no visible effect until the next
1113 checkpoint (or completion).  The frontend can send commands to
1114 fill fast-import's input pipe without worrying about how quickly
1115 they will take effect, which improves performance by simplifying
1116 scheduling.
1118 For some frontends, though, it is useful to be able to read back
1119 data from the current repository as it is being updated (for
1120 example when the source material describes objects in terms of
1121 patches to be applied to previously imported objects).  This can
1122 be accomplished by connecting the frontend and fast-import via
1123 bidirectional pipes:
1125 ====
1126         mkfifo fast-import-output
1127         frontend <fast-import-output |
1128         git fast-import >fast-import-output
1129 ====
1131 A frontend set up this way can use `progress`, `ls`, and `cat-blob`
1132 commands to read information from the import in progress.
1134 To avoid deadlock, such frontends must completely consume any
1135 pending output from `progress`, `ls`, and `cat-blob` before
1136 performing writes to fast-import that might block.
1138 Crash Reports
1139 -------------
1140 If fast-import is supplied invalid input it will terminate with a
1141 non-zero exit status and create a crash report in the top level of
1142 the Git repository it was importing into.  Crash reports contain
1143 a snapshot of the internal fast-import state as well as the most
1144 recent commands that lead up to the crash.
1146 All recent commands (including stream comments, file changes and
1147 progress commands) are shown in the command history within the crash
1148 report, but raw file data and commit messages are excluded from the
1149 crash report.  This exclusion saves space within the report file
1150 and reduces the amount of buffering that fast-import must perform
1151 during execution.
1153 After writing a crash report fast-import will close the current
1154 packfile and export the marks table.  This allows the frontend
1155 developer to inspect the repository state and resume the import from
1156 the point where it crashed.  The modified branches and tags are not
1157 updated during a crash, as the import did not complete successfully.
1158 Branch and tag information can be found in the crash report and
1159 must be applied manually if the update is needed.
1161 An example crash:
1163 ====
1164         $ cat >in <<END_OF_INPUT
1165         # my very first test commit
1166         commit refs/heads/master
1167         committer Shawn O. Pearce <spearce> 19283 -0400
1168         # who is that guy anyway?
1169         data <<EOF
1170         this is my commit
1171         EOF
1172         M 644 inline .gitignore
1173         data <<EOF
1174         .gitignore
1175         EOF
1176         M 777 inline bob
1177         END_OF_INPUT
1179         $ git fast-import <in
1180         fatal: Corrupt mode: M 777 inline bob
1181         fast-import: dumping crash report to .git/fast_import_crash_8434
1183         $ cat .git/fast_import_crash_8434
1184         fast-import crash report:
1185             fast-import process: 8434
1186             parent process     : 1391
1187             at Sat Sep 1 00:58:12 2007
1189         fatal: Corrupt mode: M 777 inline bob
1191         Most Recent Commands Before Crash
1192         ---------------------------------
1193           # my very first test commit
1194           commit refs/heads/master
1195           committer Shawn O. Pearce <spearce> 19283 -0400
1196           # who is that guy anyway?
1197           data <<EOF
1198           M 644 inline .gitignore
1199           data <<EOF
1200         * M 777 inline bob
1202         Active Branch LRU
1203         -----------------
1204             active_branches = 1 cur, 5 max
1206           pos  clock name
1207           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1208            1)      0 refs/heads/master
1210         Inactive Branches
1211         -----------------
1212         refs/heads/master:
1213           status      : active loaded dirty
1214           tip commit  : 0000000000000000000000000000000000000000
1215           old tree    : 0000000000000000000000000000000000000000
1216           cur tree    : 0000000000000000000000000000000000000000
1217           commit clock: 0
1218           last pack   :
1221         -------------------
1222         END OF CRASH REPORT
1223 ====
1225 Tips and Tricks
1226 ---------------
1227 The following tips and tricks have been collected from various
1228 users of fast-import, and are offered here as suggestions.
1230 Use One Mark Per Commit
1231 ~~~~~~~~~~~~~~~~~~~~~~~
1232 When doing a repository conversion, use a unique mark per commit
1233 (`mark :<n>`) and supply the \--export-marks option on the command
1234 line.  fast-import will dump a file which lists every mark and the Git
1235 object SHA-1 that corresponds to it.  If the frontend can tie
1236 the marks back to the source repository, it is easy to verify the
1237 accuracy and completeness of the import by comparing each Git
1238 commit to the corresponding source revision.
1240 Coming from a system such as Perforce or Subversion this should be
1241 quite simple, as the fast-import mark can also be the Perforce changeset
1242 number or the Subversion revision number.
1244 Freely Skip Around Branches
1245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1246 Don't bother trying to optimize the frontend to stick to one branch
1247 at a time during an import.  Although doing so might be slightly
1248 faster for fast-import, it tends to increase the complexity of the frontend
1249 code considerably.
1251 The branch LRU builtin to fast-import tends to behave very well, and the
1252 cost of activating an inactive branch is so low that bouncing around
1253 between branches has virtually no impact on import performance.
1255 Handling Renames
1256 ~~~~~~~~~~~~~~~~
1257 When importing a renamed file or directory, simply delete the old
1258 name(s) and modify the new name(s) during the corresponding commit.
1259 Git performs rename detection after-the-fact, rather than explicitly
1260 during a commit.
1262 Use Tag Fixup Branches
1263 ~~~~~~~~~~~~~~~~~~~~~~
1264 Some other SCM systems let the user create a tag from multiple
1265 files which are not from the same commit/changeset.  Or to create
1266 tags which are a subset of the files available in the repository.
1268 Importing these tags as-is in Git is impossible without making at
1269 least one commit which ``fixes up'' the files to match the content
1270 of the tag.  Use fast-import's `reset` command to reset a dummy branch
1271 outside of your normal branch space to the base commit for the tag,
1272 then commit one or more file fixup commits, and finally tag the
1273 dummy branch.
1275 For example since all normal branches are stored under `refs/heads/`
1276 name the tag fixup branch `TAG_FIXUP`.  This way it is impossible for
1277 the fixup branch used by the importer to have namespace conflicts
1278 with real branches imported from the source (the name `TAG_FIXUP`
1279 is not `refs/heads/TAG_FIXUP`).
1281 When committing fixups, consider using `merge` to connect the
1282 commit(s) which are supplying file revisions to the fixup branch.
1283 Doing so will allow tools such as 'git blame' to track
1284 through the real commit history and properly annotate the source
1285 files.
1287 After fast-import terminates the frontend will need to do `rm .git/TAG_FIXUP`
1288 to remove the dummy branch.
1290 Import Now, Repack Later
1291 ~~~~~~~~~~~~~~~~~~~~~~~~
1292 As soon as fast-import completes the Git repository is completely valid
1293 and ready for use.  Typically this takes only a very short time,
1294 even for considerably large projects (100,000+ commits).
1296 However repacking the repository is necessary to improve data
1297 locality and access performance.  It can also take hours on extremely
1298 large projects (especially if -f and a large \--window parameter is
1299 used).  Since repacking is safe to run alongside readers and writers,
1300 run the repack in the background and let it finish when it finishes.
1301 There is no reason to wait to explore your new Git project!
1303 If you choose to wait for the repack, don't try to run benchmarks
1304 or performance tests until repacking is completed.  fast-import outputs
1305 suboptimal packfiles that are simply never seen in real use
1306 situations.
1308 Repacking Historical Data
1309 ~~~~~~~~~~~~~~~~~~~~~~~~~
1310 If you are repacking very old imported data (e.g. older than the
1311 last year), consider expending some extra CPU time and supplying
1312 \--window=50 (or higher) when you run 'git repack'.
1313 This will take longer, but will also produce a smaller packfile.
1314 You only need to expend the effort once, and everyone using your
1315 project will benefit from the smaller repository.
1317 Include Some Progress Messages
1318 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1319 Every once in a while have your frontend emit a `progress` message
1320 to fast-import.  The contents of the messages are entirely free-form,
1321 so one suggestion would be to output the current month and year
1322 each time the current commit date moves into the next month.
1323 Your users will feel better knowing how much of the data stream
1324 has been processed.
1327 Packfile Optimization
1328 ---------------------
1329 When packing a blob fast-import always attempts to deltify against the last
1330 blob written.  Unless specifically arranged for by the frontend,
1331 this will probably not be a prior version of the same file, so the
1332 generated delta will not be the smallest possible.  The resulting
1333 packfile will be compressed, but will not be optimal.
1335 Frontends which have efficient access to all revisions of a
1336 single file (for example reading an RCS/CVS ,v file) can choose
1337 to supply all revisions of that file as a sequence of consecutive
1338 `blob` commands.  This allows fast-import to deltify the different file
1339 revisions against each other, saving space in the final packfile.
1340 Marks can be used to later identify individual file revisions during
1341 a sequence of `commit` commands.
1343 The packfile(s) created by fast-import do not encourage good disk access
1344 patterns.  This is caused by fast-import writing the data in the order
1345 it is received on standard input, while Git typically organizes
1346 data within packfiles to make the most recent (current tip) data
1347 appear before historical data.  Git also clusters commits together,
1348 speeding up revision traversal through better cache locality.
1350 For this reason it is strongly recommended that users repack the
1351 repository with `git repack -a -d` after fast-import completes, allowing
1352 Git to reorganize the packfiles for faster data access.  If blob
1353 deltas are suboptimal (see above) then also adding the `-f` option
1354 to force recomputation of all deltas can significantly reduce the
1355 final packfile size (30-50% smaller can be quite typical).
1358 Memory Utilization
1359 ------------------
1360 There are a number of factors which affect how much memory fast-import
1361 requires to perform an import.  Like critical sections of core
1362 Git, fast-import uses its own memory allocators to amortize any overheads
1363 associated with malloc.  In practice fast-import tends to amortize any
1364 malloc overheads to 0, due to its use of large block allocations.
1366 per object
1367 ~~~~~~~~~~
1368 fast-import maintains an in-memory structure for every object written in
1369 this execution.  On a 32 bit system the structure is 32 bytes,
1370 on a 64 bit system the structure is 40 bytes (due to the larger
1371 pointer sizes).  Objects in the table are not deallocated until
1372 fast-import terminates.  Importing 2 million objects on a 32 bit system
1373 will require approximately 64 MiB of memory.
1375 The object table is actually a hashtable keyed on the object name
1376 (the unique SHA-1).  This storage configuration allows fast-import to reuse
1377 an existing or already written object and avoid writing duplicates
1378 to the output packfile.  Duplicate blobs are surprisingly common
1379 in an import, typically due to branch merges in the source.
1381 per mark
1382 ~~~~~~~~
1383 Marks are stored in a sparse array, using 1 pointer (4 bytes or 8
1384 bytes, depending on pointer size) per mark.  Although the array
1385 is sparse, frontends are still strongly encouraged to use marks
1386 between 1 and n, where n is the total number of marks required for
1387 this import.
1389 per branch
1390 ~~~~~~~~~~
1391 Branches are classified as active and inactive.  The memory usage
1392 of the two classes is significantly different.
1394 Inactive branches are stored in a structure which uses 96 or 120
1395 bytes (32 bit or 64 bit systems, respectively), plus the length of
1396 the branch name (typically under 200 bytes), per branch.  fast-import will
1397 easily handle as many as 10,000 inactive branches in under 2 MiB
1398 of memory.
1400 Active branches have the same overhead as inactive branches, but
1401 also contain copies of every tree that has been recently modified on
1402 that branch.  If subtree `include` has not been modified since the
1403 branch became active, its contents will not be loaded into memory,
1404 but if subtree `src` has been modified by a commit since the branch
1405 became active, then its contents will be loaded in memory.
1407 As active branches store metadata about the files contained on that
1408 branch, their in-memory storage size can grow to a considerable size
1409 (see below).
1411 fast-import automatically moves active branches to inactive status based on
1412 a simple least-recently-used algorithm.  The LRU chain is updated on
1413 each `commit` command.  The maximum number of active branches can be
1414 increased or decreased on the command line with \--active-branches=.
1416 per active tree
1417 ~~~~~~~~~~~~~~~
1418 Trees (aka directories) use just 12 bytes of memory on top of the
1419 memory required for their entries (see ``per active file'' below).
1420 The cost of a tree is virtually 0, as its overhead amortizes out
1421 over the individual file entries.
1423 per active file entry
1424 ~~~~~~~~~~~~~~~~~~~~~
1425 Files (and pointers to subtrees) within active trees require 52 or 64
1426 bytes (32/64 bit platforms) per entry.  To conserve space, file and
1427 tree names are pooled in a common string table, allowing the filename
1428 ``Makefile'' to use just 16 bytes (after including the string header
1429 overhead) no matter how many times it occurs within the project.
1431 The active branch LRU, when coupled with the filename string pool
1432 and lazy loading of subtrees, allows fast-import to efficiently import
1433 projects with 2,000+ branches and 45,114+ files in a very limited
1434 memory footprint (less than 2.7 MiB per active branch).
1436 Signals
1437 -------
1438 Sending *SIGUSR1* to the 'git fast-import' process ends the current
1439 packfile early, simulating a `checkpoint` command.  The impatient
1440 operator can use this facility to peek at the objects and refs from an
1441 import in progress, at the cost of some added running time and worse
1442 compression.
1446 Part of the linkgit:git[1] suite