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