Code

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