diff options
| author | Junio C Hamano <gitster@pobox.com> | 2014-10-31 13:25:53 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-10-31 13:25:53 -0700 |
| commit | c14e6ad9a230ad90c84b7f620d87fbe49a2d0342 (patch) | |
| tree | 120346dc383e3d1c4219fe8c533eb22cb6af2b55 /git-fast-import.html | |
| parent | 2a4bcbc355496c8d83b1b9f8892c4cbe8f584158 (diff) | |
| download | git-htmldocs-c14e6ad9a230ad90c84b7f620d87fbe49a2d0342.tar.gz | |
Autogenerated HTML docs for v2.2.0-rc0
Diffstat (limited to 'git-fast-import.html')
| -rw-r--r-- | git-fast-import.html | 674 |
1 files changed, 336 insertions, 338 deletions
diff --git a/git-fast-import.html b/git-fast-import.html index c7f4cb31f..93cb76737 100644 --- a/git-fast-import.html +++ b/git-fast-import.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.6" />
+<meta name="generator" content="AsciiDoc 8.6.9" />
<title>git-fast-import(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -87,10 +87,16 @@ ul, ol, li > p { ul > li { color: #aaa; }
ul > li > * { color: black; }
-pre {
+.monospaced, code, pre {
+ font-family: "Courier New", Courier, monospace;
+ font-size: inherit;
+ color: navy;
padding: 0;
margin: 0;
}
+pre {
+ white-space: pre-wrap;
+}
#author {
color: #527bbd;
@@ -219,7 +225,7 @@ div.exampleblock > div.content { }
div.imageblock div.content { padding-left: 0; }
-span.image img { border-style: none; }
+span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
@@ -349,7 +355,7 @@ div.colist td img { margin-bottom: 0.1em;
}
-div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -407,18 +413,14 @@ span.underline { text-decoration: underline; } span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
+div.unbreakable { page-break-inside: avoid; }
+
/*
* xhtml11 specific
*
* */
-tt {
- font-family: monospace;
- font-size: inherit;
- color: navy;
-}
-
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -452,12 +454,6 @@ div.tableblock > table[frame="vsides"] { *
* */
-.monospaced {
- font-family: monospace;
- font-size: inherit;
- color: navy;
-}
-
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
@@ -537,6 +533,8 @@ body.manpage div.sectionbody { @media print {
body.manpage div#toc { display: none; }
}
+
+
</style>
<script type="text/javascript">
/*<+'])');
+ var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
@@ -610,7 +608,7 @@ toc: function (toclevels) { var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
- if (entry.nodeName == 'div'
+ if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
@@ -656,7 +654,7 @@ footnotes: function () { var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
- if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
@@ -818,8 +816,8 @@ the frontend program in use.</p></div> </dt>
<dd>
<p>
- Write responses to <tt>cat-blob</tt> and <tt>ls</tt> queries to the
- file descriptor <fd> instead of <tt>stdout</tt>. Allows <tt>progress</tt>
+ Write responses to <code>cat-blob</code> and <code>ls</code> queries to the
+ file descriptor <fd> instead of <code>stdout</code>. Allows <code>progress</code>
output intended for the end-user to be separated from other
output.
</p>
@@ -830,7 +828,7 @@ the frontend program in use.</p></div> <dd>
<p>
Specify the type of dates the frontend will supply to
- fast-import within <tt>author</tt>, <tt>committer</tt> and <tt>tagger</tt> commands.
+ fast-import within <code>author</code>, <code>committer</code> and <code>tagger</code> commands.
See “Date Formats” below for details about which formats
are supported, and their syntax.
</p>
@@ -840,7 +838,7 @@ the frontend program in use.</p></div> </dt>
<dd>
<p>
- Terminate with error if there is no <tt>done</tt> command at the end of
+ Terminate with error if there is no <code>done</code> command at the end of
the stream. This option might be useful for detecting errors
that cause the frontend to terminate before it has started to
write a stream.
@@ -857,7 +855,7 @@ the frontend program in use.</p></div> <dd>
<p>
Dumps the internal marks table to <file> when complete.
- Marks are written one per line as <tt>:markid SHA-1</tt>.
+ Marks are written one per line as <code>:markid SHA-1</code>.
Frontends can use this file to validate imports after they
have been completed, or to save the marks table across
incremental runs. As <file> is only opened and truncated
@@ -994,7 +992,7 @@ an ideal situation, given that most conversion tools are throw-away <h2 id="_parallel_operation">Parallel Operation</h2>
<div class="sectionbody">
<div class="paragraph"><p>Like <em>git push</em> or <em>git fetch</em>, imports handled by fast-import are safe to
-run alongside parallel <tt>git repack -a -d</tt> or <tt>git gc</tt> invocations,
+run alongside parallel <code>git repack -a -d</code> or <code>git gc</code> invocations,
or any other Git operation (including <em>git prune</em>, as loose objects
are never used by fast-import).</p></div>
<div class="paragraph"><p>fast-import does not lock the branch or tag refs it is actively importing.
@@ -1015,13 +1013,13 @@ is not necessary for an initial import into an empty repository.</p></div> <div class="sectionbody">
<div class="paragraph"><p>fast-import tracks a set of branches in memory. Any branch can be created
or modified at any point during the import process by sending a
-<tt>commit</tt> command on the input stream. This design allows a frontend
+<code>commit</code> command on the input stream. This design allows a frontend
program to process an unlimited number of branches simultaneously,
generating commits in the order they are available from the source
data. It also simplifies the frontend programs considerably.</p></div>
<div class="paragraph"><p>fast-import does not use or alter the current working directory, or any
file within it. (It does however update the current Git repository,
-as referenced by <tt>GIT_DIR</tt>.) Therefore an import frontend may use
+as referenced by <code>GIT_DIR</code>.) Therefore an import frontend may use
the working directory for its own purposes, such as extracting file
revisions from the foreign source. This ignorance of the working
directory also allows fast-import to run very quickly, as it does not
@@ -1047,8 +1045,8 @@ unexpected input.</p></div> <div class="sect2">
<h3 id="_stream_comments">Stream Comments</h3>
<div class="paragraph"><p>To aid in debugging frontends fast-import ignores any line that
-begins with <tt>#</tt> (ASCII pound/hash) up to and including the line
-ending <tt>LF</tt>. A comment line may contain any sequence of bytes
+begins with <code>#</code> (ASCII pound/hash) up to and including the line
+ending <code>LF</code>. A comment line may contain any sequence of bytes
that does not contain an LF and therefore may be used to include
any detailed debugging information that might be specific to the
frontend and useful when inspecting a fast-import data stream.</p></div>
@@ -1060,32 +1058,32 @@ the format it will use for this import by passing the format name in the --date-format=<fmt> command-line option.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
-<tt>raw</tt>
+<code>raw</code>
</dt>
<dd>
<p>
- This is the Git native format and is <tt><time> SP <offutc></tt>.
+ This is the Git native format and is <code><time> SP <offutc></code>.
It is also fast-import’s default format, if --date-format was
not specified.
</p>
-<div class="paragraph"><p>The time of the event is specified by <tt><time></tt> as the number of
+<div class="paragraph"><p>The time of the event is specified by <code><time></code> as the number of
seconds since the UNIX epoch (midnight, Jan 1, 1970, UTC) and is
written as an ASCII decimal integer.</p></div>
-<div class="paragraph"><p>The local offset is specified by <tt><offutc></tt> as a positive or negative
+<div class="paragraph"><p>The local offset is specified by <code><offutc></code> as a positive or negative
offset from UTC. For example EST (which is 5 hours behind UTC)
-would be expressed in <tt><tz></tt> by “-0500” while UTC is “+0000”.
-The local offset does not affect <tt><time></tt>; it is used only as an
+would be expressed in <code><tz></code> by “-0500” while UTC is “+0000”.
+The local offset does not affect <code><time></code>; it is used only as an
advisement to help formatting routines display the timestamp.</p></div>
<div class="paragraph"><p>If the local offset is not available in the source material, use
“+0000”, or the most common local offset. For example many
organizations have a CVS repository which has only ever been accessed
by users who are located in the same location and time zone. In this
case a reasonable offset from UTC could be assumed.</p></div>
-<div class="paragraph"><p>Unlike the <tt>rfc2822</tt> format, this format is very strict. Any
+<div class="paragraph"><p>Unlike the <code>rfc2822</code> format, this format is very strict. Any
variation in formatting will cause fast-import to reject the value.</p></div>
</dd>
<dt class="hdlist1">
-<tt>rfc2822</tt>
+<code>rfc2822</code>
</dt>
<dd>
<p>
@@ -1100,7 +1098,7 @@ these cases Git will still be able to obtain the correct date from the malformed string. There are also some types of malformed
strings which Git will parse wrong, and yet consider valid.
Seriously malformed strings will be rejected.</p></div>
-<div class="paragraph"><p>Unlike the <tt>raw</tt> format above, the time zone/UTC offset information
+<div class="paragraph"><p>Unlike the <code>raw</code> format above, the time zone/UTC offset information
contained in an RFC 2822 date string is used to adjust the date
value to UTC prior to storage. Therefore it is important that
this information be as accurate as possible.</p></div>
@@ -1108,18 +1106,18 @@ this information be as accurate as possible.</p></div> the frontend should let fast-import handle the parsing and conversion
(rather than attempting to do it itself) as the Git parser has
been well tested in the wild.</p></div>
-<div class="paragraph"><p>Frontends should prefer the <tt>raw</tt> format if the source material
+<div class="paragraph"><p>Frontends should prefer the <code>raw</code> format if the source material
already uses UNIX-epoch format, can be coaxed to give dates in that
format, or its format is easily convertible to it, as there is no
ambiguity in parsing.</p></div>
</dd>
<dt class="hdlist1">
-<tt>now</tt>
+<code>now</code>
</dt>
<dd>
<p>
Always use the current time and time zone. The literal
- <tt>now</tt> must always be supplied for <tt><when></tt>.
+ <code>now</code> must always be supplied for <code><when></code>.
</p>
<div class="paragraph"><p>This is a toy format. The current time and time zone of this system
is always copied into the identity string at the time it is being
@@ -1129,12 +1127,12 @@ time zone.</p></div> may be useful to a process that wants to create a new commit
right now, without needing to use a working directory or
<em>git update-index</em>.</p></div>
-<div class="paragraph"><p>If separate <tt>author</tt> and <tt>committer</tt> commands are used in a <tt>commit</tt>
+<div class="paragraph"><p>If separate <code>author</code> and <code>committer</code> commands are used in a <code>commit</code>
the timestamps may not match, as the system clock will be polled
twice (once for each command). The only way to ensure that both
author and committer identity information has the same timestamp
-is to omit <tt>author</tt> (thus copying from <tt>committer</tt>) or to use a
-date format other than <tt>now</tt>.</p></div>
+is to omit <code>author</code> (thus copying from <code>committer</code>) or to use a
+date format other than <code>now</code>.</p></div>
</dd>
</dl></div>
</div>
@@ -1145,7 +1143,7 @@ and control the current import process. More detailed discussion (with examples) of each command follows later.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
-<tt>commit</tt>
+<code>commit</code>
</dt>
<dd>
<p>
@@ -1155,7 +1153,7 @@ and control the current import process. More detailed discussion </p>
</dd>
<dt class="hdlist1">
-<tt>tag</tt>
+<code>tag</code>
</dt>
<dd>
<p>
@@ -1166,7 +1164,7 @@ and control the current import process. More detailed discussion </p>
</dd>
<dt class="hdlist1">
-<tt>reset</tt>
+<code>reset</code>
</dt>
<dd>
<p>
@@ -1176,17 +1174,17 @@ and control the current import process. More detailed discussion </p>
</dd>
<dt class="hdlist1">
-<tt>blob</tt>
+<code>blob</code>
</dt>
<dd>
<p>
Convert raw file data into a blob, for future use in a
- <tt>commit</tt> command. This command is optional and is not
+ <code>commit</code> command. This command is optional and is not
needed to perform an import.
</p>
</dd>
<dt class="hdlist1">
-<tt>checkpoint</tt>
+<code>checkpoint</code>
</dt>
<dd>
<p>
@@ -1197,7 +1195,7 @@ and control the current import process. More detailed discussion </p>
</dd>
<dt class="hdlist1">
-<tt>progress</tt>
+<code>progress</code>
</dt>
<dd>
<p>
@@ -1207,37 +1205,37 @@ and control the current import process. More detailed discussion </p>
</dd>
<dt class="hdlist1">
-<tt>done</tt>
+<code>done</code>
</dt>
<dd>
<p>
Marks the end of the stream. This command is optional
- unless the <tt>done</tt> feature was requested using the
- <tt>--done</tt> command-line option or <tt>feature done</tt> command.
+ unless the <code>done</code> feature was requested using the
+ <code>--done</code> command-line option or <code>feature done</code> command.
</p>
</dd>
<dt class="hdlist1">
-<tt>cat-blob</tt>
+<code>cat-blob</code>
</dt>
<dd>
<p>
Causes fast-import to print a blob in <em>cat-file --batch</em>
- format to the file descriptor set with <tt>--cat-blob-fd</tt> or
- <tt>stdout</tt> if unspecified.
+ format to the file descriptor set with <code>--cat-blob-fd</code> or
+ <code>stdout</code> if unspecified.
</p>
</dd>
<dt class="hdlist1">
-<tt>ls</tt>
+<code>ls</code>
</dt>
<dd>
<p>
Causes fast-import to print a line describing a directory
entry in <em>ls-tree</em> format to the file descriptor set with
- <tt>--cat-blob-fd</tt> or <tt>stdout</tt> if unspecified.
+ <code>--cat-blob-fd</code> or <code>stdout</code> if unspecified.
</p>
</dd>
<dt class="hdlist1">
-<tt>feature</tt>
+<code>feature</code>
</dt>
<dd>
<p>
@@ -1246,7 +1244,7 @@ and control the current import process. More detailed discussion </p>
</dd>
<dt class="hdlist1">
-<tt>option</tt>
+<code>option</code>
</dt>
<dd>
<p>
@@ -1258,12 +1256,12 @@ and control the current import process. More detailed discussion </dl></div>
</div>
<div class="sect2">
-<h3 id="_tt_commit_tt"><tt>commit</tt></h3>
+<h3 id="_code_commit_code"><code>commit</code></h3>
<div class="paragraph"><p>Create or update a branch with a new commit, recording one logical
change to the project.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'commit' SP <ref> LF
+<pre><code> 'commit' SP <ref> LF
mark?
('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
'committer' (SP <name>)? SP LT <email> GT SP <when> LF
@@ -1271,75 +1269,75 @@ change to the project.</p></div> ('from' SP <commit-ish> LF)?
('merge' SP <commit-ish> LF)?
(filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
- LF?</tt></pre>
+ LF?</code></pre>
</div></div>
-<div class="paragraph"><p>where <tt><ref></tt> is the name of the branch to make the commit on.
-Typically branch names are prefixed with <tt>refs/heads/</tt> in
-Git, so importing the CVS branch symbol <tt>RELENG-1_0</tt> would use
-<tt>refs/heads/RELENG-1_0</tt> for the value of <tt><ref></tt>. The value of
-<tt><ref></tt> must be a valid refname in Git. As <tt>LF</tt> is not valid in
+<div class="paragraph"><p>where <code><ref></code> is the name of the branch to make the commit on.
+Typically branch names are prefixed with <code>refs/heads/</code> in
+Git, so importing the CVS branch symbol <code>RELENG-1_0</code> would use
+<code>refs/heads/RELENG-1_0</code> for the value of <code><ref></code>. The value of
+<code><ref></code> must be a valid refname in Git. As <code>LF</code> is not valid in
a Git refname, no quoting or escaping syntax is supported here.</p></div>
-<div class="paragraph"><p>A <tt>mark</tt> command may optionally appear, requesting fast-import to save a
+<div class="paragraph"><p>A <code>mark</code> command may optionally appear, requesting fast-import to save a
reference to the newly created commit for future use by the frontend
(see below for format). It is very common for frontends to mark
every commit they create, thereby allowing future branch creation
from any imported commit.</p></div>
-<div class="paragraph"><p>The <tt>data</tt> command following <tt>committer</tt> must supply the commit
-message (see below for <tt>data</tt> command syntax). To import an empty
+<div class="paragraph"><p>The <code>data</code> command following <code>committer</code> must supply the commit
+message (see below for <code>data</code> command syntax). To import an empty
commit message use a 0 length data. Commit messages are free-form
and are not interpreted by Git. Currently they must be encoded in
UTF-8, as fast-import does not permit other encodings to be specified.</p></div>
-<div class="paragraph"><p>Zero or more <tt>filemodify</tt>, <tt>filedelete</tt>, <tt>filecopy</tt>, <tt>filerename</tt>,
-<tt>filedeleteall</tt> and <tt>notemodify</tt> commands
+<div class="paragraph"><p>Zero or more <code>filemodify</code>, <code>filedelete</code>, <code>filecopy</code>, <code>filerename</code>,
+<code>filedeleteall</code> and <code>notemodify</code> commands
may be included to update the contents of the branch prior to
creating the commit. These commands may be supplied in any order.
-However it is recommended that a <tt>filedeleteall</tt> command precede
-all <tt>filemodify</tt>, <tt>filecopy</tt>, <tt>filerename</tt> and <tt>notemodify</tt> commands in
-the same commit, as <tt>filedeleteall</tt> wipes the branch clean (see below).</p></div>
-<div class="paragraph"><p>The <tt>LF</tt> after the command is optional (it used to be required).</p></div>
+However it is recommended that a <code>filedeleteall</code> command precede
+all <code>filemodify</code>, <code>filecopy</code>, <code>filerename</code> and <code>notemodify</code> commands in
+the same commit, as <code>filedeleteall</code> wipes the branch clean (see below).</p></div>
+<div class="paragraph"><p>The <code>LF</code> after the command is optional (it used to be required).</p></div>
<div class="sect3">
-<h4 id="_tt_author_tt"><tt>author</tt></h4>
-<div class="paragraph"><p>An <tt>author</tt> command may optionally appear, if the author information
-might differ from the committer information. If <tt>author</tt> is omitted
+<h4 id="_code_author_code"><code>author</code></h4>
+<div class="paragraph"><p>An <code>author</code> command may optionally appear, if the author information
+might differ from the committer information. If <code>author</code> is omitted
then fast-import will automatically use the committer’s information for
the author portion of the commit. See below for a description of
-the fields in <tt>author</tt>, as they are identical to <tt>committer</tt>.</p></div>
+the fields in <code>author</code>, as they are identical to <code>committer</code>.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_committer_tt"><tt>committer</tt></h4>
-<div class="paragraph"><p>The <tt>committer</tt> command indicates who made this commit, and when
+<h4 id="_code_committer_code"><code>committer</code></h4>
+<div class="paragraph"><p>The <code>committer</code> command indicates who made this commit, and when
they made it.</p></div>
-<div class="paragraph"><p>Here <tt><name></tt> is the person’s display name (for example
-“Com M Itter”) and <tt><email></tt> is the person’s email address
-(“cm@example.com”). <tt>LT</tt> and <tt>GT</tt> are the literal less-than (\x3c)
+<div class="paragraph"><p>Here <code><name></code> is the person’s display name (for example
+“Com M Itter”) and <code><email></code> is the person’s email address
+(“cm@example.com”). <code>LT</code> and <code>GT</code> are the literal less-than (\x3c)
and greater-than (\x3e) symbols. These are required to delimit
the email address from the other fields in the line. Note that
-<tt><name></tt> and <tt><email></tt> are free-form and may contain any sequence
-of bytes, except <tt>LT</tt>, <tt>GT</tt> and <tt>LF</tt>. <tt><name></tt> is typically UTF-8 encoded.</p></div>
-<div class="paragraph"><p>The time of the change is specified by <tt><when></tt> using the date format
+<code><name></code> and <code><email></code> are free-form and may contain any sequence
+of bytes, except <code>LT</code>, <code>GT</code> and <code>LF</code>. <code><name></code> is typically UTF-8 encoded.</p></div>
+<div class="paragraph"><p>The time of the change is specified by <code><when></code> using the date format
that was selected by the --date-format=<fmt> command-line option.
See “Date Formats” above for the set of supported formats, and
their syntax.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_from_tt"><tt>from</tt></h4>
-<div class="paragraph"><p>The <tt>from</tt> command is used to specify the commit to initialize
+<h4 id="_code_from_code"><code>from</code></h4>
+<div class="paragraph"><p>The <code>from</code> command is used to specify the commit to initialize
this branch from. This revision will be the first ancestor of the
new commit. The state of the tree built at this commit will begin
-with the state at the <tt>from</tt> commit, and be altered by the content
+with the state at the <code>from</code> commit, and be altered by the content
modifications in this commit.</p></div>
-<div class="paragraph"><p>Omitting the <tt>from</tt> command in the first commit of a new branch
+<div class="paragraph"><p>Omitting the <code>from</code> command in the first commit of a new branch
will cause fast-import to create that commit with no ancestor. This
tends to be desired only for the initial commit of a project.
If the frontend creates all files from scratch when making a new
-branch, a <tt>merge</tt> command may be used instead of <tt>from</tt> to start
+branch, a <code>merge</code> command may be used instead of <code>from</code> to start
the commit with an empty tree.
-Omitting the <tt>from</tt> command on existing branches is usually desired,
+Omitting the <code>from</code> command on existing branches is usually desired,
as the current commit on that branch is automatically assumed to
be the first ancestor of the new commit.</p></div>
-<div class="paragraph"><p>As <tt>LF</tt> is not valid in a Git refname or SHA-1 expression, no
-quoting or escaping syntax is supported within <tt><commit-ish></tt>.</p></div>
-<div class="paragraph"><p>Here <tt><commit-ish></tt> is any of the following:</p></div>
+<div class="paragraph"><p>As <code>LF</code> is not valid in a Git refname or SHA-1 expression, no
+quoting or escaping syntax is supported within <code><commit-ish></code>.</p></div>
+<div class="paragraph"><p>Here <code><commit-ish></code> is any of the following:</p></div>
<div class="ulist"><ul>
<li>
<p>
@@ -1350,14 +1348,14 @@ The name of an existing branch already in fast-import’s internal branch </li>
<li>
<p>
-A mark reference, <tt>:<idnum></tt>, where <tt><idnum></tt> is the mark number.
+A mark reference, <code>:<idnum></code>, where <code><idnum></code> is the mark number.
</p>
-<div class="paragraph"><p>The reason fast-import uses <tt>:</tt> to denote a mark reference is this character
-is not legal in a Git branch name. The leading <tt>:</tt> makes it easy
-to distinguish between the mark 42 (<tt>:42</tt>) and the branch 42 (<tt>42</tt>
-or <tt>refs/heads/42</tt>), or an abbreviated SHA-1 which happened to
+<div class="paragraph"><p>The reason fast-import uses <code>:</code> to denote a mark reference is this character
+is not legal in a Git branch name. The leading <code>:</code> makes it easy
+to distinguish between the mark 42 (<code>:42</code>) and the branch 42 (<code>42</code>
+or <code>refs/heads/42</code>), or an abbreviated SHA-1 which happened to
consist only of base-10 digits.</p></div>
-<div class="paragraph"><p>Marks must be declared (via <tt>mark</tt>) before they can be used.</p></div>
+<div class="paragraph"><p>Marks must be declared (via <code>mark</code>) before they can be used.</p></div>
</li>
<li>
<p>
@@ -1381,34 +1379,34 @@ The special null SHA-1 (40 zeros) specifies that the branch is to be current branch value should be written as:</p></div>
<div class="listingblock">
<div class="content">
-<pre><tt> from refs/heads/branch^0</tt></pre>
+<pre><code> from refs/heads/branch^0</code></pre>
</div></div>
-<div class="paragraph"><p>The <tt>^0</tt> suffix is necessary as fast-import does not permit a branch to
+<div class="paragraph"><p>The <code>^0</code> suffix is necessary as fast-import does not permit a branch to
start from itself, and the branch is created in memory before the
-<tt>from</tt> command is even read from the input. Adding <tt>^0</tt> will force
+<code>from</code> command is even read from the input. Adding <code>^0</code> will force
fast-import to resolve the commit through Git’s revision parsing library,
rather than its internal branch table, thereby loading in the
existing value of the branch.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_merge_tt"><tt>merge</tt></h4>
+<h4 id="_code_merge_code"><code>merge</code></h4>
<div class="paragraph"><p>Includes one additional ancestor commit. The additional ancestry
link does not change the way the tree state is built at this commit.
-If the <tt>from</tt> command is
-omitted when creating a new branch, the first <tt>merge</tt> commit will be
+If the <code>from</code> command is
+omitted when creating a new branch, the first <code>merge</code> commit will be
the first ancestor of the current commit, and the branch will start
-out with no files. An unlimited number of <tt>merge</tt> commands per
+out with no files. An unlimited number of <code>merge</code> commands per
commit are permitted by fast-import, thereby establishing an n-way merge.
However Git’s other tools never create commits with more than 15
additional ancestors (forming a 16-way merge). For this reason
-it is suggested that frontends do not use more than 15 <tt>merge</tt>
+it is suggested that frontends do not use more than 15 <code>merge</code>
commands per commit; 16, if starting a new, empty branch.</p></div>
-<div class="paragraph"><p>Here <tt><commit-ish></tt> is any of the commit specification expressions
-also accepted by <tt>from</tt> (see above).</p></div>
+<div class="paragraph"><p>Here <code><commit-ish></code> is any of the commit specification expressions
+also accepted by <code>from</code> (see above).</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_filemodify_tt"><tt>filemodify</tt></h4>
-<div class="paragraph"><p>Included in a <tt>commit</tt> command to add a new file or change the
+<h4 id="_code_filemodify_code"><code>filemodify</code></h4>
+<div class="paragraph"><p>Included in a <code>commit</code> command to add a new file or change the
content of an existing file. This command has two different means
of specifying the content of the file.</p></div>
<div class="dlist"><dl>
@@ -1418,17 +1416,17 @@ External data format <dd>
<p>
The data content for the file was already supplied by a prior
- <tt>blob</tt> command. The frontend just needs to connect it.
+ <code>blob</code> command. The frontend just needs to connect it.
</p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'M' SP <mode> SP <dataref> SP <path> LF</tt></pre>
+<pre><code> 'M' SP <mode> SP <dataref> SP <path> LF</code></pre>
</div></div>
-<div class="paragraph"><p>Here usually <tt><dataref></tt> must be either a mark reference (<tt>:<idnum></tt>)
-set by a prior <tt>blob</tt> command, or a full 40-byte SHA-1 of an
-existing Git blob object. If <tt><mode></tt> is <tt>040000`</tt> then
-<tt><dataref></tt> must be the full 40-byte SHA-1 of an existing
-Git tree object or a mark reference set with <tt>--import-marks</tt>.</p></div>
+<div class="paragraph"><p>Here usually <code><dataref></code> must be either a mark reference (<code>:<idnum></code>)
+set by a prior <code>blob</code> command, or a full 40-byte SHA-1 of an
+existing Git blob object. If <code><mode></code> is <code>040000`</code> then
+<code><dataref></code> must be the full 40-byte SHA-1 of an existing
+Git tree object or a mark reference set with <code>--import-marks</code>.</p></div>
</dd>
<dt class="hdlist1">
Inline data format
@@ -1441,174 +1439,174 @@ Inline data format </p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'M' SP <mode> SP 'inline' SP <path> LF
- data</tt></pre>
+<pre><code> 'M' SP <mode> SP 'inline' SP <path> LF
+ data</code></pre>
</div></div>
-<div class="paragraph"><p>See below for a detailed description of the <tt>data</tt> command.</p></div>
+<div class="paragraph"><p>See below for a detailed description of the <code>data</code> command.</p></div>
</dd>
</dl></div>
-<div class="paragraph"><p>In both formats <tt><mode></tt> is the type of file entry, specified
+<div class="paragraph"><p>In both formats <code><mode></code> is the type of file entry, specified
in octal. Git only supports the following modes:</p></div>
<div class="ulist"><ul>
<li>
<p>
-<tt>100644</tt> or <tt>644</tt>: A normal (not-executable) file. The majority
+<code>100644</code> or <code>644</code>: A normal (not-executable) file. The majority
of files in most projects use this mode. If in doubt, this is
what you want.
</p>
</li>
<li>
<p>
-<tt>100755</tt> or <tt>755</tt>: A normal, but executable, file.
+<code>100755</code> or <code>755</code>: A normal, but executable, file.
</p>
</li>
<li>
<p>
-<tt>120000</tt>: A symlink, the content of the file will be the link target.
+<code>120000</code>: A symlink, the content of the file will be the link target.
</p>
</li>
<li>
<p>
-<tt>160000</tt>: A gitlink, SHA-1 of the object refers to a commit in
+<code>160000</code>: A gitlink, SHA-1 of the object refers to a commit in
another repository. Git links can only be specified by SHA or through
a commit mark. They are used to implement submodules.
</p>
</li>
<li>
<p>
-<tt>040000</tt>: A subdirectory. Subdirectories can only be specified by
- SHA or through a tree mark set with <tt>--import-marks</tt>.
+<code>040000</code>: A subdirectory. Subdirectories can only be specified by
+ SHA or through a tree mark set with <code>--import-marks</code>.
</p>
</li>
</ul></div>
-<div class="paragraph"><p>In both formats <tt><path></tt> is the complete path of the file to be added
+<div class="paragraph"><p>In both formats <code><path></code> is the complete path of the file to be added
(if not already existing) or modified (if already existing).</p></div>
-<div class="paragraph"><p>A <tt><path></tt> string must use UNIX-style directory separators (forward
-slash <tt>/</tt>), may contain any byte other than <tt>LF</tt>, and must not
-start with double quote (<tt>"</tt>).</p></div>
+<div class="paragraph"><p>A <code><path></code> string must use UNIX-style directory separators (forward
+slash <code>/</code>), may contain any byte other than <code>LF</code>, and must not
+start with double quote (<code>"</code>).</p></div>
<div class="paragraph"><p>A path can use C-style string quoting; this is accepted in all cases
and mandatory if the filename starts with double quote or contains
-<tt>LF</tt>. In C-style quoting, the complete name should be surrounded with
-double quotes, and any <tt>LF</tt>, backslash, or double quote characters
+<code>LF</code>. In C-style quoting, the complete name should be surrounded with
+double quotes, and any <code>LF</code>, backslash, or double quote characters
must be escaped by preceding them with a backslash (e.g.,
-<tt>"path/with\n, \\ and \" in it"</tt>).</p></div>
-<div class="paragraph"><p>The value of <tt><path></tt> must be in canonical form. That is it must not:</p></div>
+<code>"path/with\n, \\ and \" in it"</code>).</p></div>
+<div class="paragraph"><p>The value of <code><path></code> must be in canonical form. That is it must not:</p></div>
<div class="ulist"><ul>
<li>
<p>
-contain an empty directory component (e.g. <tt>foo//bar</tt> is invalid),
+contain an empty directory component (e.g. <code>foo//bar</code> is invalid),
</p>
</li>
<li>
<p>
-end with a directory separator (e.g. <tt>foo/</tt> is invalid),
+end with a directory separator (e.g. <code>foo/</code> is invalid),
</p>
</li>
<li>
<p>
-start with a directory separator (e.g. <tt>/foo</tt> is invalid),
+start with a directory separator (e.g. <code>/foo</code> is invalid),
</p>
</li>
<li>
<p>
-contain the special component <tt>.</tt> or <tt>..</tt> (e.g. <tt>foo/./bar</tt> and
- <tt>foo/../bar</tt> are invalid).
+contain the special component <code>.</code> or <code>..</code> (e.g. <code>foo/./bar</code> and
+ <code>foo/../bar</code> are invalid).
</p>
</li>
</ul></div>
-<div class="paragraph"><p>The root of the tree can be represented by an empty string as <tt><path></tt>.</p></div>
-<div class="paragraph"><p>It is recommended that <tt><path></tt> always be encoded using UTF-8.</p></div>
+<div class="paragraph"><p>The root of the tree can be represented by an empty string as <code><path></code>.</p></div>
+<div class="paragraph"><p>It is recommended that <code><path></code> always be encoded using UTF-8.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_filedelete_tt"><tt>filedelete</tt></h4>
-<div class="paragraph"><p>Included in a <tt>commit</tt> command to remove a file or recursively
+<h4 id="_code_filedelete_code"><code>filedelete</code></h4>
+<div class="paragraph"><p>Included in a <code>commit</code> command to remove a file or recursively
delete an entire directory from the branch. If the file or directory
removal makes its parent directory empty, the parent directory will
be automatically removed too. This cascades up the tree until the
first non-empty directory or the root is reached.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'D' SP <path> LF</tt></pre>
+<pre><code> 'D' SP <path> LF</code></pre>
</div></div>
-<div class="paragraph"><p>here <tt><path></tt> is the complete path of the file or subdirectory to
+<div class="paragraph"><p>here <code><path></code> is the complete path of the file or subdirectory to
be removed from the branch.
-See <tt>filemodify</tt> above for a detailed description of <tt><path></tt>.</p></div>
+See <code>filemodify</code> above for a detailed description of <code><path></code>.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_filecopy_tt"><tt>filecopy</tt></h4>
+<h4 id="_code_filecopy_code"><code>filecopy</code></h4>
<div class="paragraph"><p>Recursively copies an existing file or subdirectory to a different
location within the branch. The existing file or directory must
exist. If the destination exists it will be completely replaced
by the content copied from the source.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'C' SP <path> SP <path> LF</tt></pre>
+<pre><code> 'C' SP <path> SP <path> LF</code></pre>
</div></div>
-<div class="paragraph"><p>here the first <tt><path></tt> is the source location and the second
-<tt><path></tt> is the destination. See <tt>filemodify</tt> above for a detailed
-description of what <tt><path></tt> may look like. To use a source path
+<div class="paragraph"><p>here the first <code><path></code> is the source location and the second
+<code><path></code> is the destination. See <code>filemodify</code> above for a detailed
+description of what <code><path></code> may look like. To use a source path
that contains SP the path must be quoted.</p></div>
-<div class="paragraph"><p>A <tt>filecopy</tt> command takes effect immediately. Once the source
+<div class="paragraph"><p>A <code>filecopy</code> command takes effect immediately. Once the source
location has been copied to the destination any future commands
applied to the source location will not impact the destination of
the copy.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_filerename_tt"><tt>filerename</tt></h4>
+<h4 id="_code_filerename_code"><code>filerename</code></h4>
<div class="paragraph"><p>Renames an existing file or subdirectory to a different location
within the branch. The existing file or directory must exist. If
the destination exists it will be replaced by the source directory.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'R' SP <path> SP <path> LF</tt></pre>
+<pre><code> 'R' SP <path> SP <path> LF</code></pre>
</div></div>
-<div class="paragraph"><p>here the first <tt><path></tt> is the source location and the second
-<tt><path></tt> is the destination. See <tt>filemodify</tt> above for a detailed
-description of what <tt><path></tt> may look like. To use a source path
+<div class="paragraph"><p>here the first <code><path></code> is the source location and the second
+<code><path></code> is the destination. See <code>filemodify</code> above for a detailed
+description of what <code><path></code> may look like. To use a source path
that contains SP the path must be quoted.</p></div>
-<div class="paragraph"><p>A <tt>filerename</tt> command takes effect immediately. Once the source
+<div class="paragraph"><p>A <code>filerename</code> command takes effect immediately. Once the source
location has been renamed to the destination any future commands
applied to the source location will create new files there and not
impact the destination of the rename.</p></div>
-<div class="paragraph"><p>Note that a <tt>filerename</tt> is the same as a <tt>filecopy</tt> followed by a
-<tt>filedelete</tt> of the source location. There is a slight performance
-advantage to using <tt>filerename</tt>, but the advantage is so small
+<div class="paragraph"><p>Note that a <code>filerename</code> is the same as a <code>filecopy</code> followed by a
+<code>filedelete</code> of the source location. There is a slight performance
+advantage to using <code>filerename</code>, but the advantage is so small
that it is never worth trying to convert a delete/add pair in
-source material into a rename for fast-import. This <tt>filerename</tt>
+source material into a rename for fast-import. This <code>filerename</code>
command is provided just to simplify frontends that already have
rename information and don’t want bother with decomposing it into a
-<tt>filecopy</tt> followed by a <tt>filedelete</tt>.</p></div>
+<code>filecopy</code> followed by a <code>filedelete</code>.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_filedeleteall_tt"><tt>filedeleteall</tt></h4>
-<div class="paragraph"><p>Included in a <tt>commit</tt> command to remove all files (and also all
+<h4 id="_code_filedeleteall_code"><code>filedeleteall</code></h4>
+<div class="paragraph"><p>Included in a <code>commit</code> command to remove all files (and also all
directories) from the branch. This command resets the internal
branch structure to have no files in it, allowing the frontend
to subsequently add all interesting files from scratch.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'deleteall' LF</tt></pre>
+<pre><code> 'deleteall' LF</code></pre>
</div></div>
<div class="paragraph"><p>This command is extremely useful if the frontend does not know
(or does not care to know) what files are currently on the branch,
-and therefore cannot generate the proper <tt>filedelete</tt> commands to
+and therefore cannot generate the proper <code>filedelete</code> commands to
update the content.</p></div>
-<div class="paragraph"><p>Issuing a <tt>filedeleteall</tt> followed by the needed <tt>filemodify</tt>
+<div class="paragraph"><p>Issuing a <code>filedeleteall</code> followed by the needed <code>filemodify</code>
commands to set the correct content will produce the same results
-as sending only the needed <tt>filemodify</tt> and <tt>filedelete</tt> commands.
-The <tt>filedeleteall</tt> approach may however require fast-import to use slightly
+as sending only the needed <code>filemodify</code> and <code>filedelete</code> commands.
+The <code>filedeleteall</code> approach may however require fast-import to use slightly
more memory per active branch (less than 1 MiB for even most large
projects); so frontends that can easily obtain only the affected
paths for a commit are encouraged to do so.</p></div>
</div>
<div class="sect3">
-<h4 id="_tt_notemodify_tt"><tt>notemodify</tt></h4>
-<div class="paragraph"><p>Included in a <tt>commit</tt> <tt><notes_ref></tt> command to add a new note
-annotating a <tt><commit-ish></tt> or change this annotation contents.
-Internally it is similar to filemodify 100644 on <tt><commit-ish></tt>
+<h4 id="_code_notemodify_code"><code>notemodify</code></h4>
+<div class="paragraph"><p>Included in a <code>commit</code> <code><notes_ref></code> command to add a new note
+annotating a <code><commit-ish></code> or change this annotation contents.
+Internally it is similar to filemodify 100644 on <code><commit-ish></code>
path (maybe split into subdirectories). It’s not advised to
-use any other commands to write to the <tt><notes_ref></tt> tree except
-<tt>filedeleteall</tt> to delete all existing notes in this tree.
+use any other commands to write to the <code><notes_ref></code> tree except
+<code>filedeleteall</code> to delete all existing notes in this tree.
This command has two different means of specifying the content
of the note.</p></div>
<div class="dlist"><dl>
@@ -1618,15 +1616,15 @@ External data format <dd>
<p>
The data content for the note was already supplied by a prior
- <tt>blob</tt> command. The frontend just needs to connect it to the
+ <code>blob</code> command. The frontend just needs to connect it to the
commit that is to be annotated.
</p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'N' SP <dataref> SP <commit-ish> LF</tt></pre>
+<pre><code> 'N' SP <dataref> SP <commit-ish> LF</code></pre>
</div></div>
-<div class="paragraph"><p>Here <tt><dataref></tt> can be either a mark reference (<tt>:<idnum></tt>)
-set by a prior <tt>blob</tt> command, or a full 40-byte SHA-1 of an
+<div class="paragraph"><p>Here <code><dataref></code> can be either a mark reference (<code>:<idnum></code>)
+set by a prior <code>blob</code> command, or a full 40-byte SHA-1 of an
existing Git blob object.</p></div>
</dd>
<dt class="hdlist1">
@@ -1640,60 +1638,60 @@ Inline data format </p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'N' SP 'inline' SP <commit-ish> LF
- data</tt></pre>
+<pre><code> 'N' SP 'inline' SP <commit-ish> LF
+ data</code></pre>
</div></div>
-<div class="paragraph"><p>See below for a detailed description of the <tt>data</tt> command.</p></div>
+<div class="paragraph"><p>See below for a detailed description of the <code>data</code> command.</p></div>
</dd>
</dl></div>
-<div class="paragraph"><p>In both formats <tt><commit-ish></tt> is any of the commit specification
-expressions also accepted by <tt>from</tt> (see above).</p></div>
+<div class="paragraph"><p>In both formats <code><commit-ish></code> is any of the commit specification
+expressions also accepted by <code>from</code> (see above).</p></div>
</div>
</div>
<div class="sect2">
-<h3 id="_tt_mark_tt"><tt>mark</tt></h3>
+<h3 id="_code_mark_code"><code>mark</code></h3>
<div class="paragraph"><p>Arranges for fast-import to save a reference to the current object, allowing
the frontend to recall this object at a future point in time, without
knowing its SHA-1. Here the current object is the object creation
-command the <tt>mark</tt> command appears within. This can be <tt>commit</tt>,
-<tt>tag</tt>, and <tt>blob</tt>, but <tt>commit</tt> is the most common usage.</p></div>
+command the <code>mark</code> command appears within. This can be <code>commit</code>,
+<code>tag</code>, and <code>blob</code>, but <code>commit</code> is the most common usage.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'mark' SP ':' <idnum> LF</tt></pre>
+<pre><code> 'mark' SP ':' <idnum> LF</code></pre>
</div></div>
-<div class="paragraph"><p>where <tt><idnum></tt> is the number assigned by the frontend to this mark.
-The value of <tt><idnum></tt> is expressed as an ASCII decimal integer.
+<div class="paragraph"><p>where <code><idnum></code> is the number assigned by the frontend to this mark.
+The value of <code><idnum></code> is expressed as an ASCII decimal integer.
The value 0 is reserved and cannot be used as
a mark. Only values greater than or equal to 1 may be used as marks.</p></div>
<div class="paragraph"><p>New marks are created automatically. Existing marks can be moved
-to another object simply by reusing the same <tt><idnum></tt> in another
-<tt>mark</tt> command.</p></div>
+to another object simply by reusing the same <code><idnum></code> in another
+<code>mark</code> command.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_tag_tt"><tt>tag</tt></h3>
+<h3 id="_code_tag_code"><code>tag</code></h3>
<div class="paragraph"><p>Creates an annotated tag referring to a specific commit. To create
-lightweight (non-annotated) tags see the <tt>reset</tt> command below.</p></div>
+lightweight (non-annotated) tags see the <code>reset</code> command below.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'tag' SP <name> LF
+<pre><code> 'tag' SP <name> LF
'from' SP <commit-ish> LF
'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
- data</tt></pre>
+ data</code></pre>
</div></div>
-<div class="paragraph"><p>where <tt><name></tt> is the name of the tag to create.</p></div>
-<div class="paragraph"><p>Tag names are automatically prefixed with <tt>refs/tags/</tt> when stored
-in Git, so importing the CVS branch symbol <tt>RELENG-1_0-FINAL</tt> would
-use just <tt>RELENG-1_0-FINAL</tt> for <tt><name></tt>, and fast-import will write the
-corresponding ref as <tt>refs/tags/RELENG-1_0-FINAL</tt>.</p></div>
-<div class="paragraph"><p>The value of <tt><name></tt> must be a valid refname in Git and therefore
-may contain forward slashes. As <tt>LF</tt> is not valid in a Git refname,
+<div class="paragraph"><p>where <code><name></code> is the name of the tag to create.</p></div>
+<div class="paragraph"><p>Tag names are automatically prefixed with <code>refs/tags/</code> when stored
+in Git, so importing the CVS branch symbol <code>RELENG-1_0-FINAL</code> would
+use just <code>RELENG-1_0-FINAL</code> for <code><name></code>, and fast-import will write the
+corresponding ref as <code>refs/tags/RELENG-1_0-FINAL</code>.</p></div>
+<div class="paragraph"><p>The value of <code><name></code> must be a valid refname in Git and therefore
+may contain forward slashes. As <code>LF</code> is not valid in a Git refname,
no quoting or escaping syntax is supported here.</p></div>
-<div class="paragraph"><p>The <tt>from</tt> command is the same as in the <tt>commit</tt> command; see
+<div class="paragraph"><p>The <code>from</code> command is the same as in the <code>commit</code> command; see
above for details.</p></div>
-<div class="paragraph"><p>The <tt>tagger</tt> command uses the same format as <tt>committer</tt> within
-<tt>commit</tt>; again see above for details.</p></div>
-<div class="paragraph"><p>The <tt>data</tt> command following <tt>tagger</tt> must supply the annotated tag
-message (see below for <tt>data</tt> command syntax). To import an empty
+<div class="paragraph"><p>The <code>tagger</code> command uses the same format as <code>committer</code> within
+<code>commit</code>; again see above for details.</p></div>
+<div class="paragraph"><p>The <code>data</code> command following <code>tagger</code> must supply the annotated tag
+message (see below for <code>data</code> command syntax). To import an empty
tag message use a 0 length data. Tag messages are free-form and are
not interpreted by Git. Currently they must be encoded in UTF-8,
as fast-import does not permit other encodings to be specified.</p></div>
@@ -1702,66 +1700,66 @@ supported. Trying to include your own PGP/GPG signature is not recommended, as the frontend does not (easily) have access to the
complete set of bytes which normally goes into such a signature.
If signing is required, create lightweight tags from within fast-import with
-<tt>reset</tt>, then create the annotated versions of those tags offline
+<code>reset</code>, then create the annotated versions of those tags offline
with the standard <em>git tag</em> process.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_reset_tt"><tt>reset</tt></h3>
+<h3 id="_code_reset_code"><code>reset</code></h3>
<div class="paragraph"><p>Creates (or recreates) the named branch, optionally starting from
a specific revision. The reset command allows a frontend to issue
-a new <tt>from</tt> command for an existing branch, or to create a new
+a new <code>from</code> command for an existing branch, or to create a new
branch from an existing commit without creating a new commit.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'reset' SP <ref> LF
+<pre><code> 'reset' SP <ref> LF
('from' SP <commit-ish> LF)?
- LF?</tt></pre>
+ LF?</code></pre>
</div></div>
-<div class="paragraph"><p>For a detailed description of <tt><ref></tt> and <tt><commit-ish></tt> see above
-under <tt>commit</tt> and <tt>from</tt>.</p></div>
-<div class="paragraph"><p>The <tt>LF</tt> after the command is optional (it used to be required).</p></div>
-<div class="paragraph"><p>The <tt>reset</tt> command can also be used to create lightweight
+<div class="paragraph"><p>For a detailed description of <code><ref></code> and <code><commit-ish></code> see above
+under <code>commit</code> and <code>from</code>.</p></div>
+<div class="paragraph"><p>The <code>LF</code> after the command is optional (it used to be required).</p></div>
+<div class="paragraph"><p>The <code>reset</code> command can also be used to create lightweight
(non-annotated) tags. For example:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt>reset refs/tags/938
-from :938</tt></pre>
+<pre><code>reset refs/tags/938
+from :938</code></pre>
</div></div>
</div></div>
-<div class="paragraph"><p>would create the lightweight tag <tt>refs/tags/938</tt> referring to
-whatever commit mark <tt>:938</tt> references.</p></div>
+<div class="paragraph"><p>would create the lightweight tag <code>refs/tags/938</code> referring to
+whatever commit mark <code>:938</code> references.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_blob_tt"><tt>blob</tt></h3>
+<h3 id="_code_blob_code"><code>blob</code></h3>
<div class="paragraph"><p>Requests writing one file revision to the packfile. The revision
is not connected to any commit; this connection must be formed in
-a subsequent <tt>commit</tt> command by referencing the blob through an
+a subsequent <code>commit</code> command by referencing the blob through an
assigned mark.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'blob' LF
+<pre><code> 'blob' LF
mark?
- data</tt></pre>
+ data</code></pre>
</div></div>
<div class="paragraph"><p>The mark command is optional here as some frontends have chosen
to generate the Git SHA-1 for the blob on their own, and feed that
-directly to <tt>commit</tt>. This is typically more work than it’s worth
+directly to <code>commit</code>. This is typically more work than it’s worth
however, as marks are inexpensive to store and easy to use.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_data_tt"><tt>data</tt></h3>
+<h3 id="_code_data_code"><code>data</code></h3>
<div class="paragraph"><p>Supplies raw data (for use as blob/file content, commit messages, or
annotated tag messages) to fast-import. Data can be supplied using an exact
byte count or delimited with a terminating line. Real frontends
intended for production-quality conversions should always use the
exact byte count format, as it is more robust and performs better.
The delimited format is intended primarily for testing fast-import.</p></div>
-<div class="paragraph"><p>Comment lines appearing within the <tt><raw></tt> part of <tt>data</tt> commands
+<div class="paragraph"><p>Comment lines appearing within the <code><raw></code> part of <code>data</code> commands
are always taken to be part of the body of the data and are therefore
never ignored by fast-import. This makes it safe to import any
-file/message content whose lines might start with <tt>#</tt>.</p></div>
+file/message content whose lines might start with <code>#</code>.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Exact byte count format
@@ -1772,17 +1770,17 @@ Exact byte count format </p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'data' SP <count> LF
- <raw> LF?</tt></pre>
+<pre><code> 'data' SP <count> LF
+ <raw> LF?</code></pre>
</div></div>
-<div class="paragraph"><p>where <tt><count></tt> is the exact number of bytes appearing within
-<tt><raw></tt>. The value of <tt><count></tt> is expressed as an ASCII decimal
-integer. The <tt>LF</tt> on either side of <tt><raw></tt> is not
-included in <tt><count></tt> and will not be included in the imported data.</p></div>
-<div class="paragraph"><p>The <tt>LF</tt> after <tt><raw></tt> is optional (it used to be required) but
+<div class="paragraph"><p>where <code><count></code> is the exact number of bytes appearing within
+<code><raw></code>. The value of <code><count></code> is expressed as an ASCII decimal
+integer. The <code>LF</code> on either side of <code><raw></code> is not
+included in <code><count></code> and will not be included in the imported data.</p></div>
+<div class="paragraph"><p>The <code>LF</code> after <code><raw></code> is optional (it used to be required) but
recommended. Always including it makes debugging a fast-import
stream easier as the next command always starts in column 0
-of the next line, even if <tt><raw></tt> did not end with an <tt>LF</tt>.</p></div>
+of the next line, even if <code><raw></code> did not end with an <code>LF</code>.</p></div>
</dd>
<dt class="hdlist1">
Delimited format
@@ -1796,108 +1794,108 @@ Delimited format </p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'data' SP '<<' <delim> LF
+<pre><code> 'data' SP '<<' <delim> LF
<raw> LF
<delim> LF
- LF?</tt></pre>
+ LF?</code></pre>
</div></div>
-<div class="paragraph"><p>where <tt><delim></tt> is the chosen delimiter string. The string <tt><delim></tt>
-must not appear on a line by itself within <tt><raw></tt>, as otherwise
-fast-import will think the data ends earlier than it really does. The <tt>LF</tt>
-immediately trailing <tt><raw></tt> is part of <tt><raw></tt>. This is one of
+<div class="paragraph"><p>where <code><delim></code> is the chosen delimiter string. The string <code><delim></code>
+must not appear on a line by itself within <code><raw></code>, as otherwise
+fast-import will think the data ends earlier than it really does. The <code>LF</code>
+immediately trailing <code><raw></code> is part of <code><raw></code>. This is one of
the limitations of the delimited format, it is impossible to supply
a data chunk which does not have an LF as its last byte.</p></div>
-<div class="paragraph"><p>The <tt>LF</tt> after <tt><delim> LF</tt> is optional (it used to be required).</p></div>
+<div class="paragraph"><p>The <code>LF</code> after <code><delim> LF</code> is optional (it used to be required).</p></div>
</dd>
</dl></div>
</div>
<div class="sect2">
-<h3 id="_tt_checkpoint_tt"><tt>checkpoint</tt></h3>
+<h3 id="_code_checkpoint_code"><code>checkpoint</code></h3>
<div class="paragraph"><p>Forces fast-import to close the current packfile, start a new one, and to
save out all current branch refs, tags and marks.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'checkpoint' LF
- LF?</tt></pre>
+<pre><code> 'checkpoint' LF
+ LF?</code></pre>
</div></div>
<div class="paragraph"><p>Note that fast-import automatically switches packfiles when the current
packfile reaches --max-pack-size, or 4 GiB, whichever limit is
smaller. During an automatic packfile switch fast-import does not update
the branch refs, tags or marks.</p></div>
-<div class="paragraph"><p>As a <tt>checkpoint</tt> can require a significant amount of CPU time and
+<div class="paragraph"><p>As a <code>checkpoint</code> can require a significant amount of CPU time and
disk IO (to compute the overall pack SHA-1 checksum, generate the
corresponding index file, and update the refs) it can easily take
-several minutes for a single <tt>checkpoint</tt> command to complete.</p></div>
+several minutes for a single <code>checkpoint</code> command to complete.</p></div>
<div class="paragraph"><p>Frontends may choose to issue checkpoints during extremely large
and long running imports, or when they need to allow another Git
process access to a branch. However given that a 30 GiB Subversion
repository can be loaded into Git through fast-import in about 3 hours,
explicit checkpointing may not be necessary.</p></div>
-<div class="paragraph"><p>The <tt>LF</tt> after the command is optional (it used to be required).</p></div>
+<div class="paragraph"><p>The <code>LF</code> after the command is optional (it used to be required).</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_progress_tt"><tt>progress</tt></h3>
-<div class="paragraph"><p>Causes fast-import to print the entire <tt>progress</tt> line unmodified to
+<h3 id="_code_progress_code"><code>progress</code></h3>
+<div class="paragraph"><p>Causes fast-import to print the entire <code>progress</code> line unmodified to
its standard output channel (file descriptor 1) when the command is
processed from the input stream. The command otherwise has no impact
on the current import, or on any of fast-import’s internal state.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'progress' SP <any> LF
- LF?</tt></pre>
+<pre><code> 'progress' SP <any> LF
+ LF?</code></pre>
</div></div>
-<div class="paragraph"><p>The <tt><any></tt> part of the command may contain any sequence of bytes
-that does not contain <tt>LF</tt>. The <tt>LF</tt> after the command is optional.
+<div class="paragraph"><p>The <code><any></code> part of the command may contain any sequence of bytes
+that does not contain <code>LF</code>. The <code>LF</code> after the command is optional.
Callers may wish to process the output through a tool such as sed to
remove the leading part of the line, for example:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt>frontend | git fast-import | sed 's/^progress //'</tt></pre>
+<pre><code>frontend | git fast-import | sed 's/^progress //'</code></pre>
</div></div>
</div></div>
-<div class="paragraph"><p>Placing a <tt>progress</tt> command immediately after a <tt>checkpoint</tt> will
-inform the reader when the <tt>checkpoint</tt> has been completed and it
+<div class="paragraph"><p>Placing a <code>progress</code> command immediately after a <code>checkpoint</code> will
+inform the reader when the <code>checkpoint</code> has been completed and it
can safely access the refs that fast-import updated.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_cat_blob_tt"><tt>cat-blob</tt></h3>
+<h3 id="_code_cat_blob_code"><code>cat-blob</code></h3>
<div class="paragraph"><p>Causes fast-import to print a blob to a file descriptor previously
-arranged with the <tt>--cat-blob-fd</tt> argument. The command otherwise
+arranged with the <code>--cat-blob-fd</code> argument. The command otherwise
has no impact on the current import; its main purpose is to
retrieve blobs that may be in fast-import’s memory but not
accessible from the target repository.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'cat-blob' SP <dataref> LF</tt></pre>
+<pre><code> 'cat-blob' SP <dataref> LF</code></pre>
</div></div>
-<div class="paragraph"><p>The <tt><dataref></tt> can be either a mark reference (<tt>:<idnum></tt>)
+<div class="paragraph"><p>The <code><dataref></code> can be either a mark reference (<code>:<idnum></code>)
set previously or a full 40-byte SHA-1 of a Git blob, preexisting or
ready to be written.</p></div>
-<div class="paragraph"><p>Output uses the same format as <tt>git cat-file --batch</tt>:</p></div>
+<div class="paragraph"><p>Output uses the same format as <code>git cat-file --batch</code>:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt><sha1> SP 'blob' SP <size> LF
-<contents> LF</tt></pre>
+<pre><code><sha1> SP 'blob' SP <size> LF
+<contents> LF</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>This command can be used anywhere in the stream that comments are
-accepted. In particular, the <tt>cat-blob</tt> command can be used in the
-middle of a commit but not in the middle of a <tt>data</tt> command.</p></div>
+accepted. In particular, the <code>cat-blob</code> command can be used in the
+middle of a commit but not in the middle of a <code>data</code> command.</p></div>
<div class="paragraph"><p>See “Responses To Commands” below for details about how to read
this output safely.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_ls_tt"><tt>ls</tt></h3>
+<h3 id="_code_ls_code"><code>ls</code></h3>
<div class="paragraph"><p>Prints information about the object at a path to a file descriptor
-previously arranged with the <tt>--cat-blob-fd</tt> argument. This allows
-printing a blob from the active commit (with <tt>cat-blob</tt>) or copying a
+previously arranged with the <code>--cat-blob-fd</code> argument. This allows
+printing a blob from the active commit (with <code>cat-blob</code>) or copying a
blob or tree from a previous commit for use in the current one (with
-<tt>filemodify</tt>).</p></div>
-<div class="paragraph"><p>The <tt>ls</tt> command can be used anywhere in the stream that comments are
+<code>filemodify</code>).</p></div>
+<div class="paragraph"><p>The <code>ls</code> command can be used anywhere in the stream that comments are
accepted, including the middle of a commit.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
@@ -1905,13 +1903,13 @@ Reading from the active commit </dt>
<dd>
<p>
- This form can only be used in the middle of a <tt>commit</tt>.
+ This form can only be used in the middle of a <code>commit</code>.
The path names a directory entry within fast-import’s
active commit. The path must be quoted in this case.
</p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'ls' SP <path> LF</tt></pre>
+<pre><code> 'ls' SP <path> LF</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
@@ -1919,25 +1917,25 @@ Reading from a named tree </dt>
<dd>
<p>
- The <tt><dataref></tt> can be a mark reference (<tt>:<idnum></tt>) or the
+ The <code><dataref></code> can be a mark reference (<code>:<idnum></code>) or the
full 40-byte SHA-1 of a Git tag, commit, or tree object,
preexisting or waiting to be written.
The path is relative to the top level of the tree
- named by <tt><dataref></tt>.
+ named by <code><dataref></code>.
</p>
<div class="literalblock">
<div class="content">
-<pre><tt> 'ls' SP <dataref> SP <path> LF</tt></pre>
+<pre><code> 'ls' SP <dataref> SP <path> LF</code></pre>
</div></div>
</dd>
</dl></div>
-<div class="paragraph"><p>See <tt>filemodify</tt> above for a detailed description of <tt><path></tt>.</p></div>
-<div class="paragraph"><p>Output uses the same format as <tt>git ls-tree <tree> -- <path></tt>:</p></div>
+<div class="paragraph"><p>See <code>filemodify</code> above for a detailed description of <code><path></code>.</p></div>
+<div class="paragraph"><p>Output uses the same format as <code>git ls-tree <tree> -- <path></code>:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt><mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF</tt></pre>
+<pre><code><mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>The <dataref> represents the blob, tree, or commit object at <path>
@@ -1948,19 +1946,19 @@ instead report</p></div> <div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt>missing SP <path> LF</tt></pre>
+<pre><code>missing SP <path> LF</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>See “Responses To Commands” below for details about how to read
this output safely.</p></div>
</div>
<div class="sect2">
-<h3 id="_tt_feature_tt"><tt>feature</tt></h3>
+<h3 id="_code_feature_code"><code>feature</code></h3>
<div class="paragraph"><p>Require that fast-import supports the specified feature, or abort if
it does not.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'feature' SP <feature> ('=' <argument>)? LF</tt></pre>
+<pre><code> 'feature' SP <feature> ('=' <argument>)? LF</code></pre>
</div></div>
<div class="paragraph"><p>The <feature> part of the command may be any one of the following:</p></div>
<div class="dlist"><dl>
@@ -2046,16 +2044,16 @@ done </dl></div>
</div>
<div class="sect2">
-<h3 id="_tt_option_tt"><tt>option</tt></h3>
+<h3 id="_code_option_code"><code>option</code></h3>
<div class="paragraph"><p>Processes the specified option so that git fast-import behaves in a
way that suits the frontend’s needs.
Note that options specified by the frontend are overridden by any
options the user may specify to git fast-import itself.</p></div>
<div class="literalblock">
<div class="content">
-<pre><tt> 'option' SP <option> LF</tt></pre>
+<pre><code> 'option' SP <option> LF</code></pre>
</div></div>
-<div class="paragraph"><p>The <tt><option></tt> part of the command may contain any of the options
+<div class="paragraph"><p>The <code><option></code> part of the command may contain any of the options
listed in the OPTIONS section that do not change import semantics,
without the leading <em>--</em> and is treated in the same way.</p></div>
<div class="paragraph"><p>Option commands must be the first commands on the input (not counting
@@ -2092,11 +2090,11 @@ force </ul></div>
</div>
<div class="sect2">
-<h3 id="_tt_done_tt"><tt>done</tt></h3>
-<div class="paragraph"><p>If the <tt>done</tt> feature is not in use, treated as if EOF was read.
+<h3 id="_code_done_code"><code>done</code></h3>
+<div class="paragraph"><p>If the <code>done</code> feature is not in use, treated as if EOF was read.
This can be used to tell fast-import to finish early.</p></div>
-<div class="paragraph"><p>If the <tt>--done</tt> command-line option or <tt>feature done</tt> command is
-in use, the <tt>done</tt> command is mandatory and marks the end of the
+<div class="paragraph"><p>If the <code>--done</code> command-line option or <code>feature done</code> command is
+in use, the <code>done</code> command is mandatory and marks the end of the
stream.</p></div>
</div>
</div>
@@ -2120,15 +2118,15 @@ bidirectional pipes:</p></div> <div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt>mkfifo fast-import-output
+<pre><code>mkfifo fast-import-output
frontend <fast-import-output |
-git fast-import >fast-import-output</tt></pre>
+git fast-import >fast-import-output</code></pre>
</div></div>
</div></div>
-<div class="paragraph"><p>A frontend set up this way can use <tt>progress</tt>, <tt>ls</tt>, and <tt>cat-blob</tt>
+<div class="paragraph"><p>A frontend set up this way can use <code>progress</code>, <code>ls</code>, and <code>cat-blob</code>
commands to read information from the import in progress.</p></div>
<div class="paragraph"><p>To avoid deadlock, such frontends must completely consume any
-pending output from <tt>progress</tt>, <tt>ls</tt>, and <tt>cat-blob</tt> before
+pending output from <code>progress</code>, <code>ls</code>, and <code>cat-blob</code> before
performing writes to fast-import that might block.</p></div>
</div>
</div>
@@ -2158,7 +2156,7 @@ must be applied manually if the update is needed.</p></div> <div class="content">
<div class="literalblock">
<div class="content">
-<pre><tt>$ cat >in <<END_OF_INPUT
+<pre><code>$ cat >in <<END_OF_INPUT
# my very first test commit
commit refs/heads/master
committer Shawn O. Pearce <spearce> 19283 -0400
@@ -2171,29 +2169,29 @@ data <<EOF .gitignore
EOF
M 777 inline bob
-END_OF_INPUT</tt></pre>
+END_OF_INPUT</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>$ git fast-import <in
+<pre><code>$ git fast-import <in
fatal: Corrupt mode: M 777 inline bob
-fast-import: dumping crash report to .git/fast_import_crash_8434</tt></pre>
+fast-import: dumping crash report to .git/fast_import_crash_8434</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>$ cat .git/fast_import_crash_8434
+<pre><code>$ cat .git/fast_import_crash_8434
fast-import crash report:
fast-import process: 8434
parent process : 1391
- at Sat Sep 1 00:58:12 2007</tt></pre>
+ at Sat Sep 1 00:58:12 2007</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>fatal: Corrupt mode: M 777 inline bob</tt></pre>
+<pre><code>fatal: Corrupt mode: M 777 inline bob</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>Most Recent Commands Before Crash
+<pre><code>Most Recent Commands Before Crash
---------------------------------
# my very first test commit
commit refs/heads/master
@@ -2202,23 +2200,23 @@ fast-import crash report: data <<EOF
M 644 inline .gitignore
data <<EOF
-* M 777 inline bob</tt></pre>
+* M 777 inline bob</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>Active Branch LRU
+<pre><code>Active Branch LRU
-----------------
- active_branches = 1 cur, 5 max</tt></pre>
+ active_branches = 1 cur, 5 max</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>pos clock name
+<pre><code>pos clock name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- 1) 0 refs/heads/master</tt></pre>
+ 1) 0 refs/heads/master</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>Inactive Branches
+<pre><code>Inactive Branches
-----------------
refs/heads/master:
status : active loaded dirty
@@ -2226,12 +2224,12 @@ refs/heads/master: old tree : 0000000000000000000000000000000000000000
cur tree : 0000000000000000000000000000000000000000
commit clock: 0
- last pack :</tt></pre>
+ last pack :</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
-<pre><tt>-------------------
-END OF CRASH REPORT</tt></pre>
+<pre><code>-------------------
+END OF CRASH REPORT</code></pre>
</div></div>
</div></div>
</div>
@@ -2244,7 +2242,7 @@ users of fast-import, and are offered here as suggestions.</p></div> <div class="sect2">
<h3 id="_use_one_mark_per_commit">Use One Mark Per Commit</h3>
<div class="paragraph"><p>When doing a repository conversion, use a unique mark per commit
-(<tt>mark :<n></tt>) and supply the --export-marks option on the command
+(<code>mark :<n></code>) and supply the --export-marks option on the command
line. fast-import will dump a file which lists every mark and the Git
object SHA-1 that corresponds to it. If the frontend can tie
the marks back to the source repository, it is easy to verify the
@@ -2278,21 +2276,21 @@ files which are not from the same commit/changeset. Or to create tags which are a subset of the files available in the repository.</p></div>
<div class="paragraph"><p>Importing these tags as-is in Git is impossible without making at
least one commit which “fixes up” the files to match the content
-of the tag. Use fast-import’s <tt>reset</tt> command to reset a dummy branch
+of the tag. Use fast-import’s <code>reset</code> command to reset a dummy branch
outside of your normal branch space to the base commit for the tag,
then commit one or more file fixup commits, and finally tag the
dummy branch.</p></div>
-<div class="paragraph"><p>For example since all normal branches are stored under <tt>refs/heads/</tt>
-name the tag fixup branch <tt>TAG_FIXUP</tt>. This way it is impossible for
+<div class="paragraph"><p>For example since all normal branches are stored under <code>refs/heads/</code>
+name the tag fixup branch <code>TAG_FIXUP</code>. This way it is impossible for
the fixup branch used by the importer to have namespace conflicts
-with real branches imported from the source (the name <tt>TAG_FIXUP</tt>
-is not <tt>refs/heads/TAG_FIXUP</tt>).</p></div>
-<div class="paragraph"><p>When committing fixups, consider using <tt>merge</tt> to connect the
+with real branches imported from the source (the name <code>TAG_FIXUP</code>
+is not <code>refs/heads/TAG_FIXUP</code>).</p></div>
+<div class="paragraph"><p>When committing fixups, consider using <code>merge</code> to connect the
commit(s) which are supplying file revisions to the fixup branch.
Doing so will allow tools such as <em>git blame</em> to track
through the real commit history and properly annotate the source
files.</p></div>
-<div class="paragraph"><p>After fast-import terminates the frontend will need to do <tt>rm .git/TAG_FIXUP</tt>
+<div class="paragraph"><p>After fast-import terminates the frontend will need to do <code>rm .git/TAG_FIXUP</code>
to remove the dummy branch.</p></div>
</div>
<div class="sect2">
@@ -2322,7 +2320,7 @@ project will benefit from the smaller repository.</p></div> </div>
<div class="sect2">
<h3 id="_include_some_progress_messages">Include Some Progress Messages</h3>
-<div class="paragraph"><p>Every once in a while have your frontend emit a <tt>progress</tt> message
+<div class="paragraph"><p>Every once in a while have your frontend emit a <code>progress</code> message
to fast-import. The contents of the messages are entirely free-form,
so one suggestion would be to output the current month and year
each time the current commit date moves into the next month.
@@ -2342,10 +2340,10 @@ packfile will be compressed, but will not be optimal.</p></div> <div class="paragraph"><p>Frontends which have efficient access to all revisions of a
single file (for example reading an RCS/CVS ,v file) can choose
to supply all revisions of that file as a sequence of consecutive
-<tt>blob</tt> commands. This allows fast-import to deltify the different file
+<code>blob</code> commands. This allows fast-import to deltify the different file
revisions against each other, saving space in the final packfile.
Marks can be used to later identify individual file revisions during
-a sequence of <tt>commit</tt> commands.</p></div>
+a sequence of <code>commit</code> commands.</p></div>
<div class="paragraph"><p>The packfile(s) created by fast-import do not encourage good disk access
patterns. This is caused by fast-import writing the data in the order
it is received on standard input, while Git typically organizes
@@ -2353,9 +2351,9 @@ data within packfiles to make the most recent (current tip) data appear before historical data. Git also clusters commits together,
speeding up revision traversal through better cache locality.</p></div>
<div class="paragraph"><p>For this reason it is strongly recommended that users repack the
-repository with <tt>git repack -a -d</tt> after fast-import completes, allowing
+repository with <code>git repack -a -d</code> after fast-import completes, allowing
Git to reorganize the packfiles for faster data access. If blob
-deltas are suboptimal (see above) then also adding the <tt>-f</tt> option
+deltas are suboptimal (see above) then also adding the <code>-f</code> option
to force recomputation of all deltas can significantly reduce the
final packfile size (30-50% smaller can be quite typical).</p></div>
</div>
@@ -2401,16 +2399,16 @@ easily handle as many as 10,000 inactive branches in under 2 MiB of memory.</p></div>
<div class="paragraph"><p>Active branches have the same overhead as inactive branches, but
also contain copies of every tree that has been recently modified on
-that branch. If subtree <tt>include</tt> has not been modified since the
+that branch. If subtree <code>include</code> has not been modified since the
branch became active, its contents will not be loaded into memory,
-but if subtree <tt>src</tt> has been modified by a commit since the branch
+but if subtree <code>src</code> has been modified by a commit since the branch
became active, then its contents will be loaded in memory.</p></div>
<div class="paragraph"><p>As active branches store metadata about the files contained on that
branch, their in-memory storage size can grow to a considerable size
(see below).</p></div>
<div class="paragraph"><p>fast-import automatically moves active branches to inactive status based on
a simple least-recently-used algorithm. The LRU chain is updated on
-each <tt>commit</tt> command. The maximum number of active branches can be
+each <code>commit</code> command. The maximum number of active branches can be
increased or decreased on the command line with --active-branches=.</p></div>
</div>
<div class="sect2">
@@ -2438,7 +2436,7 @@ memory footprint (less than 2.7 MiB per active branch).</p></div> <h2 id="_signals">Signals</h2>
<div class="sectionbody">
<div class="paragraph"><p>Sending <strong>SIGUSR1</strong> to the <em>git fast-import</em> process ends the current
-packfile early, simulating a <tt>checkpoint</tt> command. The impatient
+packfile early, simulating a <code>checkpoint</code> command. The impatient
operator can use this facility to peek at the objects and refs from an
import in progress, at the cost of some added running time and worse
compression.</p></div>
|