blob: 7889f95940544a016c5ddf696f0995177f5b36e6 [file] [log] [blame]
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001git-fast-import(1)
2==================
3
4NAME
5----
Junio C Hamano7a336312007-02-13 22:32:36 -08006git-fast-import - Backend for fast Git data importers
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05007
8
9SYNOPSIS
10--------
Martin von Zweigbergk7791a1d2011-07-01 22:38:26 -040011[verse]
Robert P. J. Dayde613052018-05-24 16:11:39 -040012frontend | 'git fast-import' [<options>]
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050013
14DESCRIPTION
15-----------
16This program is usually not what the end user wants to run directly.
17Most end users want to use one of the existing frontend programs,
18which parses a specific type of foreign source and feeds the contents
Thomas Rast0b444cd2010-01-10 00:33:00 +010019stored there to 'git fast-import'.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050020
Shawn O. Pearce882227f2007-02-08 13:49:06 -050021fast-import reads a mixed command/data stream from standard input and
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050022writes one or more packfiles directly into the current repository.
23When EOF is received on standard input, fast import writes out
24updated branch and tag refs, fully updating the current repository
25with the newly imported data.
26
Shawn O. Pearce882227f2007-02-08 13:49:06 -050027The fast-import backend itself can import into an empty repository (one that
Thomas Rast0b444cd2010-01-10 00:33:00 +010028has already been initialized by 'git init') or incrementally
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050029update an existing populated repository. Whether or not incremental
30imports are supported from a particular foreign source depends on
31the frontend program in use.
32
33
34OPTIONS
35-------
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -050036
Shawn O. Pearce7073e692007-02-06 16:08:06 -050037--force::
38 Force updating modified existing branches, even if doing
39 so would cause commits to be lost (as the new commit does
40 not contain the old commit).
41
John Keeping29b1b212013-01-09 19:45:29 +000042--quiet::
Elijah Newrenf55c9792018-11-15 23:59:47 -080043 Disable the output shown by --stats, making fast-import usually
44 be silent when it is successful. However, if the import stream
45 has directives intended to show user output (e.g. `progress`
46 directives), the corresponding messages will still be shown.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050047
John Keeping29b1b212013-01-09 19:45:29 +000048--stats::
49 Display some basic statistics about the objects fast-import has
50 created, the packfiles they were stored into, and the
51 memory used by fast-import during this run. Showing this output
Jeff King1c262bb2015-05-13 01:01:38 -040052 is currently the default, but can be disabled with --quiet.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -080053
Jeff King68061e32019-08-29 14:37:26 -040054--allow-unsafe-features::
55 Many command-line options can be provided as part of the
56 fast-import stream itself by using the `feature` or `option`
57 commands. However, some of these options are unsafe (e.g.,
58 allowing fast-import to access the filesystem outside of the
59 repository). These options are disabled by default, but can be
60 allowed by providing this option on the command line. This
Jeff Kinga52ed762019-08-29 15:08:42 -040061 currently impacts only the `export-marks`, `import-marks`, and
62 `import-marks-if-exists` feature commands.
Jeff King68061e32019-08-29 14:37:26 -040063+
64 Only enable this option if you trust the program generating the
65 fast-import stream! This option is enabled automatically for
66 remote-helpers that use the `import` capability, as they are
67 already trusted to run their own code.
68
John Keeping29b1b212013-01-09 19:45:29 +000069Options for Frontends
70~~~~~~~~~~~~~~~~~~~~~
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050071
John Keeping29b1b212013-01-09 19:45:29 +000072--cat-blob-fd=<fd>::
Michael Haggerty28c7b1f2015-07-01 17:05:58 +020073 Write responses to `get-mark`, `cat-blob`, and `ls` queries to the
Junio C Hamanoa96e8072013-01-11 18:35:07 -080074 file descriptor <fd> instead of `stdout`. Allows `progress`
75 output intended for the end-user to be separated from other
76 output.
John Keeping29b1b212013-01-09 19:45:29 +000077
78--date-format=<fmt>::
79 Specify the type of dates the frontend will supply to
80 fast-import within `author`, `committer` and `tagger` commands.
81 See ``Date Formats'' below for details about which formats
82 are supported, and their syntax.
83
84--done::
85 Terminate with error if there is no `done` command at the end of
86 the stream. This option might be useful for detecting errors
87 that cause the frontend to terminate before it has started to
88 write a stream.
89
90Locations of Marks Files
91~~~~~~~~~~~~~~~~~~~~~~~~
Shawn O. Pearce6e411d22007-02-05 21:09:25 -050092
93--export-marks=<file>::
94 Dumps the internal marks table to <file> when complete.
95 Marks are written one per line as `:markid SHA-1`.
96 Frontends can use this file to validate imports after they
Shawn O. Pearcee8438422007-03-07 18:07:26 -050097 have been completed, or to save the marks table across
98 incremental runs. As <file> is only opened and truncated
99 at checkpoint (or completion) the same path can also be
Jeff King1c262bb2015-05-13 01:01:38 -0400100 safely given to --import-marks.
Shawn O. Pearcee8438422007-03-07 18:07:26 -0500101
102--import-marks=<file>::
103 Before processing any input, load the marks specified in
104 <file>. The input file must exist, must be readable, and
Jeff King1c262bb2015-05-13 01:01:38 -0400105 must use the same format as produced by --export-marks.
Shawn O. Pearcee8438422007-03-07 18:07:26 -0500106 Multiple options may be supplied to import more than one
107 set of marks. If a mark is defined to different values,
108 the last file wins.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500109
Ramkumar Ramachandradded4f12011-01-15 12:01:46 +0530110--import-marks-if-exists=<file>::
111 Like --import-marks but instead of erroring out, silently
112 skips the file if it does not exist.
113
John Keepingc8a9f3d2013-01-09 19:44:38 +0000114--[no-]relative-marks::
Michael J Gruber9fee24c2011-05-05 11:13:38 +0200115 After specifying --relative-marks the paths specified
Sverre Rabbelierbc3c79a2009-12-04 18:07:00 +0100116 with --import-marks= and --export-marks= are relative
117 to an internal directory in the current repository.
118 In git-fast-import this means that the paths are relative
119 to the .git/info/fast-import directory. However, other
120 importers may use a different location.
John Keepingc8a9f3d2013-01-09 19:44:38 +0000121+
122Relative and non-relative marks may be combined by interweaving
123--(no-)-relative-marks with the --(import|export)-marks= options.
Sverre Rabbelierbc3c79a2009-12-04 18:07:00 +0100124
John Keeping29b1b212013-01-09 19:45:29 +0000125Performance and Compression Tuning
126~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sverre Rabbelierbc3c79a2009-12-04 18:07:00 +0100127
John Keeping29b1b212013-01-09 19:45:29 +0000128--active-branches=<n>::
129 Maximum number of branches to maintain active at once.
130 See ``Memory Utilization'' below for details. Default is 5.
David Barr85c62392010-11-28 13:45:01 -0600131
John Keeping29b1b212013-01-09 19:45:29 +0000132--big-file-threshold=<n>::
133 Maximum size of a blob that fast-import will attempt to
134 create a delta for, expressed in bytes. The default is 512m
135 (512 MiB). Some importers may wish to lower this on systems
136 with constrained memory.
137
138--depth=<n>::
139 Maximum delta depth, for blob and tree deltification.
Mike Hommey4f2220e2017-06-08 14:34:36 +0900140 Default is 50.
Sverre Rabbelierbe568622011-07-16 15:03:32 +0200141
Shawn O. Pearcebdf1c062007-02-11 19:45:56 -0500142--export-pack-edges=<file>::
143 After creating a packfile, print a line of data to
144 <file> listing the filename of the packfile and the last
145 commit on each branch that was written to that packfile.
146 This information may be useful after importing projects
147 whose total object set exceeds the 4 GiB packfile limit,
148 as these commits can be used as edge points during calls
Thomas Rast0b444cd2010-01-10 00:33:00 +0100149 to 'git pack-objects'.
Shawn O. Pearcebdf1c062007-02-11 19:45:56 -0500150
John Keeping29b1b212013-01-09 19:45:29 +0000151--max-pack-size=<n>::
152 Maximum size of each output packfile.
153 The default is unlimited.
Shawn O. Pearcec499d762007-02-07 02:19:31 -0500154
Eric Wongd9545c72016-04-25 21:17:28 +0000155fastimport.unpackLimit::
156 See linkgit:git-config[1]
Shawn O. Pearcec499d762007-02-07 02:19:31 -0500157
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200158PERFORMANCE
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500159-----------
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500160The design of fast-import allows it to import large projects in a minimum
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500161amount of memory usage and processing time. Assuming the frontend
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500162is able to keep up with fast-import and feed it a constant stream of data,
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500163import times for projects holding 10+ years of history and containing
164100,000+ individual commits are generally completed in just 1-2
165hours on quite modest (~$2,000 USD) hardware.
166
167Most bottlenecks appear to be in foreign source data access (the
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500168source just cannot extract revisions fast enough) or disk IO (fast-import
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500169writes as fast as the disk will take the data). Imports will run
170faster if the source data is stored on a different drive than the
171destination Git repository (due to less IO contention).
172
173
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200174DEVELOPMENT COST
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500175----------------
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500176A typical frontend for fast-import tends to weigh in at approximately 200
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500177lines of Perl/Python/Ruby code. Most developers have been able to
178create working importers in just a couple of hours, even though it
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500179is their first exposure to fast-import, and sometimes even to Git. This is
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500180an ideal situation, given that most conversion tools are throw-away
181(use once, and never look back).
182
183
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200184PARALLEL OPERATION
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500185------------------
Thomas Rast0b444cd2010-01-10 00:33:00 +0100186Like 'git push' or 'git fetch', imports handled by fast-import are safe to
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500187run alongside parallel `git repack -a -d` or `git gc` invocations,
Thomas Rast0b444cd2010-01-10 00:33:00 +0100188or any other Git operation (including 'git prune', as loose objects
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500189are never used by fast-import).
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500190
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500191fast-import does not lock the branch or tag refs it is actively importing.
192After the import, during its ref update phase, fast-import tests each
Shawn O. Pearce7073e692007-02-06 16:08:06 -0500193existing branch ref to verify the update will be a fast-forward
194update (the commit stored in the ref is contained in the new
195history of the commit to be written). If the update is not a
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500196fast-forward update, fast-import will skip updating that ref and instead
197prints a warning message. fast-import will always attempt to update all
Shawn O. Pearce7073e692007-02-06 16:08:06 -0500198branch refs, and does not stop on the first failure.
199
Jeff King1c262bb2015-05-13 01:01:38 -0400200Branch updates can be forced with --force, but it's recommended that
201this only be used on an otherwise quiet repository. Using --force
Shawn O. Pearce7073e692007-02-06 16:08:06 -0500202is not necessary for an initial import into an empty repository.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500203
204
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200205TECHNICAL DISCUSSION
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500206--------------------
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500207fast-import tracks a set of branches in memory. Any branch can be created
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500208or modified at any point during the import process by sending a
209`commit` command on the input stream. This design allows a frontend
210program to process an unlimited number of branches simultaneously,
211generating commits in the order they are available from the source
212data. It also simplifies the frontend programs considerably.
213
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500214fast-import does not use or alter the current working directory, or any
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500215file within it. (It does however update the current Git repository,
216as referenced by `GIT_DIR`.) Therefore an import frontend may use
217the working directory for its own purposes, such as extracting file
218revisions from the foreign source. This ignorance of the working
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500219directory also allows fast-import to run very quickly, as it does not
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500220need to perform any costly file update operations when switching
221between branches.
222
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200223INPUT FORMAT
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500224------------
225With the exception of raw file data (which Git does not interpret)
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500226the fast-import input format is text (ASCII) based. This text based
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500227format simplifies development and debugging of frontend programs,
228especially when a higher level language such as Perl, Python or
229Ruby is being used.
230
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500231fast-import is very strict about its input. Where we say SP below we mean
David Barr8dc6a372010-12-02 21:40:20 +1100232*exactly* one space. Likewise LF means one (and only one) linefeed
233and HT one (and only one) horizontal tab.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500234Supplying additional whitespace characters will cause unexpected
235results, such as branch names or file names with leading or trailing
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500236spaces in their name, or early termination of fast-import when it encounters
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500237unexpected input.
238
Shawn O. Pearce401d53f2007-08-01 00:05:15 -0400239Stream Comments
240~~~~~~~~~~~~~~~
241To aid in debugging frontends fast-import ignores any line that
242begins with `#` (ASCII pound/hash) up to and including the line
243ending `LF`. A comment line may contain any sequence of bytes
244that does not contain an LF and therefore may be used to include
245any detailed debugging information that might be specific to the
246frontend and useful when inspecting a fast-import data stream.
247
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500248Date Formats
249~~~~~~~~~~~~
250The following date formats are supported. A frontend should select
251the format it will use for this import by passing the format name
Jeff King1c262bb2015-05-13 01:01:38 -0400252in the --date-format=<fmt> command-line option.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500253
254`raw`::
Shawn O. Pearce9b92c822007-02-07 00:51:58 -0500255 This is the Git native format and is `<time> SP <offutc>`.
Jeff King1c262bb2015-05-13 01:01:38 -0400256 It is also fast-import's default format, if --date-format was
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500257 not specified.
258+
259The time of the event is specified by `<time>` as the number of
260seconds since the UNIX epoch (midnight, Jan 1, 1970, UTC) and is
261written as an ASCII decimal integer.
262+
Shawn O. Pearce9b92c822007-02-07 00:51:58 -0500263The local offset is specified by `<offutc>` as a positive or negative
264offset from UTC. For example EST (which is 5 hours behind UTC)
265would be expressed in `<tz>` by ``-0500'' while UTC is ``+0000''.
266The local offset does not affect `<time>`; it is used only as an
267advisement to help formatting routines display the timestamp.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500268+
Shawn O. Pearce9b92c822007-02-07 00:51:58 -0500269If the local offset is not available in the source material, use
270``+0000'', or the most common local offset. For example many
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500271organizations have a CVS repository which has only ever been accessed
Jason St. John0ffa1542013-11-08 19:48:52 -0500272by users who are located in the same location and time zone. In this
Shawn O. Pearcef842fdb2007-02-08 01:53:48 -0500273case a reasonable offset from UTC could be assumed.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500274+
275Unlike the `rfc2822` format, this format is very strict. Any
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500276variation in formatting will cause fast-import to reject the value.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500277
278`rfc2822`::
279 This is the standard email format as described by RFC 2822.
280+
281An example value is ``Tue Feb 6 11:22:18 2007 -0500''. The Git
Shawn O. Pearcef842fdb2007-02-08 01:53:48 -0500282parser is accurate, but a little on the lenient side. It is the
Thomas Rast0b444cd2010-01-10 00:33:00 +0100283same parser used by 'git am' when applying patches
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500284received from email.
285+
286Some malformed strings may be accepted as valid dates. In some of
287these cases Git will still be able to obtain the correct date from
288the malformed string. There are also some types of malformed
289strings which Git will parse wrong, and yet consider valid.
290Seriously malformed strings will be rejected.
291+
Jason St. John0ffa1542013-11-08 19:48:52 -0500292Unlike the `raw` format above, the time zone/UTC offset information
Shawn O. Pearce9b92c822007-02-07 00:51:58 -0500293contained in an RFC 2822 date string is used to adjust the date
294value to UTC prior to storage. Therefore it is important that
295this information be as accurate as possible.
296+
Shawn O. Pearcef842fdb2007-02-08 01:53:48 -0500297If the source material uses RFC 2822 style dates,
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500298the frontend should let fast-import handle the parsing and conversion
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500299(rather than attempting to do it itself) as the Git parser has
300been well tested in the wild.
301+
302Frontends should prefer the `raw` format if the source material
Shawn O. Pearcef842fdb2007-02-08 01:53:48 -0500303already uses UNIX-epoch format, can be coaxed to give dates in that
Brian Hetro02783072007-08-23 20:44:13 -0400304format, or its format is easily convertible to it, as there is no
Shawn O. Pearcef842fdb2007-02-08 01:53:48 -0500305ambiguity in parsing.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500306
307`now`::
Jason St. John0ffa1542013-11-08 19:48:52 -0500308 Always use the current time and time zone. The literal
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500309 `now` must always be supplied for `<when>`.
310+
Jason St. John0ffa1542013-11-08 19:48:52 -0500311This is a toy format. The current time and time zone of this system
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500312is always copied into the identity string at the time it is being
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500313created by fast-import. There is no way to specify a different time or
Jason St. John0ffa1542013-11-08 19:48:52 -0500314time zone.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500315+
Ralf Wildenhues6a5d0b02010-01-31 14:24:39 +0100316This particular format is supplied as it's short to implement and
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500317may be useful to a process that wants to create a new commit
318right now, without needing to use a working directory or
Thomas Rast0b444cd2010-01-10 00:33:00 +0100319'git update-index'.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500320+
321If separate `author` and `committer` commands are used in a `commit`
322the timestamps may not match, as the system clock will be polled
323twice (once for each command). The only way to ensure that both
324author and committer identity information has the same timestamp
325is to omit `author` (thus copying from `committer`) or to use a
326date format other than `now`.
327
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500328Commands
329~~~~~~~~
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500330fast-import accepts several commands to update the current repository
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500331and control the current import process. More detailed discussion
332(with examples) of each command follows later.
333
334`commit`::
335 Creates a new branch or updates an existing branch by
336 creating a new commit and updating the branch to point at
337 the newly created commit.
338
339`tag`::
340 Creates an annotated tag object from an existing commit or
341 branch. Lightweight tags are not supported by this command,
342 as they are not recommended for recording meaningful points
343 in time.
344
345`reset`::
346 Reset an existing branch (or a new branch) to a specific
347 revision. This command must be used to change a branch to
348 a specific revision without making a commit on it.
349
350`blob`::
351 Convert raw file data into a blob, for future use in a
352 `commit` command. This command is optional and is not
353 needed to perform an import.
354
Elijah Newrenb8f50e52019-10-03 13:27:05 -0700355`alias`::
356 Record that a mark refers to a given object without first
357 creating any new object. Using --import-marks and referring
358 to missing marks will cause fast-import to fail, so aliases
359 can provide a way to set otherwise pruned commits to a valid
360 value (e.g. the nearest non-pruned ancestor).
361
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500362`checkpoint`::
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500363 Forces fast-import to close the current packfile, generate its
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500364 unique SHA-1 checksum and index, and start a new packfile.
365 This command is optional and is not needed to perform
366 an import.
367
Shawn O. Pearceac053c02007-08-01 10:23:08 -0400368`progress`::
369 Causes fast-import to echo the entire line to its own
370 standard output. This command is optional and is not needed
371 to perform an import.
372
Sverre Rabbelierbe568622011-07-16 15:03:32 +0200373`done`::
374 Marks the end of the stream. This command is optional
375 unless the `done` feature was requested using the
Jason St. John06ab60c2014-05-21 14:52:26 -0400376 `--done` command-line option or `feature done` command.
Sverre Rabbelierbe568622011-07-16 15:03:32 +0200377
Michael Haggerty28c7b1f2015-07-01 17:05:58 +0200378`get-mark`::
379 Causes fast-import to print the SHA-1 corresponding to a mark
380 to the file descriptor set with `--cat-blob-fd`, or `stdout` if
381 unspecified.
382
David Barr85c62392010-11-28 13:45:01 -0600383`cat-blob`::
384 Causes fast-import to print a blob in 'cat-file --batch'
385 format to the file descriptor set with `--cat-blob-fd` or
386 `stdout` if unspecified.
387
David Barr8dc6a372010-12-02 21:40:20 +1100388`ls`::
389 Causes fast-import to print a line describing a directory
390 entry in 'ls-tree' format to the file descriptor set with
391 `--cat-blob-fd` or `stdout` if unspecified.
392
Sverre Rabbelierf963bd52009-12-04 18:06:56 +0100393`feature`::
Matthieu Moy87c9a142013-08-23 10:29:20 +0200394 Enable the specified feature. This requires that fast-import
395 supports the specified feature, and aborts if it does not.
Sverre Rabbelierf963bd52009-12-04 18:06:56 +0100396
Sverre Rabbelier9c8398f2009-12-04 18:06:57 +0100397`option`::
398 Specify any of the options listed under OPTIONS that do not
399 change stream semantic to suit the frontend's needs. This
400 command is optional and is not needed to perform an import.
401
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500402`commit`
403~~~~~~~~
404Create or update a branch with a new commit, recording one logical
405change to the project.
406
407....
408 'commit' SP <ref> LF
409 mark?
Elijah Newrena965bb32018-11-15 23:59:56 -0800410 original-oid?
Shawn O. Pearce74fbd112009-12-30 07:03:48 -0800411 ('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
412 'committer' (SP <name>)? SP LT <email> GT SP <when> LF
Elijah Newren3edfcc62019-05-13 21:30:59 -0700413 ('encoding' SP <encoding>)?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500414 data
Richard Hansena8a54062013-09-04 15:04:31 -0400415 ('from' SP <commit-ish> LF)?
Elijah Newrend1387d32019-08-12 10:17:47 -0700416 ('merge' SP <commit-ish> LF)*
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200417 (filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
Shawn O. Pearce1fdb6492007-08-01 02:22:53 -0400418 LF?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500419....
420
421where `<ref>` is the name of the branch to make the commit on.
422Typically branch names are prefixed with `refs/heads/` in
423Git, so importing the CVS branch symbol `RELENG-1_0` would use
424`refs/heads/RELENG-1_0` for the value of `<ref>`. The value of
425`<ref>` must be a valid refname in Git. As `LF` is not valid in
426a Git refname, no quoting or escaping syntax is supported here.
427
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500428A `mark` command may optionally appear, requesting fast-import to save a
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500429reference to the newly created commit for future use by the frontend
430(see below for format). It is very common for frontends to mark
431every commit they create, thereby allowing future branch creation
432from any imported commit.
433
434The `data` command following `committer` must supply the commit
435message (see below for `data` command syntax). To import an empty
436commit message use a 0 length data. Commit messages are free-form
437and are not interpreted by Git. Currently they must be encoded in
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500438UTF-8, as fast-import does not permit other encodings to be specified.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500439
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200440Zero or more `filemodify`, `filedelete`, `filecopy`, `filerename`,
441`filedeleteall` and `notemodify` commands
Shawn O. Pearce825769a2007-02-07 02:03:03 -0500442may be included to update the contents of the branch prior to
443creating the commit. These commands may be supplied in any order.
Brian Hetro02783072007-08-23 20:44:13 -0400444However it is recommended that a `filedeleteall` command precede
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200445all `filemodify`, `filecopy`, `filerename` and `notemodify` commands in
446the same commit, as `filedeleteall` wipes the branch clean (see below).
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500447
Elijah Newren62edbec2019-02-20 14:58:42 -0800448The `LF` after the command is optional (it used to be required). Note
449that for reasons of backward compatibility, if the commit ends with a
Mark Rushakoff24966cd2019-08-09 22:59:14 -0700450`data` command (i.e. it has no `from`, `merge`, `filemodify`,
Elijah Newren62edbec2019-02-20 14:58:42 -0800451`filedelete`, `filecopy`, `filerename`, `filedeleteall` or
452`notemodify` commands) then two `LF` commands may appear at the end of
453the command instead of just one.
Shawn O. Pearce1fdb6492007-08-01 02:22:53 -0400454
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500455`author`
456^^^^^^^^
457An `author` command may optionally appear, if the author information
458might differ from the committer information. If `author` is omitted
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500459then fast-import will automatically use the committer's information for
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500460the author portion of the commit. See below for a description of
461the fields in `author`, as they are identical to `committer`.
462
463`committer`
464^^^^^^^^^^^
465The `committer` command indicates who made this commit, and when
466they made it.
467
468Here `<name>` is the person's display name (for example
469``Com M Itter'') and `<email>` is the person's email address
John Keepingf430ed82012-12-16 14:00:29 +0000470(``\cm@example.com''). `LT` and `GT` are the literal less-than (\x3c)
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500471and greater-than (\x3e) symbols. These are required to delimit
472the email address from the other fields in the line. Note that
Dmitry Ivankov4b4963c2011-08-11 16:21:08 +0600473`<name>` and `<email>` are free-form and may contain any sequence
474of bytes, except `LT`, `GT` and `LF`. `<name>` is typically UTF-8 encoded.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500475
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500476The time of the change is specified by `<when>` using the date format
Jeff King1c262bb2015-05-13 01:01:38 -0400477that was selected by the --date-format=<fmt> command-line option.
Shawn O. Pearce63e0c8b2007-02-06 14:58:30 -0500478See ``Date Formats'' above for the set of supported formats, and
479their syntax.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500480
Elijah Newren3edfcc62019-05-13 21:30:59 -0700481`encoding`
482^^^^^^^^^^
483The optional `encoding` command indicates the encoding of the commit
484message. Most commits are UTF-8 and the encoding is omitted, but this
485allows importing commit messages into git without first reencoding them.
486
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500487`from`
488^^^^^^
Shawn O. Pearceea5e3702007-02-12 04:08:43 -0500489The `from` command is used to specify the commit to initialize
490this branch from. This revision will be the first ancestor of the
Eric S. Raymonde7052882012-11-04 23:31:01 -0500491new commit. The state of the tree built at this commit will begin
492with the state at the `from` commit, and be altered by the content
493modifications in this commit.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500494
Shawn O. Pearceea5e3702007-02-12 04:08:43 -0500495Omitting the `from` command in the first commit of a new branch
496will cause fast-import to create that commit with no ancestor. This
497tends to be desired only for the initial commit of a project.
Eyvind Bernhardsen9b33fa02008-03-21 16:25:18 +0100498If the frontend creates all files from scratch when making a new
499branch, a `merge` command may be used instead of `from` to start
500the commit with an empty tree.
Shawn O. Pearceea5e3702007-02-12 04:08:43 -0500501Omitting the `from` command on existing branches is usually desired,
502as the current commit on that branch is automatically assumed to
503be the first ancestor of the new commit.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500504
505As `LF` is not valid in a Git refname or SHA-1 expression, no
Richard Hansena8a54062013-09-04 15:04:31 -0400506quoting or escaping syntax is supported within `<commit-ish>`.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500507
Richard Hansena8a54062013-09-04 15:04:31 -0400508Here `<commit-ish>` is any of the following:
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500509
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500510* The name of an existing branch already in fast-import's internal branch
Ralf Wildenhues6a5d0b02010-01-31 14:24:39 +0100511 table. If fast-import doesn't know the name, it's treated as a SHA-1
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500512 expression.
513
514* A mark reference, `:<idnum>`, where `<idnum>` is the mark number.
515+
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500516The reason fast-import uses `:` to denote a mark reference is this character
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500517is not legal in a Git branch name. The leading `:` makes it easy
Brian Hetro02783072007-08-23 20:44:13 -0400518to distinguish between the mark 42 (`:42`) and the branch 42 (`42`
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500519or `refs/heads/42`), or an abbreviated SHA-1 which happened to
520consist only of base-10 digits.
521+
522Marks must be declared (via `mark`) before they can be used.
523
524* A complete 40 byte or abbreviated commit SHA-1 in hex.
525
526* Any valid Git SHA-1 expression that resolves to a commit. See
Jonathan Nieder9d83e382010-10-11 11:03:32 -0500527 ``SPECIFYING REVISIONS'' in linkgit:gitrevisions[7] for details.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500528
Felipe Contreras4ee1b222014-04-20 13:59:27 -0500529* The special null SHA-1 (40 zeros) specifies that the branch is to be
530 removed.
531
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500532The special case of restarting an incremental import from the
533current branch value should be written as:
534----
535 from refs/heads/branch^0
536----
Jeff King6cf378f2012-04-26 04:51:57 -0400537The `^0` suffix is necessary as fast-import does not permit a branch to
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500538start from itself, and the branch is created in memory before the
Jeff King6cf378f2012-04-26 04:51:57 -0400539`from` command is even read from the input. Adding `^0` will force
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500540fast-import to resolve the commit through Git's revision parsing library,
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500541rather than its internal branch table, thereby loading in the
542existing value of the branch.
543
544`merge`
545^^^^^^^
Eric S. Raymonde7052882012-11-04 23:31:01 -0500546Includes one additional ancestor commit. The additional ancestry
547link does not change the way the tree state is built at this commit.
548If the `from` command is
Eyvind Bernhardsen9b33fa02008-03-21 16:25:18 +0100549omitted when creating a new branch, the first `merge` commit will be
550the first ancestor of the current commit, and the branch will start
551out with no files. An unlimited number of `merge` commands per
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500552commit are permitted by fast-import, thereby establishing an n-way merge.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500553
Richard Hansena8a54062013-09-04 15:04:31 -0400554Here `<commit-ish>` is any of the commit specification expressions
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500555also accepted by `from` (see above).
556
557`filemodify`
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500558^^^^^^^^^^^^
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500559Included in a `commit` command to add a new file or change the
560content of an existing file. This command has two different means
561of specifying the content of the file.
562
563External data format::
564 The data content for the file was already supplied by a prior
565 `blob` command. The frontend just needs to connect it.
566+
567....
568 'M' SP <mode> SP <dataref> SP <path> LF
569....
570+
Jonathan Nieder334fba62010-06-30 22:18:19 -0500571Here usually `<dataref>` must be either a mark reference (`:<idnum>`)
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500572set by a prior `blob` command, or a full 40-byte SHA-1 of an
Jonathan Nieder334fba62010-06-30 22:18:19 -0500573existing Git blob object. If `<mode>` is `040000`` then
574`<dataref>` must be the full 40-byte SHA-1 of an existing
575Git tree object or a mark reference set with `--import-marks`.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500576
577Inline data format::
578 The data content for the file has not been supplied yet.
579 The frontend wants to supply it as part of this modify
580 command.
581+
582....
583 'M' SP <mode> SP 'inline' SP <path> LF
584 data
585....
586+
587See below for a detailed description of the `data` command.
588
589In both formats `<mode>` is the type of file entry, specified
590in octal. Git only supports the following modes:
591
592* `100644` or `644`: A normal (not-executable) file. The majority
593 of files in most projects use this mode. If in doubt, this is
594 what you want.
595* `100755` or `755`: A normal, but executable, file.
Junio C Hamano9981b6d2007-02-06 12:46:11 -0800596* `120000`: A symlink, the content of the file will be the link target.
Alexander Gavrilov03db4522008-07-19 16:21:24 +0400597* `160000`: A gitlink, SHA-1 of the object refers to a commit in
598 another repository. Git links can only be specified by SHA or through
599 a commit mark. They are used to implement submodules.
Jonathan Nieder334fba62010-06-30 22:18:19 -0500600* `040000`: A subdirectory. Subdirectories can only be specified by
601 SHA or through a tree mark set with `--import-marks`.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500602
603In both formats `<path>` is the complete path of the file to be added
604(if not already existing) or modified (if already existing).
605
Jeff Kingc4431d32007-03-09 15:21:41 -0500606A `<path>` string must use UNIX-style directory separators (forward
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500607slash `/`), may contain any byte other than `LF`, and must not
608start with double quote (`"`).
609
Matthieu Moy7c65b2e2012-11-29 20:11:32 +0100610A path can use C-style string quoting; this is accepted in all cases
611and mandatory if the filename starts with double quote or contains
612`LF`. In C-style quoting, the complete name should be surrounded with
613double quotes, and any `LF`, backslash, or double quote characters
614must be escaped by preceding them with a backslash (e.g.,
615`"path/with\n, \\ and \" in it"`).
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500616
Brian Hetro02783072007-08-23 20:44:13 -0400617The value of `<path>` must be in canonical form. That is it must not:
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500618
619* contain an empty directory component (e.g. `foo//bar` is invalid),
Jeff Kingc4431d32007-03-09 15:21:41 -0500620* end with a directory separator (e.g. `foo/` is invalid),
621* start with a directory separator (e.g. `/foo` is invalid),
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500622* contain the special component `.` or `..` (e.g. `foo/./bar` and
623 `foo/../bar` are invalid).
624
Jonathan Niedere5959102011-01-15 20:22:35 -0600625The root of the tree can be represented by an empty string as `<path>`.
626
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500627It is recommended that `<path>` always be encoded using UTF-8.
628
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500629`filedelete`
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500630^^^^^^^^^^^^
Shawn O. Pearce512e44b2007-07-09 21:27:55 -0400631Included in a `commit` command to remove a file or recursively
632delete an entire directory from the branch. If the file or directory
633removal makes its parent directory empty, the parent directory will
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500634be automatically removed too. This cascades up the tree until the
635first non-empty directory or the root is reached.
636
637....
638 'D' SP <path> LF
639....
640
Shawn O. Pearce512e44b2007-07-09 21:27:55 -0400641here `<path>` is the complete path of the file or subdirectory to
642be removed from the branch.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500643See `filemodify` above for a detailed description of `<path>`.
644
Shawn O. Pearceb6f34812007-07-15 01:40:37 -0400645`filecopy`
Jeff Kinga367b862015-05-13 00:58:29 -0400646^^^^^^^^^^
Shawn O. Pearceb6f34812007-07-15 01:40:37 -0400647Recursively copies an existing file or subdirectory to a different
648location within the branch. The existing file or directory must
649exist. If the destination exists it will be completely replaced
650by the content copied from the source.
651
652....
653 'C' SP <path> SP <path> LF
654....
655
656here the first `<path>` is the source location and the second
657`<path>` is the destination. See `filemodify` above for a detailed
658description of what `<path>` may look like. To use a source path
659that contains SP the path must be quoted.
660
661A `filecopy` command takes effect immediately. Once the source
662location has been copied to the destination any future commands
663applied to the source location will not impact the destination of
664the copy.
665
Shawn O. Pearcef39a9462007-07-09 22:58:23 -0400666`filerename`
667^^^^^^^^^^^^
668Renames an existing file or subdirectory to a different location
669within the branch. The existing file or directory must exist. If
670the destination exists it will be replaced by the source directory.
671
672....
673 'R' SP <path> SP <path> LF
674....
675
676here the first `<path>` is the source location and the second
677`<path>` is the destination. See `filemodify` above for a detailed
678description of what `<path>` may look like. To use a source path
679that contains SP the path must be quoted.
680
681A `filerename` command takes effect immediately. Once the source
682location has been renamed to the destination any future commands
683applied to the source location will create new files there and not
684impact the destination of the rename.
685
Shawn O. Pearceb6f34812007-07-15 01:40:37 -0400686Note that a `filerename` is the same as a `filecopy` followed by a
687`filedelete` of the source location. There is a slight performance
688advantage to using `filerename`, but the advantage is so small
689that it is never worth trying to convert a delete/add pair in
690source material into a rename for fast-import. This `filerename`
691command is provided just to simplify frontends that already have
692rename information and don't want bother with decomposing it into a
693`filecopy` followed by a `filedelete`.
694
Shawn O. Pearce825769a2007-02-07 02:03:03 -0500695`filedeleteall`
696^^^^^^^^^^^^^^^
697Included in a `commit` command to remove all files (and also all
698directories) from the branch. This command resets the internal
699branch structure to have no files in it, allowing the frontend
700to subsequently add all interesting files from scratch.
701
702....
703 'deleteall' LF
704....
705
706This command is extremely useful if the frontend does not know
707(or does not care to know) what files are currently on the branch,
708and therefore cannot generate the proper `filedelete` commands to
709update the content.
710
711Issuing a `filedeleteall` followed by the needed `filemodify`
712commands to set the correct content will produce the same results
713as sending only the needed `filemodify` and `filedelete` commands.
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500714The `filedeleteall` approach may however require fast-import to use slightly
Shawn O. Pearce825769a2007-02-07 02:03:03 -0500715more memory per active branch (less than 1 MiB for even most large
716projects); so frontends that can easily obtain only the affected
717paths for a commit are encouraged to do so.
718
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200719`notemodify`
720^^^^^^^^^^^^
Dmitry Ivankovb4218122011-07-13 23:10:53 +0600721Included in a `commit` `<notes_ref>` command to add a new note
Richard Hansena8a54062013-09-04 15:04:31 -0400722annotating a `<commit-ish>` or change this annotation contents.
723Internally it is similar to filemodify 100644 on `<commit-ish>`
Dmitry Ivankovb4218122011-07-13 23:10:53 +0600724path (maybe split into subdirectories). It's not advised to
725use any other commands to write to the `<notes_ref>` tree except
726`filedeleteall` to delete all existing notes in this tree.
727This command has two different means of specifying the content
728of the note.
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200729
730External data format::
731 The data content for the note was already supplied by a prior
732 `blob` command. The frontend just needs to connect it to the
733 commit that is to be annotated.
734+
735....
Richard Hansena8a54062013-09-04 15:04:31 -0400736 'N' SP <dataref> SP <commit-ish> LF
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200737....
738+
739Here `<dataref>` can be either a mark reference (`:<idnum>`)
740set by a prior `blob` command, or a full 40-byte SHA-1 of an
741existing Git blob object.
742
743Inline data format::
744 The data content for the note has not been supplied yet.
745 The frontend wants to supply it as part of this modify
746 command.
747+
748....
Richard Hansena8a54062013-09-04 15:04:31 -0400749 'N' SP 'inline' SP <commit-ish> LF
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200750 data
751....
752+
753See below for a detailed description of the `data` command.
754
Richard Hansena8a54062013-09-04 15:04:31 -0400755In both formats `<commit-ish>` is any of the commit specification
Johan Herlanda8dd2e72009-10-09 12:22:02 +0200756expressions also accepted by `from` (see above).
757
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500758`mark`
759~~~~~~
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500760Arranges for fast-import to save a reference to the current object, allowing
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500761the frontend to recall this object at a future point in time, without
762knowing its SHA-1. Here the current object is the object creation
763command the `mark` command appears within. This can be `commit`,
764`tag`, and `blob`, but `commit` is the most common usage.
765
766....
767 'mark' SP ':' <idnum> LF
768....
769
770where `<idnum>` is the number assigned by the frontend to this mark.
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500771The value of `<idnum>` is expressed as an ASCII decimal integer.
772The value 0 is reserved and cannot be used as
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500773a mark. Only values greater than or equal to 1 may be used as marks.
774
775New marks are created automatically. Existing marks can be moved
776to another object simply by reusing the same `<idnum>` in another
777`mark` command.
778
Elijah Newrena965bb32018-11-15 23:59:56 -0800779`original-oid`
780~~~~~~~~~~~~~~
781Provides the name of the object in the original source control system.
782fast-import will simply ignore this directive, but filter processes
783which operate on and modify the stream before feeding to fast-import
784may have uses for this information
785
786....
787 'original-oid' SP <object-identifier> LF
788....
789
790where `<object-identifer>` is any string not containing LF.
791
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500792`tag`
793~~~~~
794Creates an annotated tag referring to a specific commit. To create
795lightweight (non-annotated) tags see the `reset` command below.
796
797....
798 'tag' SP <name> LF
Elijah Newrenf73b2ab2019-10-03 13:27:04 -0700799 mark?
Richard Hansena8a54062013-09-04 15:04:31 -0400800 'from' SP <commit-ish> LF
Elijah Newrena965bb32018-11-15 23:59:56 -0800801 original-oid?
Shawn O. Pearce74fbd112009-12-30 07:03:48 -0800802 'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500803 data
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500804....
805
806where `<name>` is the name of the tag to create.
807
808Tag names are automatically prefixed with `refs/tags/` when stored
809in Git, so importing the CVS branch symbol `RELENG-1_0-FINAL` would
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500810use just `RELENG-1_0-FINAL` for `<name>`, and fast-import will write the
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500811corresponding ref as `refs/tags/RELENG-1_0-FINAL`.
812
813The value of `<name>` must be a valid refname in Git and therefore
814may contain forward slashes. As `LF` is not valid in a Git refname,
815no quoting or escaping syntax is supported here.
816
817The `from` command is the same as in the `commit` command; see
818above for details.
819
820The `tagger` command uses the same format as `committer` within
821`commit`; again see above for details.
822
823The `data` command following `tagger` must supply the annotated tag
824message (see below for `data` command syntax). To import an empty
825tag message use a 0 length data. Tag messages are free-form and are
826not interpreted by Git. Currently they must be encoded in UTF-8,
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500827as fast-import does not permit other encodings to be specified.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500828
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500829Signing annotated tags during import from within fast-import is not
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500830supported. Trying to include your own PGP/GPG signature is not
831recommended, as the frontend does not (easily) have access to the
832complete set of bytes which normally goes into such a signature.
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500833If signing is required, create lightweight tags from within fast-import with
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500834`reset`, then create the annotated versions of those tags offline
Thomas Rast0b444cd2010-01-10 00:33:00 +0100835with the standard 'git tag' process.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500836
837`reset`
838~~~~~~~
839Creates (or recreates) the named branch, optionally starting from
840a specific revision. The reset command allows a frontend to issue
841a new `from` command for an existing branch, or to create a new
842branch from an existing commit without creating a new commit.
843
844....
845 'reset' SP <ref> LF
Richard Hansena8a54062013-09-04 15:04:31 -0400846 ('from' SP <commit-ish> LF)?
Shawn O. Pearce1fdb6492007-08-01 02:22:53 -0400847 LF?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500848....
849
Richard Hansena8a54062013-09-04 15:04:31 -0400850For a detailed description of `<ref>` and `<commit-ish>` see above
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500851under `commit` and `from`.
852
Shawn O. Pearce1fdb6492007-08-01 02:22:53 -0400853The `LF` after the command is optional (it used to be required).
854
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500855The `reset` command can also be used to create lightweight
856(non-annotated) tags. For example:
857
858====
859 reset refs/tags/938
860 from :938
861====
862
863would create the lightweight tag `refs/tags/938` referring to
864whatever commit mark `:938` references.
865
866`blob`
867~~~~~~
868Requests writing one file revision to the packfile. The revision
869is not connected to any commit; this connection must be formed in
870a subsequent `commit` command by referencing the blob through an
871assigned mark.
872
873....
874 'blob' LF
875 mark?
Elijah Newrena965bb32018-11-15 23:59:56 -0800876 original-oid?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500877 data
878....
879
880The mark command is optional here as some frontends have chosen
881to generate the Git SHA-1 for the blob on their own, and feed that
Ralf Wildenhues6a5d0b02010-01-31 14:24:39 +0100882directly to `commit`. This is typically more work than it's worth
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500883however, as marks are inexpensive to store and easy to use.
884
885`data`
886~~~~~~
887Supplies raw data (for use as blob/file content, commit messages, or
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500888annotated tag messages) to fast-import. Data can be supplied using an exact
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500889byte count or delimited with a terminating line. Real frontends
890intended for production-quality conversions should always use the
891exact byte count format, as it is more robust and performs better.
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500892The delimited format is intended primarily for testing fast-import.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500893
Shawn O. Pearce401d53f2007-08-01 00:05:15 -0400894Comment lines appearing within the `<raw>` part of `data` commands
895are always taken to be part of the body of the data and are therefore
896never ignored by fast-import. This makes it safe to import any
897file/message content whose lines might start with `#`.
898
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500899Exact byte count format::
900 The frontend must specify the number of bytes of data.
901+
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500902....
903 'data' SP <count> LF
Shawn O. Pearce2c570cd2007-08-01 00:24:25 -0400904 <raw> LF?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500905....
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500906+
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500907where `<count>` is the exact number of bytes appearing within
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500908`<raw>`. The value of `<count>` is expressed as an ASCII decimal
909integer. The `LF` on either side of `<raw>` is not
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500910included in `<count>` and will not be included in the imported data.
Shawn O. Pearce2c570cd2007-08-01 00:24:25 -0400911+
912The `LF` after `<raw>` is optional (it used to be required) but
913recommended. Always including it makes debugging a fast-import
914stream easier as the next command always starts in column 0
915of the next line, even if `<raw>` did not end with an `LF`.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500916
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500917Delimited format::
918 A delimiter string is used to mark the end of the data.
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500919 fast-import will compute the length by searching for the delimiter.
Brian Hetro02783072007-08-23 20:44:13 -0400920 This format is primarily useful for testing and is not
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500921 recommended for real data.
922+
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500923....
924 'data' SP '<<' <delim> LF
925 <raw> LF
926 <delim> LF
Shawn O. Pearce2c570cd2007-08-01 00:24:25 -0400927 LF?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500928....
Shawn O. Pearceef94edb2007-02-06 12:35:02 -0500929+
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500930where `<delim>` is the chosen delimiter string. The string `<delim>`
931must not appear on a line by itself within `<raw>`, as otherwise
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500932fast-import will think the data ends earlier than it really does. The `LF`
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500933immediately trailing `<raw>` is part of `<raw>`. This is one of
934the limitations of the delimited format, it is impossible to supply
935a data chunk which does not have an LF as its last byte.
Shawn O. Pearce2c570cd2007-08-01 00:24:25 -0400936+
937The `LF` after `<delim> LF` is optional (it used to be required).
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500938
Elijah Newrenb8f50e52019-10-03 13:27:05 -0700939`alias`
940~~~~~~~
941Record that a mark refers to a given object without first creating any
942new object.
943
944....
945 'alias' LF
946 mark
947 'to' SP <commit-ish> LF
948 LF?
949....
950
951For a detailed description of `<commit-ish>` see above under `from`.
952
953
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500954`checkpoint`
955~~~~~~~~~~~~
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500956Forces fast-import to close the current packfile, start a new one, and to
Shawn O. Pearce820b9312007-02-07 02:42:44 -0500957save out all current branch refs, tags and marks.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500958
959....
960 'checkpoint' LF
Shawn O. Pearce1fdb6492007-08-01 02:22:53 -0400961 LF?
Shawn O. Pearce6e411d22007-02-05 21:09:25 -0500962....
963
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500964Note that fast-import automatically switches packfiles when the current
Jeff King1c262bb2015-05-13 01:01:38 -0400965packfile reaches --max-pack-size, or 4 GiB, whichever limit is
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500966smaller. During an automatic packfile switch fast-import does not update
Shawn O. Pearce820b9312007-02-07 02:42:44 -0500967the branch refs, tags or marks.
968
969As a `checkpoint` can require a significant amount of CPU time and
970disk IO (to compute the overall pack SHA-1 checksum, generate the
971corresponding index file, and update the refs) it can easily take
972several minutes for a single `checkpoint` command to complete.
973
974Frontends may choose to issue checkpoints during extremely large
975and long running imports, or when they need to allow another Git
976process access to a branch. However given that a 30 GiB Subversion
Shawn O. Pearce882227f2007-02-08 13:49:06 -0500977repository can be loaded into Git through fast-import in about 3 hours,
Shawn O. Pearce820b9312007-02-07 02:42:44 -0500978explicit checkpointing may not be necessary.
979
Shawn O. Pearce1fdb6492007-08-01 02:22:53 -0400980The `LF` after the command is optional (it used to be required).
Shawn O. Pearce820b9312007-02-07 02:42:44 -0500981
Shawn O. Pearceac053c02007-08-01 10:23:08 -0400982`progress`
983~~~~~~~~~~
984Causes fast-import to print the entire `progress` line unmodified to
985its standard output channel (file descriptor 1) when the command is
986processed from the input stream. The command otherwise has no impact
987on the current import, or on any of fast-import's internal state.
988
989....
990 'progress' SP <any> LF
991 LF?
992....
993
994The `<any>` part of the command may contain any sequence of bytes
995that does not contain `LF`. The `LF` after the command is optional.
996Callers may wish to process the output through a tool such as sed to
997remove the leading part of the line, for example:
998
999====
Jonathan Niederb1889c32008-06-30 01:09:04 -05001000 frontend | git fast-import | sed 's/^progress //'
Shawn O. Pearceac053c02007-08-01 10:23:08 -04001001====
1002
1003Placing a `progress` command immediately after a `checkpoint` will
1004inform the reader when the `checkpoint` has been completed and it
1005can safely access the refs that fast-import updated.
1006
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001007`get-mark`
1008~~~~~~~~~~
1009Causes fast-import to print the SHA-1 corresponding to a mark to
1010stdout or to the file descriptor previously arranged with the
1011`--cat-blob-fd` argument. The command otherwise has no impact on the
1012current import; its purpose is to retrieve SHA-1s that later commits
1013might want to refer to in their commit messages.
1014
1015....
1016 'get-mark' SP ':' <idnum> LF
1017....
1018
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001019See ``Responses To Commands'' below for details about how to read
1020this output safely.
1021
David Barr85c62392010-11-28 13:45:01 -06001022`cat-blob`
1023~~~~~~~~~~
1024Causes fast-import to print a blob to a file descriptor previously
1025arranged with the `--cat-blob-fd` argument. The command otherwise
1026has no impact on the current import; its main purpose is to
1027retrieve blobs that may be in fast-import's memory but not
1028accessible from the target repository.
1029
1030....
1031 'cat-blob' SP <dataref> LF
1032....
1033
1034The `<dataref>` can be either a mark reference (`:<idnum>`)
1035set previously or a full 40-byte SHA-1 of a Git blob, preexisting or
1036ready to be written.
1037
Jonathan Nieder898243b2011-01-15 20:16:05 -06001038Output uses the same format as `git cat-file --batch`:
David Barr85c62392010-11-28 13:45:01 -06001039
1040====
1041 <sha1> SP 'blob' SP <size> LF
1042 <contents> LF
1043====
1044
Elijah Newren7ffde292019-02-20 14:58:45 -08001045This command can be used where a `filemodify` directive can appear,
1046allowing it to be used in the middle of a commit. For a `filemodify`
1047using an inline directive, it can also appear right before the `data`
1048directive.
Jonathan Nieder777f80d2010-11-28 13:45:58 -06001049
Jonathan Niederd57e4902012-04-11 16:25:01 -05001050See ``Responses To Commands'' below for details about how to read
1051this output safely.
1052
David Barr8dc6a372010-12-02 21:40:20 +11001053`ls`
1054~~~~
1055Prints information about the object at a path to a file descriptor
1056previously arranged with the `--cat-blob-fd` argument. This allows
1057printing a blob from the active commit (with `cat-blob`) or copying a
1058blob or tree from a previous commit for use in the current one (with
1059`filemodify`).
1060
Elijah Newrena63c54a2019-02-20 14:58:43 -08001061The `ls` command can also be used where a `filemodify` directive can
1062appear, allowing it to be used in the middle of a commit.
David Barr8dc6a372010-12-02 21:40:20 +11001063
1064Reading from the active commit::
1065 This form can only be used in the middle of a `commit`.
1066 The path names a directory entry within fast-import's
1067 active commit. The path must be quoted in this case.
1068+
1069....
1070 'ls' SP <path> LF
1071....
1072
1073Reading from a named tree::
1074 The `<dataref>` can be a mark reference (`:<idnum>`) or the
1075 full 40-byte SHA-1 of a Git tag, commit, or tree object,
1076 preexisting or waiting to be written.
1077 The path is relative to the top level of the tree
1078 named by `<dataref>`.
1079+
1080....
1081 'ls' SP <dataref> SP <path> LF
1082....
1083
1084See `filemodify` above for a detailed description of `<path>`.
1085
Jeff King6cf378f2012-04-26 04:51:57 -04001086Output uses the same format as `git ls-tree <tree> -- <path>`:
David Barr8dc6a372010-12-02 21:40:20 +11001087
1088====
1089 <mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF
1090====
1091
1092The <dataref> represents the blob, tree, or commit object at <path>
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001093and can be used in later 'get-mark', 'cat-blob', 'filemodify', or
1094'ls' commands.
David Barr8dc6a372010-12-02 21:40:20 +11001095
1096If there is no file or subtree at that path, 'git fast-import' will
1097instead report
1098
1099====
1100 missing SP <path> LF
1101====
1102
Jonathan Niederd57e4902012-04-11 16:25:01 -05001103See ``Responses To Commands'' below for details about how to read
1104this output safely.
1105
Sverre Rabbelierf963bd52009-12-04 18:06:56 +01001106`feature`
1107~~~~~~~~~
1108Require that fast-import supports the specified feature, or abort if
1109it does not.
1110
1111....
Jonathan Nieder4980fff2010-11-28 13:43:57 -06001112 'feature' SP <feature> ('=' <argument>)? LF
Sverre Rabbelierf963bd52009-12-04 18:06:56 +01001113....
1114
Jonathan Nieder4980fff2010-11-28 13:43:57 -06001115The <feature> part of the command may be any one of the following:
Sverre Rabbelierf963bd52009-12-04 18:06:56 +01001116
Jonathan Nieder4980fff2010-11-28 13:43:57 -06001117date-format::
1118export-marks::
1119relative-marks::
1120no-relative-marks::
1121force::
1122 Act as though the corresponding command-line option with
Matthieu Moy04b125d2016-06-28 13:40:12 +02001123 a leading `--` was passed on the command line
Jonathan Nieder4980fff2010-11-28 13:43:57 -06001124 (see OPTIONS, above).
Sverre Rabbelierf963bd52009-12-04 18:06:56 +01001125
Jonathan Nieder4980fff2010-11-28 13:43:57 -06001126import-marks::
Dmitry Ivankov3beb4fc2011-08-17 16:42:58 +06001127import-marks-if-exists::
Jonathan Nieder4980fff2010-11-28 13:43:57 -06001128 Like --import-marks except in two respects: first, only one
Dmitry Ivankov3beb4fc2011-08-17 16:42:58 +06001129 "feature import-marks" or "feature import-marks-if-exists"
1130 command is allowed per stream; second, an --import-marks=
1131 or --import-marks-if-exists command-line option overrides
1132 any of these "feature" commands in the stream; third,
1133 "feature import-marks-if-exists" like a corresponding
1134 command-line option silently skips a nonexistent file.
Sverre Rabbelierf963bd52009-12-04 18:06:56 +01001135
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001136get-mark::
David Barr85c62392010-11-28 13:45:01 -06001137cat-blob::
David Barr8dc6a372010-12-02 21:40:20 +11001138ls::
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001139 Require that the backend support the 'get-mark', 'cat-blob',
1140 or 'ls' command respectively.
David Barr8dc6a372010-12-02 21:40:20 +11001141 Versions of fast-import not supporting the specified command
1142 will exit with a message indicating so.
David Barr85c62392010-11-28 13:45:01 -06001143 This lets the import error out early with a clear message,
1144 rather than wasting time on the early part of an import
1145 before the unsupported command is detected.
Sverre Rabbelier081751c2009-12-04 18:06:59 +01001146
Jonathan Nieder547e8b92011-02-09 16:43:57 -06001147notes::
1148 Require that the backend support the 'notemodify' (N)
1149 subcommand to the 'commit' command.
1150 Versions of fast-import not supporting notes will exit
1151 with a message indicating so.
1152
Sverre Rabbelierbe568622011-07-16 15:03:32 +02001153done::
1154 Error out if the stream ends without a 'done' command.
1155 Without this feature, errors causing the frontend to end
1156 abruptly at a convenient point in the stream can go
Eric S. Raymond3266de12012-08-22 06:57:05 -04001157 undetected. This may occur, for example, if an import
1158 front end dies in mid-operation without emitting SIGTERM
1159 or SIGKILL at its subordinate git fast-import instance.
Junio C Hamanoa8e4a592011-02-09 16:40:12 -08001160
Sverre Rabbelier9c8398f2009-12-04 18:06:57 +01001161`option`
1162~~~~~~~~
1163Processes the specified option so that git fast-import behaves in a
1164way that suits the frontend's needs.
1165Note that options specified by the frontend are overridden by any
1166options the user may specify to git fast-import itself.
1167
1168....
1169 'option' SP <option> LF
1170....
1171
1172The `<option>` part of the command may contain any of the options
1173listed in the OPTIONS section that do not change import semantics,
Matthieu Moy04b125d2016-06-28 13:40:12 +02001174without the leading `--` and is treated in the same way.
Sverre Rabbelier9c8398f2009-12-04 18:06:57 +01001175
1176Option commands must be the first commands on the input (not counting
1177feature commands), to give an option command after any non-option
1178command is an error.
1179
Jason St. John06ab60c2014-05-21 14:52:26 -04001180The following command-line options change import semantics and may therefore
Sverre Rabbelier9c8398f2009-12-04 18:06:57 +01001181not be passed as option:
1182
1183* date-format
1184* import-marks
1185* export-marks
David Barr85c62392010-11-28 13:45:01 -06001186* cat-blob-fd
Sverre Rabbelier9c8398f2009-12-04 18:06:57 +01001187* force
1188
Sverre Rabbelierbe568622011-07-16 15:03:32 +02001189`done`
1190~~~~~~
1191If the `done` feature is not in use, treated as if EOF was read.
1192This can be used to tell fast-import to finish early.
1193
Jason St. John06ab60c2014-05-21 14:52:26 -04001194If the `--done` command-line option or `feature done` command is
Sverre Rabbelierbe568622011-07-16 15:03:32 +02001195in use, the `done` command is mandatory and marks the end of the
1196stream.
1197
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +02001198RESPONSES TO COMMANDS
Jonathan Niederd57e4902012-04-11 16:25:01 -05001199---------------------
1200New objects written by fast-import are not available immediately.
1201Most fast-import commands have no visible effect until the next
1202checkpoint (or completion). The frontend can send commands to
1203fill fast-import's input pipe without worrying about how quickly
1204they will take effect, which improves performance by simplifying
1205scheduling.
1206
1207For some frontends, though, it is useful to be able to read back
1208data from the current repository as it is being updated (for
1209example when the source material describes objects in terms of
1210patches to be applied to previously imported objects). This can
1211be accomplished by connecting the frontend and fast-import via
1212bidirectional pipes:
1213
1214====
1215 mkfifo fast-import-output
1216 frontend <fast-import-output |
1217 git fast-import >fast-import-output
1218====
1219
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001220A frontend set up this way can use `progress`, `get-mark`, `ls`, and
1221`cat-blob` commands to read information from the import in progress.
Jonathan Niederd57e4902012-04-11 16:25:01 -05001222
1223To avoid deadlock, such frontends must completely consume any
Michael Haggerty28c7b1f2015-07-01 17:05:58 +02001224pending output from `progress`, `ls`, `get-mark`, and `cat-blob` before
Jonathan Niederd57e4902012-04-11 16:25:01 -05001225performing writes to fast-import that might block.
1226
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +02001227CRASH REPORTS
Shawn O. Pearcee7e51702008-02-14 01:34:46 -05001228-------------
1229If fast-import is supplied invalid input it will terminate with a
1230non-zero exit status and create a crash report in the top level of
1231the Git repository it was importing into. Crash reports contain
1232a snapshot of the internal fast-import state as well as the most
1233recent commands that lead up to the crash.
1234
1235All recent commands (including stream comments, file changes and
1236progress commands) are shown in the command history within the crash
1237report, but raw file data and commit messages are excluded from the
1238crash report. This exclusion saves space within the report file
1239and reduces the amount of buffering that fast-import must perform
1240during execution.
1241
1242After writing a crash report fast-import will close the current
1243packfile and export the marks table. This allows the frontend
1244developer to inspect the repository state and resume the import from
1245the point where it crashed. The modified branches and tags are not
1246updated during a crash, as the import did not complete successfully.
1247Branch and tag information can be found in the crash report and
1248must be applied manually if the update is needed.
1249
1250An example crash:
1251
1252====
1253 $ cat >in <<END_OF_INPUT
1254 # my very first test commit
1255 commit refs/heads/master
1256 committer Shawn O. Pearce <spearce> 19283 -0400
1257 # who is that guy anyway?
1258 data <<EOF
1259 this is my commit
1260 EOF
1261 M 644 inline .gitignore
1262 data <<EOF
1263 .gitignore
1264 EOF
1265 M 777 inline bob
1266 END_OF_INPUT
1267
Jonathan Niederb1889c32008-06-30 01:09:04 -05001268 $ git fast-import <in
Shawn O. Pearcee7e51702008-02-14 01:34:46 -05001269 fatal: Corrupt mode: M 777 inline bob
1270 fast-import: dumping crash report to .git/fast_import_crash_8434
1271
1272 $ cat .git/fast_import_crash_8434
1273 fast-import crash report:
1274 fast-import process: 8434
1275 parent process : 1391
1276 at Sat Sep 1 00:58:12 2007
1277
1278 fatal: Corrupt mode: M 777 inline bob
1279
1280 Most Recent Commands Before Crash
1281 ---------------------------------
1282 # my very first test commit
1283 commit refs/heads/master
1284 committer Shawn O. Pearce <spearce> 19283 -0400
1285 # who is that guy anyway?
1286 data <<EOF
1287 M 644 inline .gitignore
1288 data <<EOF
1289 * M 777 inline bob
1290
1291 Active Branch LRU
1292 -----------------
1293 active_branches = 1 cur, 5 max
1294
1295 pos clock name
1296 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1297 1) 0 refs/heads/master
1298
1299 Inactive Branches
1300 -----------------
1301 refs/heads/master:
1302 status : active loaded dirty
1303 tip commit : 0000000000000000000000000000000000000000
1304 old tree : 0000000000000000000000000000000000000000
1305 cur tree : 0000000000000000000000000000000000000000
1306 commit clock: 0
1307 last pack :
1308
1309
1310 -------------------
1311 END OF CRASH REPORT
1312====
1313
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +02001314TIPS AND TRICKS
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001315---------------
1316The following tips and tricks have been collected from various
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001317users of fast-import, and are offered here as suggestions.
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001318
1319Use One Mark Per Commit
1320~~~~~~~~~~~~~~~~~~~~~~~
1321When doing a repository conversion, use a unique mark per commit
Jeff King1c262bb2015-05-13 01:01:38 -04001322(`mark :<n>`) and supply the --export-marks option on the command
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001323line. fast-import will dump a file which lists every mark and the Git
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001324object SHA-1 that corresponds to it. If the frontend can tie
1325the marks back to the source repository, it is easy to verify the
1326accuracy and completeness of the import by comparing each Git
1327commit to the corresponding source revision.
1328
1329Coming from a system such as Perforce or Subversion this should be
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001330quite simple, as the fast-import mark can also be the Perforce changeset
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001331number or the Subversion revision number.
1332
1333Freely Skip Around Branches
1334~~~~~~~~~~~~~~~~~~~~~~~~~~~
1335Don't bother trying to optimize the frontend to stick to one branch
1336at a time during an import. Although doing so might be slightly
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001337faster for fast-import, it tends to increase the complexity of the frontend
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001338code considerably.
1339
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001340The branch LRU builtin to fast-import tends to behave very well, and the
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001341cost of activating an inactive branch is so low that bouncing around
1342between branches has virtually no impact on import performance.
1343
Shawn O. Pearcec7346152007-02-11 19:50:50 -05001344Handling Renames
1345~~~~~~~~~~~~~~~~
1346When importing a renamed file or directory, simply delete the old
1347name(s) and modify the new name(s) during the corresponding commit.
1348Git performs rename detection after-the-fact, rather than explicitly
1349during a commit.
1350
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001351Use Tag Fixup Branches
1352~~~~~~~~~~~~~~~~~~~~~~
1353Some other SCM systems let the user create a tag from multiple
1354files which are not from the same commit/changeset. Or to create
1355tags which are a subset of the files available in the repository.
1356
1357Importing these tags as-is in Git is impossible without making at
1358least one commit which ``fixes up'' the files to match the content
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001359of the tag. Use fast-import's `reset` command to reset a dummy branch
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001360outside of your normal branch space to the base commit for the tag,
1361then commit one or more file fixup commits, and finally tag the
1362dummy branch.
1363
1364For example since all normal branches are stored under `refs/heads/`
1365name the tag fixup branch `TAG_FIXUP`. This way it is impossible for
1366the fixup branch used by the importer to have namespace conflicts
1367with real branches imported from the source (the name `TAG_FIXUP`
1368is not `refs/heads/TAG_FIXUP`).
1369
1370When committing fixups, consider using `merge` to connect the
1371commit(s) which are supplying file revisions to the fixup branch.
Thomas Rast0b444cd2010-01-10 00:33:00 +01001372Doing so will allow tools such as 'git blame' to track
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001373through the real commit history and properly annotate the source
1374files.
1375
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001376After fast-import terminates the frontend will need to do `rm .git/TAG_FIXUP`
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001377to remove the dummy branch.
1378
1379Import Now, Repack Later
1380~~~~~~~~~~~~~~~~~~~~~~~~
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001381As soon as fast-import completes the Git repository is completely valid
Brian Hetro02783072007-08-23 20:44:13 -04001382and ready for use. Typically this takes only a very short time,
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001383even for considerably large projects (100,000+ commits).
1384
1385However repacking the repository is necessary to improve data
1386locality and access performance. It can also take hours on extremely
Jeff King1c262bb2015-05-13 01:01:38 -04001387large projects (especially if -f and a large --window parameter is
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001388used). Since repacking is safe to run alongside readers and writers,
1389run the repack in the background and let it finish when it finishes.
1390There is no reason to wait to explore your new Git project!
1391
1392If you choose to wait for the repack, don't try to run benchmarks
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001393or performance tests until repacking is completed. fast-import outputs
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001394suboptimal packfiles that are simply never seen in real use
1395situations.
1396
1397Repacking Historical Data
1398~~~~~~~~~~~~~~~~~~~~~~~~~
1399If you are repacking very old imported data (e.g. older than the
1400last year), consider expending some extra CPU time and supplying
Jeff King1c262bb2015-05-13 01:01:38 -04001401--window=50 (or higher) when you run 'git repack'.
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001402This will take longer, but will also produce a smaller packfile.
1403You only need to expend the effort once, and everyone using your
1404project will benefit from the smaller repository.
1405
Shawn O. Pearceac053c02007-08-01 10:23:08 -04001406Include Some Progress Messages
1407~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1408Every once in a while have your frontend emit a `progress` message
1409to fast-import. The contents of the messages are entirely free-form,
1410so one suggestion would be to output the current month and year
1411each time the current commit date moves into the next month.
1412Your users will feel better knowing how much of the data stream
1413has been processed.
1414
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001415
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +02001416PACKFILE OPTIMIZATION
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001417---------------------
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001418When packing a blob fast-import always attempts to deltify against the last
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001419blob written. Unless specifically arranged for by the frontend,
1420this will probably not be a prior version of the same file, so the
1421generated delta will not be the smallest possible. The resulting
1422packfile will be compressed, but will not be optimal.
1423
1424Frontends which have efficient access to all revisions of a
1425single file (for example reading an RCS/CVS ,v file) can choose
1426to supply all revisions of that file as a sequence of consecutive
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001427`blob` commands. This allows fast-import to deltify the different file
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001428revisions against each other, saving space in the final packfile.
1429Marks can be used to later identify individual file revisions during
1430a sequence of `commit` commands.
1431
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001432The packfile(s) created by fast-import do not encourage good disk access
1433patterns. This is caused by fast-import writing the data in the order
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001434it is received on standard input, while Git typically organizes
1435data within packfiles to make the most recent (current tip) data
1436appear before historical data. Git also clusters commits together,
1437speeding up revision traversal through better cache locality.
1438
1439For this reason it is strongly recommended that users repack the
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001440repository with `git repack -a -d` after fast-import completes, allowing
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001441Git to reorganize the packfiles for faster data access. If blob
1442deltas are suboptimal (see above) then also adding the `-f` option
1443to force recomputation of all deltas can significantly reduce the
1444final packfile size (30-50% smaller can be quite typical).
1445
Ævar Arnfjörð Bjarmason73845042019-04-07 21:52:15 +02001446Instead of running `git repack` you can also run `git gc
1447--aggressive`, which will also optimize other things after an import
1448(e.g. pack loose refs). As noted in the "AGGRESSIVE" section in
1449linkgit:git-gc[1] the `--aggressive` option will find new deltas with
1450the `-f` option to linkgit:git-repack[1]. For the reasons elaborated
1451on above using `--aggressive` after a fast-import is one of the few
1452cases where it's known to be worthwhile.
Shawn O. Pearcebdd9f422007-02-07 03:49:08 -05001453
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +02001454MEMORY UTILIZATION
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001455------------------
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001456There are a number of factors which affect how much memory fast-import
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001457requires to perform an import. Like critical sections of core
Brian Hetro02783072007-08-23 20:44:13 -04001458Git, fast-import uses its own memory allocators to amortize any overheads
1459associated with malloc. In practice fast-import tends to amortize any
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001460malloc overheads to 0, due to its use of large block allocations.
1461
1462per object
1463~~~~~~~~~~
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001464fast-import maintains an in-memory structure for every object written in
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001465this execution. On a 32 bit system the structure is 32 bytes,
1466on a 64 bit system the structure is 40 bytes (due to the larger
1467pointer sizes). Objects in the table are not deallocated until
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001468fast-import terminates. Importing 2 million objects on a 32 bit system
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001469will require approximately 64 MiB of memory.
1470
1471The object table is actually a hashtable keyed on the object name
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001472(the unique SHA-1). This storage configuration allows fast-import to reuse
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001473an existing or already written object and avoid writing duplicates
1474to the output packfile. Duplicate blobs are surprisingly common
1475in an import, typically due to branch merges in the source.
1476
1477per mark
1478~~~~~~~~
1479Marks are stored in a sparse array, using 1 pointer (4 bytes or 8
1480bytes, depending on pointer size) per mark. Although the array
1481is sparse, frontends are still strongly encouraged to use marks
1482between 1 and n, where n is the total number of marks required for
1483this import.
1484
1485per branch
1486~~~~~~~~~~
1487Branches are classified as active and inactive. The memory usage
1488of the two classes is significantly different.
1489
1490Inactive branches are stored in a structure which uses 96 or 120
1491bytes (32 bit or 64 bit systems, respectively), plus the length of
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001492the branch name (typically under 200 bytes), per branch. fast-import will
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001493easily handle as many as 10,000 inactive branches in under 2 MiB
1494of memory.
1495
1496Active branches have the same overhead as inactive branches, but
1497also contain copies of every tree that has been recently modified on
1498that branch. If subtree `include` has not been modified since the
1499branch became active, its contents will not be loaded into memory,
1500but if subtree `src` has been modified by a commit since the branch
1501became active, then its contents will be loaded in memory.
1502
1503As active branches store metadata about the files contained on that
1504branch, their in-memory storage size can grow to a considerable size
1505(see below).
1506
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001507fast-import automatically moves active branches to inactive status based on
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001508a simple least-recently-used algorithm. The LRU chain is updated on
1509each `commit` command. The maximum number of active branches can be
Jeff King1c262bb2015-05-13 01:01:38 -04001510increased or decreased on the command line with --active-branches=.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001511
1512per active tree
1513~~~~~~~~~~~~~~~
1514Trees (aka directories) use just 12 bytes of memory on top of the
1515memory required for their entries (see ``per active file'' below).
Brian Hetro02783072007-08-23 20:44:13 -04001516The cost of a tree is virtually 0, as its overhead amortizes out
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001517over the individual file entries.
1518
1519per active file entry
1520~~~~~~~~~~~~~~~~~~~~~
1521Files (and pointers to subtrees) within active trees require 52 or 64
1522bytes (32/64 bit platforms) per entry. To conserve space, file and
1523tree names are pooled in a common string table, allowing the filename
1524``Makefile'' to use just 16 bytes (after including the string header
1525overhead) no matter how many times it occurs within the project.
1526
1527The active branch LRU, when coupled with the filename string pool
Shawn O. Pearce882227f2007-02-08 13:49:06 -05001528and lazy loading of subtrees, allows fast-import to efficiently import
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001529projects with 2,000+ branches and 45,114+ files in a very limited
1530memory footprint (less than 2.7 MiB per active branch).
1531
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +02001532SIGNALS
Jonathan Niederdc01f592010-11-22 02:16:02 -06001533-------
1534Sending *SIGUSR1* to the 'git fast-import' process ends the current
1535packfile early, simulating a `checkpoint` command. The impatient
1536operator can use this facility to peek at the objects and refs from an
1537import in progress, at the cost of some added running time and worse
1538compression.
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001539
Max Horn26726712014-11-11 21:17:07 +01001540SEE ALSO
1541--------
1542linkgit:git-fast-export[1]
1543
Shawn O. Pearce6e411d22007-02-05 21:09:25 -05001544GIT
1545---
Christian Couder9e1f0a82008-06-06 09:07:32 +02001546Part of the linkgit:git[1] suite