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