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