Code

Update draft release notes to 1.7.10
[git.git] / Documentation / git-fast-import.txt
1 git-fast-import(1)
2 ==================
4 NAME
5 ----
6 git-fast-import - Backend for fast Git data importers
9 SYNOPSIS
10 --------
11 [verse]
12 frontend | 'git fast-import' [options]
14 DESCRIPTION
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.
34 OPTIONS
35 -------
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.
42 --force::
43         Force updating modified existing branches, even if doing
44         so would cause commits to be lost (as the new commit does
45         not contain the old commit).
47 --max-pack-size=<n>::
48         Maximum size of each output packfile.
49         The default is unlimited.
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.
57 --depth=<n>::
58         Maximum delta depth, for blob and tree deltification.
59         Default is 10.
61 --active-branches=<n>::
62         Maximum number of branches to maintain active at once.
63         See ``Memory Utilization'' below for details.  Default is 5.
65 --export-marks=<file>::
66         Dumps the internal marks table to <file> when complete.
67         Marks are written one per line as `:markid SHA-1`.
68         Frontends can use this file to validate imports after they
69         have been completed, or to save the marks table across
70         incremental runs.  As <file> is only opened and truncated
71         at checkpoint (or completion) the same path can also be
72         safely given to \--import-marks.
74 --import-marks=<file>::
75         Before processing any input, load the marks specified in
76         <file>.  The input file must exist, must be readable, and
77         must use the same format as produced by \--export-marks.
78         Multiple options may be supplied to import more than one
79         set of marks.  If a mark is defined to different values,
80         the last file wins.
82 --import-marks-if-exists=<file>::
83         Like --import-marks but instead of erroring out, silently
84         skips the file if it does not exist.
86 --relative-marks::
87         After specifying --relative-marks the paths specified
88         with --import-marks= and --export-marks= are relative
89         to an internal directory in the current repository.
90         In git-fast-import this means that the paths are relative
91         to the .git/info/fast-import directory. However, other
92         importers may use a different location.
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.
100 --cat-blob-fd=<fd>::
101         Specify the file descriptor that will be written to
102         when the `cat-blob` command is encountered in the stream.
103         The default behaviour is to write to `stdout`.
105 --done::
106         Require a `done` command at the end of the stream.
107         This option might be useful for detecting errors that
108         cause the frontend to terminate before it has started to
109         write a stream.
111 --export-pack-edges=<file>::
112         After creating a packfile, print a line of data to
113         <file> listing the filename of the packfile and the last
114         commit on each branch that was written to that packfile.
115         This information may be useful after importing projects
116         whose total object set exceeds the 4 GiB packfile limit,
117         as these commits can be used as edge points during calls
118         to 'git pack-objects'.
120 --quiet::
121         Disable all non-fatal output, making fast-import silent when it
122         is successful.  This option disables the output shown by
123         \--stats.
125 --stats::
126         Display some basic statistics about the objects fast-import has
127         created, the packfiles they were stored into, and the
128         memory used by fast-import during this run.  Showing this output
129         is currently the default, but can be disabled with \--quiet.
132 Performance
133 -----------
134 The design of fast-import allows it to import large projects in a minimum
135 amount of memory usage and processing time.  Assuming the frontend
136 is able to keep up with fast-import and feed it a constant stream of data,
137 import times for projects holding 10+ years of history and containing
138 100,000+ individual commits are generally completed in just 1-2
139 hours on quite modest (~$2,000 USD) hardware.
141 Most bottlenecks appear to be in foreign source data access (the
142 source just cannot extract revisions fast enough) or disk IO (fast-import
143 writes as fast as the disk will take the data).  Imports will run
144 faster if the source data is stored on a different drive than the
145 destination Git repository (due to less IO contention).
148 Development Cost
149 ----------------
150 A typical frontend for fast-import tends to weigh in at approximately 200
151 lines of Perl/Python/Ruby code.  Most developers have been able to
152 create working importers in just a couple of hours, even though it
153 is their first exposure to fast-import, and sometimes even to Git.  This is
154 an ideal situation, given that most conversion tools are throw-away
155 (use once, and never look back).
158 Parallel Operation
159 ------------------
160 Like 'git push' or 'git fetch', imports handled by fast-import are safe to
161 run alongside parallel `git repack -a -d` or `git gc` invocations,
162 or any other Git operation (including 'git prune', as loose objects
163 are never used by fast-import).
165 fast-import does not lock the branch or tag refs it is actively importing.
166 After the import, during its ref update phase, fast-import tests each
167 existing branch ref to verify the update will be a fast-forward
168 update (the commit stored in the ref is contained in the new
169 history of the commit to be written).  If the update is not a
170 fast-forward update, fast-import will skip updating that ref and instead
171 prints a warning message.  fast-import will always attempt to update all
172 branch refs, and does not stop on the first failure.
174 Branch updates can be forced with \--force, but it's recommended that
175 this only be used on an otherwise quiet repository.  Using \--force
176 is not necessary for an initial import into an empty repository.
179 Technical Discussion
180 --------------------
181 fast-import tracks a set of branches in memory.  Any branch can be created
182 or modified at any point during the import process by sending a
183 `commit` command on the input stream.  This design allows a frontend
184 program to process an unlimited number of branches simultaneously,
185 generating commits in the order they are available from the source
186 data.  It also simplifies the frontend programs considerably.
188 fast-import does not use or alter the current working directory, or any
189 file within it.  (It does however update the current Git repository,
190 as referenced by `GIT_DIR`.)  Therefore an import frontend may use
191 the working directory for its own purposes, such as extracting file
192 revisions from the foreign source.  This ignorance of the working
193 directory also allows fast-import to run very quickly, as it does not
194 need to perform any costly file update operations when switching
195 between branches.
197 Input Format
198 ------------
199 With the exception of raw file data (which Git does not interpret)
200 the fast-import input format is text (ASCII) based.  This text based
201 format simplifies development and debugging of frontend programs,
202 especially when a higher level language such as Perl, Python or
203 Ruby is being used.
205 fast-import is very strict about its input.  Where we say SP below we mean
206 *exactly* one space.  Likewise LF means one (and only one) linefeed
207 and HT one (and only one) horizontal tab.
208 Supplying additional whitespace characters will cause unexpected
209 results, such as branch names or file names with leading or trailing
210 spaces in their name, or early termination of fast-import when it encounters
211 unexpected input.
213 Stream Comments
214 ~~~~~~~~~~~~~~~
215 To aid in debugging frontends fast-import ignores any line that
216 begins with `#` (ASCII pound/hash) up to and including the line
217 ending `LF`.  A comment line may contain any sequence of bytes
218 that does not contain an LF and therefore may be used to include
219 any detailed debugging information that might be specific to the
220 frontend and useful when inspecting a fast-import data stream.
222 Date Formats
223 ~~~~~~~~~~~~
224 The following date formats are supported.  A frontend should select
225 the format it will use for this import by passing the format name
226 in the \--date-format=<fmt> command line option.
228 `raw`::
229         This is the Git native format and is `<time> SP <offutc>`.
230         It is also fast-import's default format, if \--date-format was
231         not specified.
233 The time of the event is specified by `<time>` as the number of
234 seconds since the UNIX epoch (midnight, Jan 1, 1970, UTC) and is
235 written as an ASCII decimal integer.
237 The local offset is specified by `<offutc>` as a positive or negative
238 offset from UTC.  For example EST (which is 5 hours behind UTC)
239 would be expressed in `<tz>` by ``-0500'' while UTC is ``+0000''.
240 The local offset does not affect `<time>`; it is used only as an
241 advisement to help formatting routines display the timestamp.
243 If the local offset is not available in the source material, use
244 ``+0000'', or the most common local offset.  For example many
245 organizations have a CVS repository which has only ever been accessed
246 by users who are located in the same location and timezone.  In this
247 case a reasonable offset from UTC could be assumed.
249 Unlike the `rfc2822` format, this format is very strict.  Any
250 variation in formatting will cause fast-import to reject the value.
252 `rfc2822`::
253         This is the standard email format as described by RFC 2822.
255 An example value is ``Tue Feb 6 11:22:18 2007 -0500''.  The Git
256 parser is accurate, but a little on the lenient side.  It is the
257 same parser used by 'git am' when applying patches
258 received from email.
260 Some malformed strings may be accepted as valid dates.  In some of
261 these cases Git will still be able to obtain the correct date from
262 the malformed string.  There are also some types of malformed
263 strings which Git will parse wrong, and yet consider valid.
264 Seriously malformed strings will be rejected.
266 Unlike the `raw` format above, the timezone/UTC offset information
267 contained in an RFC 2822 date string is used to adjust the date
268 value to UTC prior to storage.  Therefore it is important that
269 this information be as accurate as possible.
271 If the source material uses RFC 2822 style dates,
272 the frontend should let fast-import handle the parsing and conversion
273 (rather than attempting to do it itself) as the Git parser has
274 been well tested in the wild.
276 Frontends should prefer the `raw` format if the source material
277 already uses UNIX-epoch format, can be coaxed to give dates in that
278 format, or its format is easily convertible to it, as there is no
279 ambiguity in parsing.
281 `now`::
282         Always use the current time and timezone.  The literal
283         `now` must always be supplied for `<when>`.
285 This is a toy format.  The current time and timezone of this system
286 is always copied into the identity string at the time it is being
287 created by fast-import.  There is no way to specify a different time or
288 timezone.
290 This particular format is supplied as it's short to implement and
291 may be useful to a process that wants to create a new commit
292 right now, without needing to use a working directory or
293 'git update-index'.
295 If separate `author` and `committer` commands are used in a `commit`
296 the timestamps may not match, as the system clock will be polled
297 twice (once for each command).  The only way to ensure that both
298 author and committer identity information has the same timestamp
299 is to omit `author` (thus copying from `committer`) or to use a
300 date format other than `now`.
302 Commands
303 ~~~~~~~~
304 fast-import accepts several commands to update the current repository
305 and control the current import process.  More detailed discussion
306 (with examples) of each command follows later.
308 `commit`::
309         Creates a new branch or updates an existing branch by
310         creating a new commit and updating the branch to point at
311         the newly created commit.
313 `tag`::
314         Creates an annotated tag object from an existing commit or
315         branch.  Lightweight tags are not supported by this command,
316         as they are not recommended for recording meaningful points
317         in time.
319 `reset`::
320         Reset an existing branch (or a new branch) to a specific
321         revision.  This command must be used to change a branch to
322         a specific revision without making a commit on it.
324 `blob`::
325         Convert raw file data into a blob, for future use in a
326         `commit` command.  This command is optional and is not
327         needed to perform an import.
329 `checkpoint`::
330         Forces fast-import to close the current packfile, generate its
331         unique SHA-1 checksum and index, and start a new packfile.
332         This command is optional and is not needed to perform
333         an import.
335 `progress`::
336         Causes fast-import to echo the entire line to its own
337         standard output.  This command is optional and is not needed
338         to perform an import.
340 `done`::
341         Marks the end of the stream. This command is optional
342         unless the `done` feature was requested using the
343         `--done` command line option or `feature done` command.
345 `cat-blob`::
346         Causes fast-import to print a blob in 'cat-file --batch'
347         format to the file descriptor set with `--cat-blob-fd` or
348         `stdout` if unspecified.
350 `ls`::
351         Causes fast-import to print a line describing a directory
352         entry in 'ls-tree' format to the file descriptor set with
353         `--cat-blob-fd` or `stdout` if unspecified.
355 `feature`::
356         Require that fast-import supports the specified feature, or
357         abort if it does not.
359 `option`::
360         Specify any of the options listed under OPTIONS that do not
361         change stream semantic to suit the frontend's needs. This
362         command is optional and is not needed to perform an import.
364 `commit`
365 ~~~~~~~~
366 Create or update a branch with a new commit, recording one logical
367 change to the project.
369 ....
370         'commit' SP <ref> LF
371         mark?
372         ('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
373         'committer' (SP <name>)? SP LT <email> GT SP <when> LF
374         data
375         ('from' SP <committish> LF)?
376         ('merge' SP <committish> LF)?
377         (filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
378         LF?
379 ....
381 where `<ref>` is the name of the branch to make the commit on.
382 Typically branch names are prefixed with `refs/heads/` in
383 Git, so importing the CVS branch symbol `RELENG-1_0` would use
384 `refs/heads/RELENG-1_0` for the value of `<ref>`.  The value of
385 `<ref>` must be a valid refname in Git.  As `LF` is not valid in
386 a Git refname, no quoting or escaping syntax is supported here.
388 A `mark` command may optionally appear, requesting fast-import to save a
389 reference to the newly created commit for future use by the frontend
390 (see below for format).  It is very common for frontends to mark
391 every commit they create, thereby allowing future branch creation
392 from any imported commit.
394 The `data` command following `committer` must supply the commit
395 message (see below for `data` command syntax).  To import an empty
396 commit message use a 0 length data.  Commit messages are free-form
397 and are not interpreted by Git.  Currently they must be encoded in
398 UTF-8, as fast-import does not permit other encodings to be specified.
400 Zero or more `filemodify`, `filedelete`, `filecopy`, `filerename`,
401 `filedeleteall` and `notemodify` commands
402 may be included to update the contents of the branch prior to
403 creating the commit.  These commands may be supplied in any order.
404 However it is recommended that a `filedeleteall` command precede
405 all `filemodify`, `filecopy`, `filerename` and `notemodify` commands in
406 the same commit, as `filedeleteall` wipes the branch clean (see below).
408 The `LF` after the command is optional (it used to be required).
410 `author`
411 ^^^^^^^^
412 An `author` command may optionally appear, if the author information
413 might differ from the committer information.  If `author` is omitted
414 then fast-import will automatically use the committer's information for
415 the author portion of the commit.  See below for a description of
416 the fields in `author`, as they are identical to `committer`.
418 `committer`
419 ^^^^^^^^^^^
420 The `committer` command indicates who made this commit, and when
421 they made it.
423 Here `<name>` is the person's display name (for example
424 ``Com M Itter'') and `<email>` is the person's email address
425 (``cm@example.com'').  `LT` and `GT` are the literal less-than (\x3c)
426 and greater-than (\x3e) symbols.  These are required to delimit
427 the email address from the other fields in the line.  Note that
428 `<name>` and `<email>` are free-form and may contain any sequence
429 of bytes, except `LT`, `GT` and `LF`.  `<name>` is typically UTF-8 encoded.
431 The time of the change is specified by `<when>` using the date format
432 that was selected by the \--date-format=<fmt> command line option.
433 See ``Date Formats'' above for the set of supported formats, and
434 their syntax.
436 `from`
437 ^^^^^^
438 The `from` command is used to specify the commit to initialize
439 this branch from.  This revision will be the first ancestor of the
440 new commit.
442 Omitting the `from` command in the first commit of a new branch
443 will cause fast-import to create that commit with no ancestor. This
444 tends to be desired only for the initial commit of a project.
445 If the frontend creates all files from scratch when making a new
446 branch, a `merge` command may be used instead of `from` to start
447 the commit with an empty tree.
448 Omitting the `from` command on existing branches is usually desired,
449 as the current commit on that branch is automatically assumed to
450 be the first ancestor of the new commit.
452 As `LF` is not valid in a Git refname or SHA-1 expression, no
453 quoting or escaping syntax is supported within `<committish>`.
455 Here `<committish>` is any of the following:
457 * The name of an existing branch already in fast-import's internal branch
458   table.  If fast-import doesn't know the name, it's treated as a SHA-1
459   expression.
461 * A mark reference, `:<idnum>`, where `<idnum>` is the mark number.
463 The reason fast-import uses `:` to denote a mark reference is this character
464 is not legal in a Git branch name.  The leading `:` makes it easy
465 to distinguish between the mark 42 (`:42`) and the branch 42 (`42`
466 or `refs/heads/42`), or an abbreviated SHA-1 which happened to
467 consist only of base-10 digits.
469 Marks must be declared (via `mark`) before they can be used.
471 * A complete 40 byte or abbreviated commit SHA-1 in hex.
473 * Any valid Git SHA-1 expression that resolves to a commit.  See
474   ``SPECIFYING REVISIONS'' in linkgit:gitrevisions[7] for details.
476 The special case of restarting an incremental import from the
477 current branch value should be written as:
478 ----
479         from refs/heads/branch^0
480 ----
481 The `{caret}0` suffix is necessary as fast-import does not permit a branch to
482 start from itself, and the branch is created in memory before the
483 `from` command is even read from the input.  Adding `{caret}0` will force
484 fast-import to resolve the commit through Git's revision parsing library,
485 rather than its internal branch table, thereby loading in the
486 existing value of the branch.
488 `merge`
489 ^^^^^^^
490 Includes one additional ancestor commit.  If the `from` command is
491 omitted when creating a new branch, the first `merge` commit will be
492 the first ancestor of the current commit, and the branch will start
493 out with no files.  An unlimited number of `merge` commands per
494 commit are permitted by fast-import, thereby establishing an n-way merge.
495 However Git's other tools never create commits with more than 15
496 additional ancestors (forming a 16-way merge).  For this reason
497 it is suggested that frontends do not use more than 15 `merge`
498 commands per commit; 16, if starting a new, empty branch.
500 Here `<committish>` is any of the commit specification expressions
501 also accepted by `from` (see above).
503 `filemodify`
504 ^^^^^^^^^^^^
505 Included in a `commit` command to add a new file or change the
506 content of an existing file.  This command has two different means
507 of specifying the content of the file.
509 External data format::
510         The data content for the file was already supplied by a prior
511         `blob` command.  The frontend just needs to connect it.
513 ....
514         'M' SP <mode> SP <dataref> SP <path> LF
515 ....
517 Here usually `<dataref>` must be either a mark reference (`:<idnum>`)
518 set by a prior `blob` command, or a full 40-byte SHA-1 of an
519 existing Git blob object.  If `<mode>` is `040000`` then
520 `<dataref>` must be the full 40-byte SHA-1 of an existing
521 Git tree object or a mark reference set with `--import-marks`.
523 Inline data format::
524         The data content for the file has not been supplied yet.
525         The frontend wants to supply it as part of this modify
526         command.
528 ....
529         'M' SP <mode> SP 'inline' SP <path> LF
530         data
531 ....
533 See below for a detailed description of the `data` command.
535 In both formats `<mode>` is the type of file entry, specified
536 in octal.  Git only supports the following modes:
538 * `100644` or `644`: A normal (not-executable) file.  The majority
539   of files in most projects use this mode.  If in doubt, this is
540   what you want.
541 * `100755` or `755`: A normal, but executable, file.
542 * `120000`: A symlink, the content of the file will be the link target.
543 * `160000`: A gitlink, SHA-1 of the object refers to a commit in
544   another repository. Git links can only be specified by SHA or through
545   a commit mark. They are used to implement submodules.
546 * `040000`: A subdirectory.  Subdirectories can only be specified by
547   SHA or through a tree mark set with `--import-marks`.
549 In both formats `<path>` is the complete path of the file to be added
550 (if not already existing) or modified (if already existing).
552 A `<path>` string must use UNIX-style directory separators (forward
553 slash `/`), may contain any byte other than `LF`, and must not
554 start with double quote (`"`).
556 If an `LF` or double quote must be encoded into `<path>` shell-style
557 quoting should be used, e.g. `"path/with\n and \" in it"`.
559 The value of `<path>` must be in canonical form. That is it must not:
561 * contain an empty directory component (e.g. `foo//bar` is invalid),
562 * end with a directory separator (e.g. `foo/` is invalid),
563 * start with a directory separator (e.g. `/foo` is invalid),
564 * contain the special component `.` or `..` (e.g. `foo/./bar` and
565   `foo/../bar` are invalid).
567 The root of the tree can be represented by an empty string as `<path>`.
569 It is recommended that `<path>` always be encoded using UTF-8.
571 `filedelete`
572 ^^^^^^^^^^^^
573 Included in a `commit` command to remove a file or recursively
574 delete an entire directory from the branch.  If the file or directory
575 removal makes its parent directory empty, the parent directory will
576 be automatically removed too.  This cascades up the tree until the
577 first non-empty directory or the root is reached.
579 ....
580         'D' SP <path> LF
581 ....
583 here `<path>` is the complete path of the file or subdirectory to
584 be removed from the branch.
585 See `filemodify` above for a detailed description of `<path>`.
587 `filecopy`
588 ^^^^^^^^^^^^
589 Recursively copies an existing file or subdirectory to a different
590 location within the branch.  The existing file or directory must
591 exist.  If the destination exists it will be completely replaced
592 by the content copied from the source.
594 ....
595         'C' SP <path> SP <path> LF
596 ....
598 here the first `<path>` is the source location and the second
599 `<path>` is the destination.  See `filemodify` above for a detailed
600 description of what `<path>` may look like.  To use a source path
601 that contains SP the path must be quoted.
603 A `filecopy` command takes effect immediately.  Once the source
604 location has been copied to the destination any future commands
605 applied to the source location will not impact the destination of
606 the copy.
608 `filerename`
609 ^^^^^^^^^^^^
610 Renames an existing file or subdirectory to a different location
611 within the branch.  The existing file or directory must exist. If
612 the destination exists it will be replaced by the source directory.
614 ....
615         'R' SP <path> SP <path> LF
616 ....
618 here the first `<path>` is the source location and the second
619 `<path>` is the destination.  See `filemodify` above for a detailed
620 description of what `<path>` may look like.  To use a source path
621 that contains SP the path must be quoted.
623 A `filerename` command takes effect immediately.  Once the source
624 location has been renamed to the destination any future commands
625 applied to the source location will create new files there and not
626 impact the destination of the rename.
628 Note that a `filerename` is the same as a `filecopy` followed by a
629 `filedelete` of the source location.  There is a slight performance
630 advantage to using `filerename`, but the advantage is so small
631 that it is never worth trying to convert a delete/add pair in
632 source material into a rename for fast-import.  This `filerename`
633 command is provided just to simplify frontends that already have
634 rename information and don't want bother with decomposing it into a
635 `filecopy` followed by a `filedelete`.
637 `filedeleteall`
638 ^^^^^^^^^^^^^^^
639 Included in a `commit` command to remove all files (and also all
640 directories) from the branch.  This command resets the internal
641 branch structure to have no files in it, allowing the frontend
642 to subsequently add all interesting files from scratch.
644 ....
645         'deleteall' LF
646 ....
648 This command is extremely useful if the frontend does not know
649 (or does not care to know) what files are currently on the branch,
650 and therefore cannot generate the proper `filedelete` commands to
651 update the content.
653 Issuing a `filedeleteall` followed by the needed `filemodify`
654 commands to set the correct content will produce the same results
655 as sending only the needed `filemodify` and `filedelete` commands.
656 The `filedeleteall` approach may however require fast-import to use slightly
657 more memory per active branch (less than 1 MiB for even most large
658 projects); so frontends that can easily obtain only the affected
659 paths for a commit are encouraged to do so.
661 `notemodify`
662 ^^^^^^^^^^^^
663 Included in a `commit` `<notes_ref>` command to add a new note
664 annotating a `<committish>` or change this annotation contents.
665 Internally it is similar to filemodify 100644 on `<committish>`
666 path (maybe split into subdirectories). It's not advised to
667 use any other commands to write to the `<notes_ref>` tree except
668 `filedeleteall` to delete all existing notes in this tree.
669 This command has two different means of specifying the content
670 of the note.
672 External data format::
673         The data content for the note was already supplied by a prior
674         `blob` command.  The frontend just needs to connect it to the
675         commit that is to be annotated.
677 ....
678         'N' SP <dataref> SP <committish> LF
679 ....
681 Here `<dataref>` can be either a mark reference (`:<idnum>`)
682 set by a prior `blob` command, or a full 40-byte SHA-1 of an
683 existing Git blob object.
685 Inline data format::
686         The data content for the note has not been supplied yet.
687         The frontend wants to supply it as part of this modify
688         command.
690 ....
691         'N' SP 'inline' SP <committish> LF
692         data
693 ....
695 See below for a detailed description of the `data` command.
697 In both formats `<committish>` is any of the commit specification
698 expressions also accepted by `from` (see above).
700 `mark`
701 ~~~~~~
702 Arranges for fast-import to save a reference to the current object, allowing
703 the frontend to recall this object at a future point in time, without
704 knowing its SHA-1.  Here the current object is the object creation
705 command the `mark` command appears within.  This can be `commit`,
706 `tag`, and `blob`, but `commit` is the most common usage.
708 ....
709         'mark' SP ':' <idnum> LF
710 ....
712 where `<idnum>` is the number assigned by the frontend to this mark.
713 The value of `<idnum>` is expressed as an ASCII decimal integer.
714 The value 0 is reserved and cannot be used as
715 a mark.  Only values greater than or equal to 1 may be used as marks.
717 New marks are created automatically.  Existing marks can be moved
718 to another object simply by reusing the same `<idnum>` in another
719 `mark` command.
721 `tag`
722 ~~~~~
723 Creates an annotated tag referring to a specific commit.  To create
724 lightweight (non-annotated) tags see the `reset` command below.
726 ....
727         'tag' SP <name> LF
728         'from' SP <committish> LF
729         'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
730         data
731 ....
733 where `<name>` is the name of the tag to create.
735 Tag names are automatically prefixed with `refs/tags/` when stored
736 in Git, so importing the CVS branch symbol `RELENG-1_0-FINAL` would
737 use just `RELENG-1_0-FINAL` for `<name>`, and fast-import will write the
738 corresponding ref as `refs/tags/RELENG-1_0-FINAL`.
740 The value of `<name>` must be a valid refname in Git and therefore
741 may contain forward slashes.  As `LF` is not valid in a Git refname,
742 no quoting or escaping syntax is supported here.
744 The `from` command is the same as in the `commit` command; see
745 above for details.
747 The `tagger` command uses the same format as `committer` within
748 `commit`; again see above for details.
750 The `data` command following `tagger` must supply the annotated tag
751 message (see below for `data` command syntax).  To import an empty
752 tag message use a 0 length data.  Tag messages are free-form and are
753 not interpreted by Git.  Currently they must be encoded in UTF-8,
754 as fast-import does not permit other encodings to be specified.
756 Signing annotated tags during import from within fast-import is not
757 supported.  Trying to include your own PGP/GPG signature is not
758 recommended, as the frontend does not (easily) have access to the
759 complete set of bytes which normally goes into such a signature.
760 If signing is required, create lightweight tags from within fast-import with
761 `reset`, then create the annotated versions of those tags offline
762 with the standard 'git tag' process.
764 `reset`
765 ~~~~~~~
766 Creates (or recreates) the named branch, optionally starting from
767 a specific revision.  The reset command allows a frontend to issue
768 a new `from` command for an existing branch, or to create a new
769 branch from an existing commit without creating a new commit.
771 ....
772         'reset' SP <ref> LF
773         ('from' SP <committish> LF)?
774         LF?
775 ....
777 For a detailed description of `<ref>` and `<committish>` see above
778 under `commit` and `from`.
780 The `LF` after the command is optional (it used to be required).
782 The `reset` command can also be used to create lightweight
783 (non-annotated) tags.  For example:
785 ====
786         reset refs/tags/938
787         from :938
788 ====
790 would create the lightweight tag `refs/tags/938` referring to
791 whatever commit mark `:938` references.
793 `blob`
794 ~~~~~~
795 Requests writing one file revision to the packfile.  The revision
796 is not connected to any commit; this connection must be formed in
797 a subsequent `commit` command by referencing the blob through an
798 assigned mark.
800 ....
801         'blob' LF
802         mark?
803         data
804 ....
806 The mark command is optional here as some frontends have chosen
807 to generate the Git SHA-1 for the blob on their own, and feed that
808 directly to `commit`.  This is typically more work than it's worth
809 however, as marks are inexpensive to store and easy to use.
811 `data`
812 ~~~~~~
813 Supplies raw data (for use as blob/file content, commit messages, or
814 annotated tag messages) to fast-import.  Data can be supplied using an exact
815 byte count or delimited with a terminating line.  Real frontends
816 intended for production-quality conversions should always use the
817 exact byte count format, as it is more robust and performs better.
818 The delimited format is intended primarily for testing fast-import.
820 Comment lines appearing within the `<raw>` part of `data` commands
821 are always taken to be part of the body of the data and are therefore
822 never ignored by fast-import.  This makes it safe to import any
823 file/message content whose lines might start with `#`.
825 Exact byte count format::
826         The frontend must specify the number of bytes of data.
828 ....
829         'data' SP <count> LF
830         <raw> LF?
831 ....
833 where `<count>` is the exact number of bytes appearing within
834 `<raw>`.  The value of `<count>` is expressed as an ASCII decimal
835 integer.  The `LF` on either side of `<raw>` is not
836 included in `<count>` and will not be included in the imported data.
838 The `LF` after `<raw>` is optional (it used to be required) but
839 recommended.  Always including it makes debugging a fast-import
840 stream easier as the next command always starts in column 0
841 of the next line, even if `<raw>` did not end with an `LF`.
843 Delimited format::
844         A delimiter string is used to mark the end of the data.
845         fast-import will compute the length by searching for the delimiter.
846         This format is primarily useful for testing and is not
847         recommended for real data.
849 ....
850         'data' SP '<<' <delim> LF
851         <raw> LF
852         <delim> LF
853         LF?
854 ....
856 where `<delim>` is the chosen delimiter string.  The string `<delim>`
857 must not appear on a line by itself within `<raw>`, as otherwise
858 fast-import will think the data ends earlier than it really does.  The `LF`
859 immediately trailing `<raw>` is part of `<raw>`.  This is one of
860 the limitations of the delimited format, it is impossible to supply
861 a data chunk which does not have an LF as its last byte.
863 The `LF` after `<delim> LF` is optional (it used to be required).
865 `checkpoint`
866 ~~~~~~~~~~~~
867 Forces fast-import to close the current packfile, start a new one, and to
868 save out all current branch refs, tags and marks.
870 ....
871         'checkpoint' LF
872         LF?
873 ....
875 Note that fast-import automatically switches packfiles when the current
876 packfile reaches \--max-pack-size, or 4 GiB, whichever limit is
877 smaller.  During an automatic packfile switch fast-import does not update
878 the branch refs, tags or marks.
880 As a `checkpoint` can require a significant amount of CPU time and
881 disk IO (to compute the overall pack SHA-1 checksum, generate the
882 corresponding index file, and update the refs) it can easily take
883 several minutes for a single `checkpoint` command to complete.
885 Frontends may choose to issue checkpoints during extremely large
886 and long running imports, or when they need to allow another Git
887 process access to a branch.  However given that a 30 GiB Subversion
888 repository can be loaded into Git through fast-import in about 3 hours,
889 explicit checkpointing may not be necessary.
891 The `LF` after the command is optional (it used to be required).
893 `progress`
894 ~~~~~~~~~~
895 Causes fast-import to print the entire `progress` line unmodified to
896 its standard output channel (file descriptor 1) when the command is
897 processed from the input stream.  The command otherwise has no impact
898 on the current import, or on any of fast-import's internal state.
900 ....
901         'progress' SP <any> LF
902         LF?
903 ....
905 The `<any>` part of the command may contain any sequence of bytes
906 that does not contain `LF`.  The `LF` after the command is optional.
907 Callers may wish to process the output through a tool such as sed to
908 remove the leading part of the line, for example:
910 ====
911         frontend | git fast-import | sed 's/^progress //'
912 ====
914 Placing a `progress` command immediately after a `checkpoint` will
915 inform the reader when the `checkpoint` has been completed and it
916 can safely access the refs that fast-import updated.
918 `cat-blob`
919 ~~~~~~~~~~
920 Causes fast-import to print a blob to a file descriptor previously
921 arranged with the `--cat-blob-fd` argument.  The command otherwise
922 has no impact on the current import; its main purpose is to
923 retrieve blobs that may be in fast-import's memory but not
924 accessible from the target repository.
926 ....
927         'cat-blob' SP <dataref> LF
928 ....
930 The `<dataref>` can be either a mark reference (`:<idnum>`)
931 set previously or a full 40-byte SHA-1 of a Git blob, preexisting or
932 ready to be written.
934 Output uses the same format as `git cat-file --batch`:
936 ====
937         <sha1> SP 'blob' SP <size> LF
938         <contents> LF
939 ====
941 This command can be used anywhere in the stream that comments are
942 accepted.  In particular, the `cat-blob` command can be used in the
943 middle of a commit but not in the middle of a `data` command.
945 `ls`
946 ~~~~
947 Prints information about the object at a path to a file descriptor
948 previously arranged with the `--cat-blob-fd` argument.  This allows
949 printing a blob from the active commit (with `cat-blob`) or copying a
950 blob or tree from a previous commit for use in the current one (with
951 `filemodify`).
953 The `ls` command can be used anywhere in the stream that comments are
954 accepted, including the middle of a commit.
956 Reading from the active commit::
957         This form can only be used in the middle of a `commit`.
958         The path names a directory entry within fast-import's
959         active commit.  The path must be quoted in this case.
961 ....
962         'ls' SP <path> LF
963 ....
965 Reading from a named tree::
966         The `<dataref>` can be a mark reference (`:<idnum>`) or the
967         full 40-byte SHA-1 of a Git tag, commit, or tree object,
968         preexisting or waiting to be written.
969         The path is relative to the top level of the tree
970         named by `<dataref>`.
972 ....
973         'ls' SP <dataref> SP <path> LF
974 ....
976 See `filemodify` above for a detailed description of `<path>`.
978 Output uses the same format as `git ls-tree <tree> {litdd} <path>`:
980 ====
981         <mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF
982 ====
984 The <dataref> represents the blob, tree, or commit object at <path>
985 and can be used in later 'cat-blob', 'filemodify', or 'ls' commands.
987 If there is no file or subtree at that path, 'git fast-import' will
988 instead report
990 ====
991         missing SP <path> LF
992 ====
994 `feature`
995 ~~~~~~~~~
996 Require that fast-import supports the specified feature, or abort if
997 it does not.
999 ....
1000         'feature' SP <feature> ('=' <argument>)? LF
1001 ....
1003 The <feature> part of the command may be any one of the following:
1005 date-format::
1006 export-marks::
1007 relative-marks::
1008 no-relative-marks::
1009 force::
1010         Act as though the corresponding command-line option with
1011         a leading '--' was passed on the command line
1012         (see OPTIONS, above).
1014 import-marks::
1015 import-marks-if-exists::
1016         Like --import-marks except in two respects: first, only one
1017         "feature import-marks" or "feature import-marks-if-exists"
1018         command is allowed per stream; second, an --import-marks=
1019         or --import-marks-if-exists command-line option overrides
1020         any of these "feature" commands in the stream; third,
1021         "feature import-marks-if-exists" like a corresponding
1022         command-line option silently skips a nonexistent file.
1024 cat-blob::
1025 ls::
1026         Require that the backend support the 'cat-blob' or 'ls' command.
1027         Versions of fast-import not supporting the specified command
1028         will exit with a message indicating so.
1029         This lets the import error out early with a clear message,
1030         rather than wasting time on the early part of an import
1031         before the unsupported command is detected.
1033 notes::
1034         Require that the backend support the 'notemodify' (N)
1035         subcommand to the 'commit' command.
1036         Versions of fast-import not supporting notes will exit
1037         with a message indicating so.
1039 done::
1040         Error out if the stream ends without a 'done' command.
1041         Without this feature, errors causing the frontend to end
1042         abruptly at a convenient point in the stream can go
1043         undetected.
1045 `option`
1046 ~~~~~~~~
1047 Processes the specified option so that git fast-import behaves in a
1048 way that suits the frontend's needs.
1049 Note that options specified by the frontend are overridden by any
1050 options the user may specify to git fast-import itself.
1052 ....
1053     'option' SP <option> LF
1054 ....
1056 The `<option>` part of the command may contain any of the options
1057 listed in the OPTIONS section that do not change import semantics,
1058 without the leading '--' and is treated in the same way.
1060 Option commands must be the first commands on the input (not counting
1061 feature commands), to give an option command after any non-option
1062 command is an error.
1064 The following commandline options change import semantics and may therefore
1065 not be passed as option:
1067 * date-format
1068 * import-marks
1069 * export-marks
1070 * cat-blob-fd
1071 * force
1073 `done`
1074 ~~~~~~
1075 If the `done` feature is not in use, treated as if EOF was read.
1076 This can be used to tell fast-import to finish early.
1078 If the `--done` command line option or `feature done` command is
1079 in use, the `done` command is mandatory and marks the end of the
1080 stream.
1082 Crash Reports
1083 -------------
1084 If fast-import is supplied invalid input it will terminate with a
1085 non-zero exit status and create a crash report in the top level of
1086 the Git repository it was importing into.  Crash reports contain
1087 a snapshot of the internal fast-import state as well as the most
1088 recent commands that lead up to the crash.
1090 All recent commands (including stream comments, file changes and
1091 progress commands) are shown in the command history within the crash
1092 report, but raw file data and commit messages are excluded from the
1093 crash report.  This exclusion saves space within the report file
1094 and reduces the amount of buffering that fast-import must perform
1095 during execution.
1097 After writing a crash report fast-import will close the current
1098 packfile and export the marks table.  This allows the frontend
1099 developer to inspect the repository state and resume the import from
1100 the point where it crashed.  The modified branches and tags are not
1101 updated during a crash, as the import did not complete successfully.
1102 Branch and tag information can be found in the crash report and
1103 must be applied manually if the update is needed.
1105 An example crash:
1107 ====
1108         $ cat >in <<END_OF_INPUT
1109         # my very first test commit
1110         commit refs/heads/master
1111         committer Shawn O. Pearce <spearce> 19283 -0400
1112         # who is that guy anyway?
1113         data <<EOF
1114         this is my commit
1115         EOF
1116         M 644 inline .gitignore
1117         data <<EOF
1118         .gitignore
1119         EOF
1120         M 777 inline bob
1121         END_OF_INPUT
1123         $ git fast-import <in
1124         fatal: Corrupt mode: M 777 inline bob
1125         fast-import: dumping crash report to .git/fast_import_crash_8434
1127         $ cat .git/fast_import_crash_8434
1128         fast-import crash report:
1129             fast-import process: 8434
1130             parent process     : 1391
1131             at Sat Sep 1 00:58:12 2007
1133         fatal: Corrupt mode: M 777 inline bob
1135         Most Recent Commands Before Crash
1136         ---------------------------------
1137           # my very first test commit
1138           commit refs/heads/master
1139           committer Shawn O. Pearce <spearce> 19283 -0400
1140           # who is that guy anyway?
1141           data <<EOF
1142           M 644 inline .gitignore
1143           data <<EOF
1144         * M 777 inline bob
1146         Active Branch LRU
1147         -----------------
1148             active_branches = 1 cur, 5 max
1150           pos  clock name
1151           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1152            1)      0 refs/heads/master
1154         Inactive Branches
1155         -----------------
1156         refs/heads/master:
1157           status      : active loaded dirty
1158           tip commit  : 0000000000000000000000000000000000000000
1159           old tree    : 0000000000000000000000000000000000000000
1160           cur tree    : 0000000000000000000000000000000000000000
1161           commit clock: 0
1162           last pack   :
1165         -------------------
1166         END OF CRASH REPORT
1167 ====
1169 Tips and Tricks
1170 ---------------
1171 The following tips and tricks have been collected from various
1172 users of fast-import, and are offered here as suggestions.
1174 Use One Mark Per Commit
1175 ~~~~~~~~~~~~~~~~~~~~~~~
1176 When doing a repository conversion, use a unique mark per commit
1177 (`mark :<n>`) and supply the \--export-marks option on the command
1178 line.  fast-import will dump a file which lists every mark and the Git
1179 object SHA-1 that corresponds to it.  If the frontend can tie
1180 the marks back to the source repository, it is easy to verify the
1181 accuracy and completeness of the import by comparing each Git
1182 commit to the corresponding source revision.
1184 Coming from a system such as Perforce or Subversion this should be
1185 quite simple, as the fast-import mark can also be the Perforce changeset
1186 number or the Subversion revision number.
1188 Freely Skip Around Branches
1189 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1190 Don't bother trying to optimize the frontend to stick to one branch
1191 at a time during an import.  Although doing so might be slightly
1192 faster for fast-import, it tends to increase the complexity of the frontend
1193 code considerably.
1195 The branch LRU builtin to fast-import tends to behave very well, and the
1196 cost of activating an inactive branch is so low that bouncing around
1197 between branches has virtually no impact on import performance.
1199 Handling Renames
1200 ~~~~~~~~~~~~~~~~
1201 When importing a renamed file or directory, simply delete the old
1202 name(s) and modify the new name(s) during the corresponding commit.
1203 Git performs rename detection after-the-fact, rather than explicitly
1204 during a commit.
1206 Use Tag Fixup Branches
1207 ~~~~~~~~~~~~~~~~~~~~~~
1208 Some other SCM systems let the user create a tag from multiple
1209 files which are not from the same commit/changeset.  Or to create
1210 tags which are a subset of the files available in the repository.
1212 Importing these tags as-is in Git is impossible without making at
1213 least one commit which ``fixes up'' the files to match the content
1214 of the tag.  Use fast-import's `reset` command to reset a dummy branch
1215 outside of your normal branch space to the base commit for the tag,
1216 then commit one or more file fixup commits, and finally tag the
1217 dummy branch.
1219 For example since all normal branches are stored under `refs/heads/`
1220 name the tag fixup branch `TAG_FIXUP`.  This way it is impossible for
1221 the fixup branch used by the importer to have namespace conflicts
1222 with real branches imported from the source (the name `TAG_FIXUP`
1223 is not `refs/heads/TAG_FIXUP`).
1225 When committing fixups, consider using `merge` to connect the
1226 commit(s) which are supplying file revisions to the fixup branch.
1227 Doing so will allow tools such as 'git blame' to track
1228 through the real commit history and properly annotate the source
1229 files.
1231 After fast-import terminates the frontend will need to do `rm .git/TAG_FIXUP`
1232 to remove the dummy branch.
1234 Import Now, Repack Later
1235 ~~~~~~~~~~~~~~~~~~~~~~~~
1236 As soon as fast-import completes the Git repository is completely valid
1237 and ready for use.  Typically this takes only a very short time,
1238 even for considerably large projects (100,000+ commits).
1240 However repacking the repository is necessary to improve data
1241 locality and access performance.  It can also take hours on extremely
1242 large projects (especially if -f and a large \--window parameter is
1243 used).  Since repacking is safe to run alongside readers and writers,
1244 run the repack in the background and let it finish when it finishes.
1245 There is no reason to wait to explore your new Git project!
1247 If you choose to wait for the repack, don't try to run benchmarks
1248 or performance tests until repacking is completed.  fast-import outputs
1249 suboptimal packfiles that are simply never seen in real use
1250 situations.
1252 Repacking Historical Data
1253 ~~~~~~~~~~~~~~~~~~~~~~~~~
1254 If you are repacking very old imported data (e.g. older than the
1255 last year), consider expending some extra CPU time and supplying
1256 \--window=50 (or higher) when you run 'git repack'.
1257 This will take longer, but will also produce a smaller packfile.
1258 You only need to expend the effort once, and everyone using your
1259 project will benefit from the smaller repository.
1261 Include Some Progress Messages
1262 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1263 Every once in a while have your frontend emit a `progress` message
1264 to fast-import.  The contents of the messages are entirely free-form,
1265 so one suggestion would be to output the current month and year
1266 each time the current commit date moves into the next month.
1267 Your users will feel better knowing how much of the data stream
1268 has been processed.
1271 Packfile Optimization
1272 ---------------------
1273 When packing a blob fast-import always attempts to deltify against the last
1274 blob written.  Unless specifically arranged for by the frontend,
1275 this will probably not be a prior version of the same file, so the
1276 generated delta will not be the smallest possible.  The resulting
1277 packfile will be compressed, but will not be optimal.
1279 Frontends which have efficient access to all revisions of a
1280 single file (for example reading an RCS/CVS ,v file) can choose
1281 to supply all revisions of that file as a sequence of consecutive
1282 `blob` commands.  This allows fast-import to deltify the different file
1283 revisions against each other, saving space in the final packfile.
1284 Marks can be used to later identify individual file revisions during
1285 a sequence of `commit` commands.
1287 The packfile(s) created by fast-import do not encourage good disk access
1288 patterns.  This is caused by fast-import writing the data in the order
1289 it is received on standard input, while Git typically organizes
1290 data within packfiles to make the most recent (current tip) data
1291 appear before historical data.  Git also clusters commits together,
1292 speeding up revision traversal through better cache locality.
1294 For this reason it is strongly recommended that users repack the
1295 repository with `git repack -a -d` after fast-import completes, allowing
1296 Git to reorganize the packfiles for faster data access.  If blob
1297 deltas are suboptimal (see above) then also adding the `-f` option
1298 to force recomputation of all deltas can significantly reduce the
1299 final packfile size (30-50% smaller can be quite typical).
1302 Memory Utilization
1303 ------------------
1304 There are a number of factors which affect how much memory fast-import
1305 requires to perform an import.  Like critical sections of core
1306 Git, fast-import uses its own memory allocators to amortize any overheads
1307 associated with malloc.  In practice fast-import tends to amortize any
1308 malloc overheads to 0, due to its use of large block allocations.
1310 per object
1311 ~~~~~~~~~~
1312 fast-import maintains an in-memory structure for every object written in
1313 this execution.  On a 32 bit system the structure is 32 bytes,
1314 on a 64 bit system the structure is 40 bytes (due to the larger
1315 pointer sizes).  Objects in the table are not deallocated until
1316 fast-import terminates.  Importing 2 million objects on a 32 bit system
1317 will require approximately 64 MiB of memory.
1319 The object table is actually a hashtable keyed on the object name
1320 (the unique SHA-1).  This storage configuration allows fast-import to reuse
1321 an existing or already written object and avoid writing duplicates
1322 to the output packfile.  Duplicate blobs are surprisingly common
1323 in an import, typically due to branch merges in the source.
1325 per mark
1326 ~~~~~~~~
1327 Marks are stored in a sparse array, using 1 pointer (4 bytes or 8
1328 bytes, depending on pointer size) per mark.  Although the array
1329 is sparse, frontends are still strongly encouraged to use marks
1330 between 1 and n, where n is the total number of marks required for
1331 this import.
1333 per branch
1334 ~~~~~~~~~~
1335 Branches are classified as active and inactive.  The memory usage
1336 of the two classes is significantly different.
1338 Inactive branches are stored in a structure which uses 96 or 120
1339 bytes (32 bit or 64 bit systems, respectively), plus the length of
1340 the branch name (typically under 200 bytes), per branch.  fast-import will
1341 easily handle as many as 10,000 inactive branches in under 2 MiB
1342 of memory.
1344 Active branches have the same overhead as inactive branches, but
1345 also contain copies of every tree that has been recently modified on
1346 that branch.  If subtree `include` has not been modified since the
1347 branch became active, its contents will not be loaded into memory,
1348 but if subtree `src` has been modified by a commit since the branch
1349 became active, then its contents will be loaded in memory.
1351 As active branches store metadata about the files contained on that
1352 branch, their in-memory storage size can grow to a considerable size
1353 (see below).
1355 fast-import automatically moves active branches to inactive status based on
1356 a simple least-recently-used algorithm.  The LRU chain is updated on
1357 each `commit` command.  The maximum number of active branches can be
1358 increased or decreased on the command line with \--active-branches=.
1360 per active tree
1361 ~~~~~~~~~~~~~~~
1362 Trees (aka directories) use just 12 bytes of memory on top of the
1363 memory required for their entries (see ``per active file'' below).
1364 The cost of a tree is virtually 0, as its overhead amortizes out
1365 over the individual file entries.
1367 per active file entry
1368 ~~~~~~~~~~~~~~~~~~~~~
1369 Files (and pointers to subtrees) within active trees require 52 or 64
1370 bytes (32/64 bit platforms) per entry.  To conserve space, file and
1371 tree names are pooled in a common string table, allowing the filename
1372 ``Makefile'' to use just 16 bytes (after including the string header
1373 overhead) no matter how many times it occurs within the project.
1375 The active branch LRU, when coupled with the filename string pool
1376 and lazy loading of subtrees, allows fast-import to efficiently import
1377 projects with 2,000+ branches and 45,114+ files in a very limited
1378 memory footprint (less than 2.7 MiB per active branch).
1380 Signals
1381 -------
1382 Sending *SIGUSR1* to the 'git fast-import' process ends the current
1383 packfile early, simulating a `checkpoint` command.  The impatient
1384 operator can use this facility to peek at the objects and refs from an
1385 import in progress, at the cost of some added running time and worse
1386 compression.
1388 GIT
1389 ---
1390 Part of the linkgit:git[1] suite