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