Code

8bb5a0b36b2850de05e6a1588ad236acc82aa882
[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 (gfi).
20 gfi 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 gfi backend itself can import into an empty repository (one that
27 has already been initialized by gitlink:git-init[1]) 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         gfi 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, expressed in MiB.
48         The default is 4096 (4 GiB) as that is the maximum allowed
49         packfile size (due to file format limitations). Some
50         importers may wish to lower this, such as to ensure the
51         resulting packfiles fit on CDs.
53 --depth=<n>::
54         Maximum delta depth, for blob and tree deltification.
55         Default is 10.
57 --active-branches=<n>::
58         Maximum number of branches to maintain active at once.
59         See ``Memory Utilization'' below for details.  Default is 5.
61 --export-marks=<file>::
62         Dumps the internal marks table to <file> when complete.
63         Marks are written one per line as `:markid SHA-1`.
64         Frontends can use this file to validate imports after they
65         have been completed.
67 Performance
68 -----------
69 The design of gfi allows it to import large projects in a minimum
70 amount of memory usage and processing time.  Assuming the frontend
71 is able to keep up with gfi and feed it a constant stream of data,
72 import times for projects holding 10+ years of history and containing
73 100,000+ individual commits are generally completed in just 1-2
74 hours on quite modest (~$2,000 USD) hardware.
76 Most bottlenecks appear to be in foreign source data access (the
77 source just cannot extract revisions fast enough) or disk IO (gfi
78 writes as fast as the disk will take the data).  Imports will run
79 faster if the source data is stored on a different drive than the
80 destination Git repository (due to less IO contention).
83 Development Cost
84 ----------------
85 A typical frontend for gfi tends to weigh in at approximately 200
86 lines of Perl/Python/Ruby code.  Most developers have been able to
87 create working importers in just a couple of hours, even though it
88 is their first exposure to gfi, and sometimes even to Git.  This is
89 an ideal situation, given that most conversion tools are throw-away
90 (use once, and never look back).
93 Parallel Operation
94 ------------------
95 Like `git-push` or `git-fetch`, imports handled by gfi are safe to
96 run alongside parallel `git repack -a -d` or `git gc` invocations,
97 or any other Git operation (including `git prune`, as loose objects
98 are never used by gfi).
100 gfi does not lock the branch or tag refs it is actively importing.
101 After the import, during its ref update phase, gfi tests each
102 existing branch ref to verify the update will be a fast-forward
103 update (the commit stored in the ref is contained in the new
104 history of the commit to be written).  If the update is not a
105 fast-forward update, gfi will skip updating that ref and instead
106 prints a warning message.  gfi will always attempt to update all
107 branch refs, and does not stop on the first failure.
109 Branch updates can be forced with `--force`, but its recommended that
110 this only be used on an otherwise quiet repository.  Using `--force`
111 is not necessary for an initial import into an empty repository.
114 Technical Discussion
115 --------------------
116 gfi tracks a set of branches in memory.  Any branch can be created
117 or modified at any point during the import process by sending a
118 `commit` command on the input stream.  This design allows a frontend
119 program to process an unlimited number of branches simultaneously,
120 generating commits in the order they are available from the source
121 data.  It also simplifies the frontend programs considerably.
123 gfi does not use or alter the current working directory, or any
124 file within it.  (It does however update the current Git repository,
125 as referenced by `GIT_DIR`.)  Therefore an import frontend may use
126 the working directory for its own purposes, such as extracting file
127 revisions from the foreign source.  This ignorance of the working
128 directory also allows gfi to run very quickly, as it does not
129 need to perform any costly file update operations when switching
130 between branches.
132 Input Format
133 ------------
134 With the exception of raw file data (which Git does not interpret)
135 the gfi input format is text (ASCII) based.  This text based
136 format simplifies development and debugging of frontend programs,
137 especially when a higher level language such as Perl, Python or
138 Ruby is being used.
140 gfi is very strict about its input.  Where we say SP below we mean
141 *exactly* one space.  Likewise LF means one (and only one) linefeed.
142 Supplying additional whitespace characters will cause unexpected
143 results, such as branch names or file names with leading or trailing
144 spaces in their name, or early termination of gfi when it encounters
145 unexpected input.
147 Date Formats
148 ~~~~~~~~~~~~
149 The following date formats are supported.  A frontend should select
150 the format it will use for this import by passing the format name
151 in the `--date-format=<fmt>` command line option.
153 `raw`::
154         This is the Git native format and is `<time> SP <offutc>`.
155         It is also gfi's default format, if `--date-format` was
156         not specified.
158 The time of the event is specified by `<time>` as the number of
159 seconds since the UNIX epoch (midnight, Jan 1, 1970, UTC) and is
160 written as an ASCII decimal integer.
162 The local offset is specified by `<offutc>` as a positive or negative
163 offset from UTC.  For example EST (which is 5 hours behind UTC)
164 would be expressed in `<tz>` by ``-0500'' while UTC is ``+0000''.
165 The local offset does not affect `<time>`; it is used only as an
166 advisement to help formatting routines display the timestamp.
168 If the local offset is not available in the source material, use
169 ``+0000'', or the most common local offset.  For example many
170 organizations have a CVS repository which has only ever been accessed
171 by users who are located in the same location and timezone.  In this
172 case the offset from UTC can be easily assumed.
174 Unlike the `rfc2822` format, this format is very strict.  Any
175 variation in formatting will cause gfi to reject the value.
177 `rfc2822`::
178         This is the standard email format as described by RFC 2822.
180 An example value is ``Tue Feb 6 11:22:18 2007 -0500''.  The Git
181 parser is accurate, but a little on the lenient side.  Its the
182 same parser used by gitlink:git-am[1] when applying patches
183 received from email.
185 Some malformed strings may be accepted as valid dates.  In some of
186 these cases Git will still be able to obtain the correct date from
187 the malformed string.  There are also some types of malformed
188 strings which Git will parse wrong, and yet consider valid.
189 Seriously malformed strings will be rejected.
191 Unlike the `raw` format above, the timezone/UTC offset information
192 contained in an RFC 2822 date string is used to adjust the date
193 value to UTC prior to storage.  Therefore it is important that
194 this information be as accurate as possible.
196 If the source material is formatted in RFC 2822 style dates,
197 the frontend should let gfi handle the parsing and conversion
198 (rather than attempting to do it itself) as the Git parser has
199 been well tested in the wild.
201 Frontends should prefer the `raw` format if the source material
202 is already in UNIX-epoch format, or is easily convertible to
203 that format, as there is no ambiguity in parsing.
205 `now`::
206         Always use the current time and timezone.  The literal
207         `now` must always be supplied for `<when>`.
209 This is a toy format.  The current time and timezone of this system
210 is always copied into the identity string at the time it is being
211 created by gfi.  There is no way to specify a different time or
212 timezone.
214 This particular format is supplied as its short to implement and
215 may be useful to a process that wants to create a new commit
216 right now, without needing to use a working directory or
217 gitlink:git-update-index[1].
219 If separate `author` and `committer` commands are used in a `commit`
220 the timestamps may not match, as the system clock will be polled
221 twice (once for each command).  The only way to ensure that both
222 author and committer identity information has the same timestamp
223 is to omit `author` (thus copying from `committer`) or to use a
224 date format other than `now`.
226 Commands
227 ~~~~~~~~
228 gfi accepts several commands to update the current repository
229 and control the current import process.  More detailed discussion
230 (with examples) of each command follows later.
232 `commit`::
233         Creates a new branch or updates an existing branch by
234         creating a new commit and updating the branch to point at
235         the newly created commit.
237 `tag`::
238         Creates an annotated tag object from an existing commit or
239         branch.  Lightweight tags are not supported by this command,
240         as they are not recommended for recording meaningful points
241         in time.
243 `reset`::
244         Reset an existing branch (or a new branch) to a specific
245         revision.  This command must be used to change a branch to
246         a specific revision without making a commit on it.
248 `blob`::
249         Convert raw file data into a blob, for future use in a
250         `commit` command.  This command is optional and is not
251         needed to perform an import.
253 `checkpoint`::
254         Forces gfi to close the current packfile, generate its
255         unique SHA-1 checksum and index, and start a new packfile.
256         This command is optional and is not needed to perform
257         an import.
259 `commit`
260 ~~~~~~~~
261 Create or update a branch with a new commit, recording one logical
262 change to the project.
264 ....
265         'commit' SP <ref> LF
266         mark?
267         ('author' SP <name> SP LT <email> GT SP <when> LF)?
268         'committer' SP <name> SP LT <email> GT SP <when> LF
269         data
270         ('from' SP <committish> LF)?
271         ('merge' SP <committish> LF)?
272         (filemodify | filedelete | filedeleteall)*
273         LF
274 ....
276 where `<ref>` is the name of the branch to make the commit on.
277 Typically branch names are prefixed with `refs/heads/` in
278 Git, so importing the CVS branch symbol `RELENG-1_0` would use
279 `refs/heads/RELENG-1_0` for the value of `<ref>`.  The value of
280 `<ref>` must be a valid refname in Git.  As `LF` is not valid in
281 a Git refname, no quoting or escaping syntax is supported here.
283 A `mark` command may optionally appear, requesting gfi to save a
284 reference to the newly created commit for future use by the frontend
285 (see below for format).  It is very common for frontends to mark
286 every commit they create, thereby allowing future branch creation
287 from any imported commit.
289 The `data` command following `committer` must supply the commit
290 message (see below for `data` command syntax).  To import an empty
291 commit message use a 0 length data.  Commit messages are free-form
292 and are not interpreted by Git.  Currently they must be encoded in
293 UTF-8, as gfi does not permit other encodings to be specified.
295 Zero or more `filemodify`, `filedelete` and `filedeleteall` commands
296 may be included to update the contents of the branch prior to
297 creating the commit.  These commands may be supplied in any order.
298 However it is recommended that a `filedeleteall` command preceed
299 all `filemodify` commands in the same commit, as `filedeleteall`
300 wipes the branch clean (see below).
302 `author`
303 ^^^^^^^^
304 An `author` command may optionally appear, if the author information
305 might differ from the committer information.  If `author` is omitted
306 then gfi will automatically use the committer's information for
307 the author portion of the commit.  See below for a description of
308 the fields in `author`, as they are identical to `committer`.
310 `committer`
311 ^^^^^^^^^^^
312 The `committer` command indicates who made this commit, and when
313 they made it.
315 Here `<name>` is the person's display name (for example
316 ``Com M Itter'') and `<email>` is the person's email address
317 (``cm@example.com'').  `LT` and `GT` are the literal less-than (\x3c)
318 and greater-than (\x3e) symbols.  These are required to delimit
319 the email address from the other fields in the line.  Note that
320 `<name>` is free-form and may contain any sequence of bytes, except
321 `LT` and `LF`.  It is typically UTF-8 encoded.
323 The time of the change is specified by `<when>` using the date format
324 that was selected by the `--date-format=<fmt>` command line option.
325 See ``Date Formats'' above for the set of supported formats, and
326 their syntax.
328 `from`
329 ^^^^^^
330 Only valid for the first commit made on this branch by this
331 gfi process.  The `from` command is used to specify the commit
332 to initialize this branch from.  This revision will be the first
333 ancestor of the new commit.
335 Omitting the `from` command in the first commit of a new branch will
336 cause gfi to create that commit with no ancestor. This tends to be
337 desired only for the initial commit of a project.  Omitting the
338 `from` command on existing branches is required, as the current
339 commit on that branch is automatically assumed to be the first
340 ancestor of the new commit.
342 As `LF` is not valid in a Git refname or SHA-1 expression, no
343 quoting or escaping syntax is supported within `<committish>`.
345 Here `<committish>` is any of the following:
347 * The name of an existing branch already in gfi's internal branch
348   table.  If gfi doesn't know the name, its treated as a SHA-1
349   expression.
351 * A mark reference, `:<idnum>`, where `<idnum>` is the mark number.
353 The reason gfi uses `:` to denote a mark reference is this character
354 is not legal in a Git branch name.  The leading `:` makes it easy
355 to distingush between the mark 42 (`:42`) and the branch 42 (`42`
356 or `refs/heads/42`), or an abbreviated SHA-1 which happened to
357 consist only of base-10 digits.
359 Marks must be declared (via `mark`) before they can be used.
361 * A complete 40 byte or abbreviated commit SHA-1 in hex.
363 * Any valid Git SHA-1 expression that resolves to a commit.  See
364   ``SPECIFYING REVISIONS'' in gitlink:git-rev-parse[1] for details.
366 The special case of restarting an incremental import from the
367 current branch value should be written as:
368 ----
369         from refs/heads/branch^0
370 ----
371 The `^0` suffix is necessary as gfi does not permit a branch to
372 start from itself, and the branch is created in memory before the
373 `from` command is even read from the input.  Adding `^0` will force
374 gfi to resolve the commit through Git's revision parsing library,
375 rather than its internal branch table, thereby loading in the
376 existing value of the branch.
378 `merge`
379 ^^^^^^^
380 Includes one additional ancestor commit, and makes the current
381 commit a merge commit.  An unlimited number of `merge` commands per
382 commit are permitted by gfi, thereby establishing an n-way merge.
383 However Git's other tools never create commits with more than 15
384 additional ancestors (forming a 16-way merge).  For this reason
385 it is suggested that frontends do not use more than 15 `merge`
386 commands per commit.
388 Here `<committish>` is any of the commit specification expressions
389 also accepted by `from` (see above).
391 `filemodify`
392 ^^^^^^^^^^^^
393 Included in a `commit` command to add a new file or change the
394 content of an existing file.  This command has two different means
395 of specifying the content of the file.
397 External data format::
398         The data content for the file was already supplied by a prior
399         `blob` command.  The frontend just needs to connect it.
401 ....
402         'M' SP <mode> SP <dataref> SP <path> LF
403 ....
405 Here `<dataref>` can be either a mark reference (`:<idnum>`)
406 set by a prior `blob` command, or a full 40-byte SHA-1 of an
407 existing Git blob object.
409 Inline data format::
410         The data content for the file has not been supplied yet.
411         The frontend wants to supply it as part of this modify
412         command.
414 ....
415         'M' SP <mode> SP 'inline' SP <path> LF
416         data
417 ....
419 See below for a detailed description of the `data` command.
421 In both formats `<mode>` is the type of file entry, specified
422 in octal.  Git only supports the following modes:
424 * `100644` or `644`: A normal (not-executable) file.  The majority
425   of files in most projects use this mode.  If in doubt, this is
426   what you want.
427 * `100755` or `755`: A normal, but executable, file.
428 * `120000`: A symlink, the content of the file will be the link target.
430 In both formats `<path>` is the complete path of the file to be added
431 (if not already existing) or modified (if already existing).
433 A `<path>` string must use UNIX-style directory seperators (forward
434 slash `/`), may contain any byte other than `LF`, and must not
435 start with double quote (`"`).
437 If an `LF` or double quote must be encoded into `<path>` shell-style
438 quoting should be used, e.g. `"path/with\n and \" in it"`.
440 The value of `<path>` must be in canoncial form. That is it must not:
442 * contain an empty directory component (e.g. `foo//bar` is invalid),
443 * end with a directory seperator (e.g. `foo/` is invalid),
444 * start with a directory seperator (e.g. `/foo` is invalid),
445 * contain the special component `.` or `..` (e.g. `foo/./bar` and
446   `foo/../bar` are invalid).
448 It is recommended that `<path>` always be encoded using UTF-8.
450 `filedelete`
451 ^^^^^^^^^^^^
452 Included in a `commit` command to remove a file from the branch.
453 If the file removal makes its directory empty, the directory will
454 be automatically removed too.  This cascades up the tree until the
455 first non-empty directory or the root is reached.
457 ....
458         'D' SP <path> LF
459 ....
461 here `<path>` is the complete path of the file to be removed.
462 See `filemodify` above for a detailed description of `<path>`.
464 `filedeleteall`
465 ^^^^^^^^^^^^^^^
466 Included in a `commit` command to remove all files (and also all
467 directories) from the branch.  This command resets the internal
468 branch structure to have no files in it, allowing the frontend
469 to subsequently add all interesting files from scratch.
471 ....
472         'deleteall' LF
473 ....
475 This command is extremely useful if the frontend does not know
476 (or does not care to know) what files are currently on the branch,
477 and therefore cannot generate the proper `filedelete` commands to
478 update the content.
480 Issuing a `filedeleteall` followed by the needed `filemodify`
481 commands to set the correct content will produce the same results
482 as sending only the needed `filemodify` and `filedelete` commands.
483 The `filedeleteall` approach may however require gfi to use slightly
484 more memory per active branch (less than 1 MiB for even most large
485 projects); so frontends that can easily obtain only the affected
486 paths for a commit are encouraged to do so.
488 `mark`
489 ~~~~~~
490 Arranges for gfi to save a reference to the current object, allowing
491 the frontend to recall this object at a future point in time, without
492 knowing its SHA-1.  Here the current object is the object creation
493 command the `mark` command appears within.  This can be `commit`,
494 `tag`, and `blob`, but `commit` is the most common usage.
496 ....
497         'mark' SP ':' <idnum> LF
498 ....
500 where `<idnum>` is the number assigned by the frontend to this mark.
501 The value of `<idnum>` is expressed as an ASCII decimal integer.
502 The value 0 is reserved and cannot be used as
503 a mark.  Only values greater than or equal to 1 may be used as marks.
505 New marks are created automatically.  Existing marks can be moved
506 to another object simply by reusing the same `<idnum>` in another
507 `mark` command.
509 `tag`
510 ~~~~~
511 Creates an annotated tag referring to a specific commit.  To create
512 lightweight (non-annotated) tags see the `reset` command below.
514 ....
515         'tag' SP <name> LF
516         'from' SP <committish> LF
517         'tagger' SP <name> SP LT <email> GT SP <when> LF
518         data
519         LF
520 ....
522 where `<name>` is the name of the tag to create.
524 Tag names are automatically prefixed with `refs/tags/` when stored
525 in Git, so importing the CVS branch symbol `RELENG-1_0-FINAL` would
526 use just `RELENG-1_0-FINAL` for `<name>`, and gfi will write the
527 corresponding ref as `refs/tags/RELENG-1_0-FINAL`.
529 The value of `<name>` must be a valid refname in Git and therefore
530 may contain forward slashes.  As `LF` is not valid in a Git refname,
531 no quoting or escaping syntax is supported here.
533 The `from` command is the same as in the `commit` command; see
534 above for details.
536 The `tagger` command uses the same format as `committer` within
537 `commit`; again see above for details.
539 The `data` command following `tagger` must supply the annotated tag
540 message (see below for `data` command syntax).  To import an empty
541 tag message use a 0 length data.  Tag messages are free-form and are
542 not interpreted by Git.  Currently they must be encoded in UTF-8,
543 as gfi does not permit other encodings to be specified.
545 Signing annotated tags during import from within gfi is not
546 supported.  Trying to include your own PGP/GPG signature is not
547 recommended, as the frontend does not (easily) have access to the
548 complete set of bytes which normally goes into such a signature.
549 If signing is required, create lightweight tags from within gfi with
550 `reset`, then create the annotated versions of those tags offline
551 with the standard gitlink:git-tag[1] process.
553 `reset`
554 ~~~~~~~
555 Creates (or recreates) the named branch, optionally starting from
556 a specific revision.  The reset command allows a frontend to issue
557 a new `from` command for an existing branch, or to create a new
558 branch from an existing commit without creating a new commit.
560 ....
561         'reset' SP <ref> LF
562         ('from' SP <committish> LF)?
563         LF
564 ....
566 For a detailed description of `<ref>` and `<committish>` see above
567 under `commit` and `from`.
569 The `reset` command can also be used to create lightweight
570 (non-annotated) tags.  For example:
572 ====
573         reset refs/tags/938
574         from :938
575 ====
577 would create the lightweight tag `refs/tags/938` referring to
578 whatever commit mark `:938` references.
580 `blob`
581 ~~~~~~
582 Requests writing one file revision to the packfile.  The revision
583 is not connected to any commit; this connection must be formed in
584 a subsequent `commit` command by referencing the blob through an
585 assigned mark.
587 ....
588         'blob' LF
589         mark?
590         data
591 ....
593 The mark command is optional here as some frontends have chosen
594 to generate the Git SHA-1 for the blob on their own, and feed that
595 directly to `commit`.  This is typically more work than its worth
596 however, as marks are inexpensive to store and easy to use.
598 `data`
599 ~~~~~~
600 Supplies raw data (for use as blob/file content, commit messages, or
601 annotated tag messages) to gfi.  Data can be supplied using an exact
602 byte count or delimited with a terminating line.  Real frontends
603 intended for production-quality conversions should always use the
604 exact byte count format, as it is more robust and performs better.
605 The delimited format is intended primarily for testing gfi.
607 Exact byte count format::
608         The frontend must specify the number of bytes of data.
610 ....
611         'data' SP <count> LF
612         <raw> LF
613 ....
615 where `<count>` is the exact number of bytes appearing within
616 `<raw>`.  The value of `<count>` is expressed as an ASCII decimal
617 integer.  The `LF` on either side of `<raw>` is not
618 included in `<count>` and will not be included in the imported data.
620 Delimited format::
621         A delimiter string is used to mark the end of the data.
622         gfi will compute the length by searching for the delimiter.
623         This format is primarly useful for testing and is not
624         recommended for real data.
626 ....
627         'data' SP '<<' <delim> LF
628         <raw> LF
629         <delim> LF
630 ....
632 where `<delim>` is the chosen delimiter string.  The string `<delim>`
633 must not appear on a line by itself within `<raw>`, as otherwise
634 gfi will think the data ends earlier than it really does.  The `LF`
635 immediately trailing `<raw>` is part of `<raw>`.  This is one of
636 the limitations of the delimited format, it is impossible to supply
637 a data chunk which does not have an LF as its last byte.
639 `checkpoint`
640 ~~~~~~~~~~~~
641 Forces gfi to close the current packfile and start a new one.
642 As this requires a significant amount of CPU time and disk IO
643 (to compute the overall pack SHA-1 checksum and generate the
644 corresponding index file) it can easily take several minutes for
645 a single `checkpoint` command to complete.
647 ....
648         'checkpoint' LF
649         LF
650 ....
652 Packfile Optimization
653 ---------------------
654 When packing a blob gfi always attempts to deltify against the last
655 blob written.  Unless specifically arranged for by the frontend,
656 this will probably not be a prior version of the same file, so the
657 generated delta will not be the smallest possible.  The resulting
658 packfile will be compressed, but will not be optimal.
660 Frontends which have efficient access to all revisions of a
661 single file (for example reading an RCS/CVS ,v file) can choose
662 to supply all revisions of that file as a sequence of consecutive
663 `blob` commands.  This allows gfi to deltify the different file
664 revisions against each other, saving space in the final packfile.
665 Marks can be used to later identify individual file revisions during
666 a sequence of `commit` commands.
668 The packfile(s) created by gfi do not encourage good disk access
669 patterns.  This is caused by gfi writing the data in the order
670 it is received on standard input, while Git typically organizes
671 data within packfiles to make the most recent (current tip) data
672 appear before historical data.  Git also clusters commits together,
673 speeding up revision traversal through better cache locality.
675 For this reason it is strongly recommended that users repack the
676 repository with `git repack -a -d` after gfi completes, allowing
677 Git to reorganize the packfiles for faster data access.  If blob
678 deltas are suboptimal (see above) then also adding the `-f` option
679 to force recomputation of all deltas can significantly reduce the
680 final packfile size (30-50% smaller can be quite typical).
682 Memory Utilization
683 ------------------
684 There are a number of factors which affect how much memory gfi
685 requires to perform an import.  Like critical sections of core
686 Git, gfi uses its own memory allocators to ammortize any overheads
687 associated with malloc.  In practice gfi tends to ammoritize any
688 malloc overheads to 0, due to its use of large block allocations.
690 per object
691 ~~~~~~~~~~
692 gfi maintains an in-memory structure for every object written in
693 this execution.  On a 32 bit system the structure is 32 bytes,
694 on a 64 bit system the structure is 40 bytes (due to the larger
695 pointer sizes).  Objects in the table are not deallocated until
696 gfi terminates.  Importing 2 million objects on a 32 bit system
697 will require approximately 64 MiB of memory.
699 The object table is actually a hashtable keyed on the object name
700 (the unique SHA-1).  This storage configuration allows gfi to reuse
701 an existing or already written object and avoid writing duplicates
702 to the output packfile.  Duplicate blobs are surprisingly common
703 in an import, typically due to branch merges in the source.
705 per mark
706 ~~~~~~~~
707 Marks are stored in a sparse array, using 1 pointer (4 bytes or 8
708 bytes, depending on pointer size) per mark.  Although the array
709 is sparse, frontends are still strongly encouraged to use marks
710 between 1 and n, where n is the total number of marks required for
711 this import.
713 per branch
714 ~~~~~~~~~~
715 Branches are classified as active and inactive.  The memory usage
716 of the two classes is significantly different.
718 Inactive branches are stored in a structure which uses 96 or 120
719 bytes (32 bit or 64 bit systems, respectively), plus the length of
720 the branch name (typically under 200 bytes), per branch.  gfi will
721 easily handle as many as 10,000 inactive branches in under 2 MiB
722 of memory.
724 Active branches have the same overhead as inactive branches, but
725 also contain copies of every tree that has been recently modified on
726 that branch.  If subtree `include` has not been modified since the
727 branch became active, its contents will not be loaded into memory,
728 but if subtree `src` has been modified by a commit since the branch
729 became active, then its contents will be loaded in memory.
731 As active branches store metadata about the files contained on that
732 branch, their in-memory storage size can grow to a considerable size
733 (see below).
735 gfi automatically moves active branches to inactive status based on
736 a simple least-recently-used algorithm.  The LRU chain is updated on
737 each `commit` command.  The maximum number of active branches can be
738 increased or decreased on the command line with `--active-branches=`.
740 per active tree
741 ~~~~~~~~~~~~~~~
742 Trees (aka directories) use just 12 bytes of memory on top of the
743 memory required for their entries (see ``per active file'' below).
744 The cost of a tree is virtually 0, as its overhead ammortizes out
745 over the individual file entries.
747 per active file entry
748 ~~~~~~~~~~~~~~~~~~~~~
749 Files (and pointers to subtrees) within active trees require 52 or 64
750 bytes (32/64 bit platforms) per entry.  To conserve space, file and
751 tree names are pooled in a common string table, allowing the filename
752 ``Makefile'' to use just 16 bytes (after including the string header
753 overhead) no matter how many times it occurs within the project.
755 The active branch LRU, when coupled with the filename string pool
756 and lazy loading of subtrees, allows gfi to efficiently import
757 projects with 2,000+ branches and 45,114+ files in a very limited
758 memory footprint (less than 2.7 MiB per active branch).
761 Author
762 ------
763 Written by Shawn O. Pearce <spearce@spearce.org>.
765 Documentation
766 --------------
767 Documentation by Shawn O. Pearce <spearce@spearce.org>.
769 GIT
770 ---
771 Part of the gitlink:git[7] suite