Updated git_doc to git 1.8
[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-fast-export.xml
blobb62b30aad4ccff3248d17fb026af53fb4b1d66b8
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <sect2 lang="en" id="git-fast-export(1)">\r
5     <title>git-fast-export(1)</title>\r
6 <indexterm>\r
7 <primary>git-fast-export(1)</primary>\r
8 </indexterm>\r
9 <simplesect id="git-fast-export(1)__name">\r
10 <title>NAME</title>\r
11 <simpara>git-fast-export - Git data exporter</simpara>\r
12 </simplesect>\r
13 <simplesect id="git-fast-export(1)__synopsis">\r
14 <title>SYNOPSIS</title>\r
15 <blockquote>\r
16 <literallayout><emphasis>git fast-export [options]</emphasis> | <emphasis>git fast-import</emphasis></literallayout>\r
17 </blockquote>\r
18 </simplesect>\r
19 <simplesect id="git-fast-export(1)__description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>This program dumps the given revisions in a form suitable to be piped\r
22 into <emphasis>git fast-import</emphasis>.</simpara>\r
23 <simpara>You can use it as a human-readable bundle replacement (see\r
24 <xref linkend="git-bundle(1)" />), or as a kind of an interactive\r
25 <emphasis>git filter-branch</emphasis>.</simpara>\r
26 </simplesect>\r
27 <simplesect id="git-fast-export(1)__options">\r
28 <title>OPTIONS</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term>\r
32 --progress=&lt;n&gt;\r
33 </term>\r
34 <listitem>\r
35 <simpara>\r
36         Insert <emphasis>progress</emphasis> statements every &lt;n&gt; objects, to be shown by\r
37         <emphasis>git fast-import</emphasis> during import.\r
38 </simpara>\r
39 </listitem>\r
40 </varlistentry>\r
41 <varlistentry>\r
42 <term>\r
43 --signed-tags=(verbatim|warn|strip|abort)\r
44 </term>\r
45 <listitem>\r
46 <simpara>\r
47         Specify how to handle signed tags.  Since any transformation\r
48         after the export can change the tag names (which can also happen\r
49         when excluding revisions) the signatures will not match.\r
50 </simpara>\r
51 <simpara>When asking to <emphasis>abort</emphasis> (which is the default), this program will die\r
52 when encountering a signed tag.  With <emphasis>strip</emphasis>, the tags will be made\r
53 unsigned, with <emphasis>verbatim</emphasis>, they will be silently exported\r
54 and with <emphasis>warn</emphasis>, they will be exported, but you will see a warning.</simpara>\r
55 </listitem>\r
56 </varlistentry>\r
57 <varlistentry>\r
58 <term>\r
59 --tag-of-filtered-object=(abort|drop|rewrite)\r
60 </term>\r
61 <listitem>\r
62 <simpara>\r
63         Specify how to handle tags whose tagged object is filtered out.\r
64         Since revisions and files to export can be limited by path,\r
65         tagged objects may be filtered completely.\r
66 </simpara>\r
67 <simpara>When asking to <emphasis>abort</emphasis> (which is the default), this program will die\r
68 when encountering such a tag.  With <emphasis>drop</emphasis> it will omit such tags from\r
69 the output.  With <emphasis>rewrite</emphasis>, if the tagged object is a commit, it will\r
70 rewrite the tag to tag an ancestor commit (via parent rewriting; see\r
71 <xref linkend="git-rev-list(1)" />)</simpara>\r
72 </listitem>\r
73 </varlistentry>\r
74 <varlistentry>\r
75 <term>\r
76 -M\r
77 </term>\r
78 <term>\r
79 -C\r
80 </term>\r
81 <listitem>\r
82 <simpara>\r
83         Perform move and/or copy detection, as described in the\r
84         <xref linkend="git-diff(1)" /> manual page, and use it to generate\r
85         rename and copy commands in the output dump.\r
86 </simpara>\r
87 <simpara>Note that earlier versions of this command did not complain and\r
88 produced incorrect results if you gave these options.</simpara>\r
89 </listitem>\r
90 </varlistentry>\r
91 <varlistentry>\r
92 <term>\r
93 --export-marks=&lt;file&gt;\r
94 </term>\r
95 <listitem>\r
96 <simpara>\r
97         Dumps the internal marks table to &lt;file&gt; when complete.\r
98         Marks are written one per line as <emphasis>:markid SHA-1</emphasis>. Only marks\r
99         for revisions are dumped; marks for blobs are ignored.\r
100         Backends can use this file to validate imports after they\r
101         have been completed, or to save the marks table across\r
102         incremental runs.  As &lt;file&gt; is only opened and truncated\r
103         at completion, the same path can also be safely given to\r
104         --import-marks.\r
105 </simpara>\r
106 </listitem>\r
107 </varlistentry>\r
108 <varlistentry>\r
109 <term>\r
110 --import-marks=&lt;file&gt;\r
111 </term>\r
112 <listitem>\r
113 <simpara>\r
114         Before processing any input, load the marks specified in\r
115         &lt;file&gt;.  The input file must exist, must be readable, and\r
116         must use the same format as produced by --export-marks.\r
117 </simpara>\r
118 <simpara>Any commits that have already been marked will not be exported again.\r
119 If the backend uses a similar --import-marks file, this allows for\r
120 incremental bidirectional exporting of the repository by keeping the\r
121 marks the same across runs.</simpara>\r
122 </listitem>\r
123 </varlistentry>\r
124 <varlistentry>\r
125 <term>\r
126 --fake-missing-tagger\r
127 </term>\r
128 <listitem>\r
129 <simpara>\r
130         Some old repositories have tags without a tagger.  The\r
131         fast-import protocol was pretty strict about that, and did not\r
132         allow that.  So fake a tagger to be able to fast-import the\r
133         output.\r
134 </simpara>\r
135 </listitem>\r
136 </varlistentry>\r
137 <varlistentry>\r
138 <term>\r
139 --use-done-feature\r
140 </term>\r
141 <listitem>\r
142 <simpara>\r
143         Start the stream with a <emphasis>feature done</emphasis> stanza, and terminate\r
144         it with a <emphasis>done</emphasis> command.\r
145 </simpara>\r
146 </listitem>\r
147 </varlistentry>\r
148 <varlistentry>\r
149 <term>\r
150 --no-data\r
151 </term>\r
152 <listitem>\r
153 <simpara>\r
154         Skip output of blob objects and instead refer to blobs via\r
155         their original SHA-1 hash.  This is useful when rewriting the\r
156         directory structure or history of a repository without\r
157         touching the contents of individual files.  Note that the\r
158         resulting stream can only be used by a repository which\r
159         already contains the necessary objects.\r
160 </simpara>\r
161 </listitem>\r
162 </varlistentry>\r
163 <varlistentry>\r
164 <term>\r
165 --full-tree\r
166 </term>\r
167 <listitem>\r
168 <simpara>\r
169         This option will cause fast-export to issue a "deleteall"\r
170         directive for each commit followed by a full list of all files\r
171         in the commit (as opposed to just listing the files which are\r
172         different from the commit's first parent).\r
173 </simpara>\r
174 </listitem>\r
175 </varlistentry>\r
176 <varlistentry>\r
177 <term>\r
178 [&lt;git-rev-list-args&gt;&#8230;]\r
179 </term>\r
180 <listitem>\r
181 <simpara>\r
182        A list of arguments, acceptable to <emphasis>git rev-parse</emphasis> and\r
183        <emphasis>git rev-list</emphasis>, that specifies the specific objects and references\r
184        to export.  For example, <emphasis>master~10..master</emphasis> causes the\r
185        current master reference to be exported along with all objects\r
186        added since its 10th ancestor commit.\r
187 </simpara>\r
188 </listitem>\r
189 </varlistentry>\r
190 </variablelist>\r
191 </simplesect>\r
192 <simplesect id="git-fast-export(1)__examples">\r
193 <title>EXAMPLES</title>\r
194 <screen>$ git fast-export --all | (cd /empty/repository &amp;&amp; git fast-import)</screen>\r
195 <simpara>This will export the whole repository and import it into the existing\r
196 empty repository.  Except for reencoding commits that are not in\r
197 UTF-8, it would be a one-to-one mirror.</simpara>\r
198 <screen>$ git fast-export master~5..master |\r
199         sed "s|refs/heads/master|refs/heads/other|" |\r
200         git fast-import</screen>\r
201 <simpara>This makes a new branch called <emphasis>other</emphasis> from <emphasis>master~5..master</emphasis>\r
202 (i.e. if <emphasis>master</emphasis> has linear history, it will take the last 5 commits).</simpara>\r
203 <simpara>Note that this assumes that none of the blobs and commit messages\r
204 referenced by that revision range contains the string\r
205 <emphasis>refs/heads/master</emphasis>.</simpara>\r
206 </simplesect>\r
207 <simplesect id="git-fast-export(1)__limitations">\r
208 <title>Limitations</title>\r
209 <simpara>Since <emphasis>git fast-import</emphasis> cannot tag trees, you will not be\r
210 able to export the linux-2.6.git repository completely, as it contains\r
211 a tag referencing a tree instead of a commit.</simpara>\r
212 </simplesect>\r
213 <simplesect id="git-fast-export(1)__git">\r
214 <title>GIT</title>\r
215 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
216 </simplesect>\r
217 </sect2>\r