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