OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-fetch.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-fetch(1)">\r
5 <articleinfo>\r
6     <title>git-fetch(1)</title>\r
7         <indexterm>\r
8                 <primary>git-fetch(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-fetch - Download objects and refs from another repository</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git fetch</emphasis> &lt;options&gt; &lt;repository&gt; &lt;refspec&gt;&#8230;</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>Fetches named heads or tags from another repository, along with\r
22 the objects necessary to complete them.</simpara>\r
23 <simpara>The ref names and their object names of fetched refs are stored\r
24 in <literal>.git/FETCH_HEAD</literal>.  This information is left for a later merge\r
25 operation done by <emphasis>git-merge</emphasis>.</simpara>\r
26 <simpara>When &lt;refspec&gt; stores the fetched result in tracking branches,\r
27 the tags that point at these branches are automatically\r
28 followed.  This is done by first fetching from the remote using\r
29 the given &lt;refspec&gt;s, and if the repository has objects that are\r
30 pointed by remote tags that it does not yet have, then fetch\r
31 those missing tags.  If the other end has tags that point at\r
32 branches you are not interested in, you will not get them.</simpara>\r
33 </simplesect>\r
34 <simplesect id="_options">\r
35 <title>OPTIONS</title>\r
36 <variablelist>\r
37 <varlistentry>\r
38 <term>\r
39 -q\r
40 </term>\r
41 <term>\r
42 --quiet\r
43 </term>\r
44 <listitem>\r
45 <simpara>\r
46         Pass --quiet to git-fetch-pack and silence any other internally\r
47         used programs.\r
48 </simpara>\r
49 </listitem>\r
50 </varlistentry>\r
51 <varlistentry>\r
52 <term>\r
53 -v\r
54 </term>\r
55 <term>\r
56 --verbose\r
57 </term>\r
58 <listitem>\r
59 <simpara>\r
60         Be verbose.\r
61 </simpara>\r
62 </listitem>\r
63 </varlistentry>\r
64 <varlistentry>\r
65 <term>\r
66 -a\r
67 </term>\r
68 <term>\r
69 --append\r
70 </term>\r
71 <listitem>\r
72 <simpara>\r
73         Append ref names and object names of fetched refs to the\r
74         existing contents of <literal>.git/FETCH_HEAD</literal>.  Without this\r
75         option old data in <literal>.git/FETCH_HEAD</literal> will be overwritten.\r
76 </simpara>\r
77 </listitem>\r
78 </varlistentry>\r
79 <varlistentry>\r
80 <term>\r
81 --upload-pack &lt;upload-pack&gt;\r
82 </term>\r
83 <listitem>\r
84 <simpara>\r
85         When given, and the repository to fetch from is handled\r
86         by <emphasis>git-fetch-pack</emphasis>, <emphasis>--exec=&lt;upload-pack&gt;</emphasis> is passed to\r
87         the command to specify non-default path for the command\r
88         run on the other end.\r
89 </simpara>\r
90 </listitem>\r
91 </varlistentry>\r
92 <varlistentry>\r
93 <term>\r
94 -f\r
95 </term>\r
96 <term>\r
97 --force\r
98 </term>\r
99 <listitem>\r
100 <simpara>\r
101         When <emphasis>git-fetch</emphasis> is used with <literal>&lt;rbranch&gt;:&lt;lbranch&gt;</literal>\r
102         refspec, it refuses to update the local branch\r
103         <literal>&lt;lbranch&gt;</literal> unless the remote branch <literal>&lt;rbranch&gt;</literal> it\r
104         fetches is a descendant of <literal>&lt;lbranch&gt;</literal>.  This option\r
105         overrides that check.\r
106 </simpara>\r
107 </listitem>\r
108 </varlistentry>\r
109 <varlistentry>\r
110 <term>\r
111 -n\r
112 </term>\r
113 <term>\r
114 --no-tags\r
115 </term>\r
116 <listitem>\r
117 <simpara>\r
118         By default, tags that point at objects that are downloaded\r
119         from the remote repository are fetched and stored locally.\r
120         This option disables this automatic tag following.\r
121 </simpara>\r
122 </listitem>\r
123 </varlistentry>\r
124 <varlistentry>\r
125 <term>\r
126 -t\r
127 </term>\r
128 <term>\r
129 --tags\r
130 </term>\r
131 <listitem>\r
132 <simpara>\r
133         Most of the tags are fetched automatically as branch\r
134         heads are downloaded, but tags that do not point at\r
135         objects reachable from the branch heads that are being\r
136         tracked will not be fetched by this mechanism.  This\r
137         flag lets all tags and their associated objects be\r
138         downloaded.\r
139 </simpara>\r
140 </listitem>\r
141 </varlistentry>\r
142 <varlistentry>\r
143 <term>\r
144 -k\r
145 </term>\r
146 <term>\r
147 --keep\r
148 </term>\r
149 <listitem>\r
150 <simpara>\r
151         Keep downloaded pack.\r
152 </simpara>\r
153 </listitem>\r
154 </varlistentry>\r
155 <varlistentry>\r
156 <term>\r
157 -u\r
158 </term>\r
159 <term>\r
160 --update-head-ok\r
161 </term>\r
162 <listitem>\r
163 <simpara>\r
164         By default <emphasis>git-fetch</emphasis> refuses to update the head which\r
165         corresponds to the current branch.  This flag disables the\r
166         check.  This is purely for the internal use for <emphasis>git-pull</emphasis>\r
167         to communicate with <emphasis>git-fetch</emphasis>, and unless you are\r
168         implementing your own Porcelain you are not supposed to\r
169         use it.\r
170 </simpara>\r
171 </listitem>\r
172 </varlistentry>\r
173 <varlistentry>\r
174 <term>\r
175 --depth=&lt;depth&gt;\r
176 </term>\r
177 <listitem>\r
178 <simpara>\r
179         Deepen the history of a <emphasis>shallow</emphasis> repository created by\r
180         <literal>git clone</literal> with <literal>--depth=&lt;depth&gt;</literal> option (see <xref linkend="git-clone(1)"/>)\r
181         by the specified number of commits.\r
182 </simpara>\r
183 </listitem>\r
184 </varlistentry>\r
185 <varlistentry>\r
186 <term>\r
187 &lt;repository&gt;\r
188 </term>\r
189 <listitem>\r
190 <simpara>\r
191         The "remote" repository that is the source of a fetch\r
192         or pull operation.  This parameter can be either a URL\r
193         (see the section <link linkend="URLS">GIT URLS</link> below) or the name\r
194         of a remote (see the section <link linkend="REMOTES">REMOTES</link> below).\r
195 </simpara>\r
196 </listitem>\r
197 </varlistentry>\r
198 <varlistentry>\r
199 <term>\r
200 &lt;refspec&gt;\r
201 </term>\r
202 <listitem>\r
203 <simpara>\r
204         The format of a &lt;refspec&gt; parameter is an optional plus\r
205         <literal>&#43;</literal>, followed by the source ref &lt;src&gt;, followed\r
206         by a colon <literal>:</literal>, followed by the destination ref &lt;dst&gt;.\r
207 </simpara>\r
208 <simpara>The remote ref that matches &lt;src&gt;\r
209 is fetched, and if &lt;dst&gt; is not empty string, the local\r
210 ref that matches it is fast forwarded using &lt;src&gt;.\r
211 If the optional plus <literal>+</literal> is used, the local ref\r
212 is updated even if it does not result in a fast forward\r
213 update.</simpara>\r
214 <note><simpara>If the remote branch from which you want to pull is\r
215 modified in non-linear ways such as being rewound and\r
216 rebased frequently, then a pull will attempt a merge with\r
217 an older version of itself, likely conflict, and fail.\r
218 It is under these conditions that you would want to use\r
219 the <literal>+</literal> sign to indicate non-fast-forward updates will\r
220 be needed.  There is currently no easy way to determine\r
221 or declare that a branch will be made available in a\r
222 repository with this behavior; the pulling user simply\r
223 must know this is the expected usage pattern for a branch.</simpara></note>\r
224 <note><simpara>You never do your own development on branches that appear\r
225 on the right hand side of a &lt;refspec&gt; colon on <literal>Pull:</literal> lines;\r
226 they are to be updated by <emphasis>git-fetch</emphasis>.  If you intend to do\r
227 development derived from a remote branch <literal>B</literal>, have a <literal>Pull:</literal>\r
228 line to track it (i.e. <literal>Pull: B:remote-B</literal>), and have a separate\r
229 branch <literal>my-B</literal> to do your development on top of it.  The latter\r
230 is created by <literal>git branch my-B remote-B</literal> (or its equivalent <literal>git\r
231 checkout -b my-B remote-B</literal>).  Run <literal>git fetch</literal> to keep track of\r
232 the progress of the remote side, and when you see something new\r
233 on the remote branch, merge it into your development branch with\r
234 <literal>git pull . remote-B</literal>, while you are on <literal>my-B</literal> branch.</simpara></note>\r
235 <note><simpara>There is a difference between listing multiple &lt;refspec&gt;\r
236 directly on <emphasis>git-pull</emphasis> command line and having multiple\r
237 <literal>Pull:</literal> &lt;refspec&gt; lines for a &lt;repository&gt; and running\r
238 <emphasis>git-pull</emphasis> command without any explicit &lt;refspec&gt; parameters.\r
239 &lt;refspec&gt; listed explicitly on the command line are always\r
240 merged into the current branch after fetching.  In other words,\r
241 if you list more than one remote refs, you would be making\r
242 an Octopus.  While <emphasis>git-pull</emphasis> run without any explicit &lt;refspec&gt;\r
243 parameter takes default &lt;refspec&gt;s from <literal>Pull:</literal> lines, it\r
244 merges only the first &lt;refspec&gt; found into the current branch,\r
245 after fetching all the remote refs.  This is because making an\r
246 Octopus from remote refs is rarely done, while keeping track\r
247 of multiple remote heads in one-go by fetching more than one\r
248 is often useful.</simpara></note>\r
249 <simpara>Some short-cut notations are also supported.</simpara>\r
250 <itemizedlist>\r
251 <listitem>\r
252 <simpara>\r
253 <literal>tag &lt;tag&gt;</literal> means the same as <literal>refs/tags/&lt;tag&gt;:refs/tags/&lt;tag&gt;</literal>;\r
254   it requests fetching everything up to the given tag.\r
255 </simpara>\r
256 </listitem>\r
257 <listitem>\r
258 <simpara>\r
259 A parameter &lt;ref&gt; without a colon is equivalent to\r
260   &lt;ref&gt;: when pulling/fetching, so it merges &lt;ref&gt; into the current\r
261   branch without storing the remote branch anywhere locally\r
262 </simpara>\r
263 </listitem>\r
264 </itemizedlist>\r
265 </listitem>\r
266 </varlistentry>\r
267 </variablelist>\r
268 </simplesect>\r
269 <simplesect id="_git_urls_anchor_id_urls_xreflabel_urls">\r
270 <title>GIT URLS<anchor id="URLS" xreflabel="[URLS]"/></title>\r
271 <simpara>One of the following notations can be used\r
272 to name the remote repository:</simpara>\r
273 <informalexample>\r
274 <itemizedlist>\r
275 <listitem>\r
276 <simpara>\r
277 rsync://host.xz/path/to/repo.git/\r
278 </simpara>\r
279 </listitem>\r
280 <listitem>\r
281 <simpara>\r
282 <ulink url="http://host.xz&#91;:port&#93;/path/to/repo.git/">http://host.xz&#91;:port&#93;/path/to/repo.git/</ulink>\r
283 </simpara>\r
284 </listitem>\r
285 <listitem>\r
286 <simpara>\r
287 <ulink url="https://host.xz&#91;:port&#93;/path/to/repo.git/">https://host.xz&#91;:port&#93;/path/to/repo.git/</ulink>\r
288 </simpara>\r
289 </listitem>\r
290 <listitem>\r
291 <simpara>\r
292 git://host.xz&#91;:port&#93;/path/to/repo.git/\r
293 </simpara>\r
294 </listitem>\r
295 <listitem>\r
296 <simpara>\r
297 git://host.xz&#91;:port&#93;/~user/path/to/repo.git/\r
298 </simpara>\r
299 </listitem>\r
300 <listitem>\r
301 <simpara>\r
302 ssh://&#91;user@&#93;host.xz&#91;:port&#93;/path/to/repo.git/\r
303 </simpara>\r
304 </listitem>\r
305 <listitem>\r
306 <simpara>\r
307 ssh://&#91;user@&#93;host.xz/path/to/repo.git/\r
308 </simpara>\r
309 </listitem>\r
310 <listitem>\r
311 <simpara>\r
312 ssh://&#91;user@&#93;host.xz/~user/path/to/repo.git/\r
313 </simpara>\r
314 </listitem>\r
315 <listitem>\r
316 <simpara>\r
317 ssh://&#91;user@&#93;host.xz/~/path/to/repo.git\r
318 </simpara>\r
319 </listitem>\r
320 </itemizedlist>\r
321 </informalexample>\r
322 <simpara>SSH is the default transport protocol over the network.  You can\r
323 optionally specify which user to log-in as, and an alternate,\r
324 scp-like syntax is also supported.  Both syntaxes support\r
325 username expansion, as does the native git protocol, but\r
326 only the former supports port specification. The following\r
327 three are identical to the last three above, respectively:</simpara>\r
328 <informalexample>\r
329 <itemizedlist>\r
330 <listitem>\r
331 <simpara>\r
332 &#91;user@&#93;host.xz:/path/to/repo.git/\r
333 </simpara>\r
334 </listitem>\r
335 <listitem>\r
336 <simpara>\r
337 &#91;user@&#93;host.xz:~user/path/to/repo.git/\r
338 </simpara>\r
339 </listitem>\r
340 <listitem>\r
341 <simpara>\r
342 &#91;user@&#93;host.xz:path/to/repo.git\r
343 </simpara>\r
344 </listitem>\r
345 </itemizedlist>\r
346 </informalexample>\r
347 <simpara>To sync with a local directory, you can use:</simpara>\r
348 <informalexample>\r
349 <itemizedlist>\r
350 <listitem>\r
351 <simpara>\r
352 /path/to/repo.git/\r
353 </simpara>\r
354 </listitem>\r
355 <listitem>\r
356 <simpara>\r
357 <ulink url="file:///path/to/repo.git/">file:///path/to/repo.git/</ulink>\r
358 </simpara>\r
359 </listitem>\r
360 </itemizedlist>\r
361 </informalexample>\r
362 <simpara>They are mostly equivalent, except when cloning.  See\r
363 <xref linkend="git-clone(1)"/> for details.</simpara>\r
364 <simpara>If there are a large number of similarly-named remote repositories and\r
365 you want to use a different format for them (such that the URLs you\r
366 use will be rewritten into URLs that work), you can create a\r
367 configuration section of the form:</simpara>\r
368 <literallayout>        [url "&lt;actual url base&gt;"]\r
369                 insteadOf = &lt;other url base&gt;</literallayout>\r
370 <simpara>For example, with this:</simpara>\r
371 <literallayout>        [url "git://git.host.xz/"]\r
372                 insteadOf = host.xz:/path/to/\r
373                 insteadOf = work:</literallayout>\r
374 <simpara>a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be\r
375 rewritten in any context that takes a URL to be "git://git.host.xz/repo.git".</simpara>\r
376 </simplesect>\r
377 <simplesect id="_remotes_anchor_id_remotes_xreflabel_remotes">\r
378 <title>REMOTES<anchor id="REMOTES" xreflabel="[REMOTES]"/></title>\r
379 <simpara>The name of one of the following can be used instead\r
380 of a URL as <literal>&lt;repository&gt;</literal> argument:</simpara>\r
381 <itemizedlist>\r
382 <listitem>\r
383 <simpara>\r
384 a remote in the git configuration file: <literal>$GIT_DIR/config</literal>,\r
385 </simpara>\r
386 </listitem>\r
387 <listitem>\r
388 <simpara>\r
389 a file in the <literal>$GIT_DIR/remotes</literal> directory, or\r
390 </simpara>\r
391 </listitem>\r
392 <listitem>\r
393 <simpara>\r
394 a file in the <literal>$GIT_DIR/branches</literal> directory.\r
395 </simpara>\r
396 </listitem>\r
397 </itemizedlist>\r
398 <simpara>All of these also allow you to omit the refspec from the command line\r
399 because they each contain a refspec which git will use by default.</simpara>\r
400 <simplesect id="_named_remote_in_configuration_file">\r
401 <title>Named remote in configuration file</title>\r
402 <simpara>You can choose to provide the name of a remote which you had previously\r
403 configured using <xref linkend="git-remote(1)"/>, <xref linkend="git-config(1)"/>\r
404 or even by a manual edit to the <literal>$GIT_DIR/config</literal> file.  The URL of\r
405 this remote will be used to access the repository.  The refspec\r
406 of this remote will be used by default when you do\r
407 not provide a refspec on the command line.  The entry in the\r
408 config file would appear like this:</simpara>\r
409 <literallayout>        [remote "&lt;name&gt;"]\r
410                 url = &lt;url&gt;\r
411                 push = &lt;refspec&gt;\r
412                 fetch = &lt;refspec&gt;</literallayout>\r
413 </simplesect>\r
414 <simplesect id="_named_file_in_literal_git_dir_remotes_literal">\r
415 <title>Named file in <literal>$GIT_DIR/remotes</literal></title>\r
416 <simpara>You can choose to provide the name of a\r
417 file in <literal>$GIT_DIR/remotes</literal>.  The URL\r
418 in this file will be used to access the repository.  The refspec\r
419 in this file will be used as default when you do not\r
420 provide a refspec on the command line.  This file should have the\r
421 following format:</simpara>\r
422 <literallayout>        URL: one of the above URL format\r
423         Push: &lt;refspec&gt;\r
424         Pull: &lt;refspec&gt;</literallayout>\r
425 <simpara><literal>Push:</literal> lines are used by <emphasis>git-push</emphasis> and\r
426 <literal>Pull:</literal> lines are used by <emphasis>git-pull</emphasis> and <emphasis>git-fetch</emphasis>.\r
427 Multiple <literal>Push:</literal> and <literal>Pull:</literal> lines may\r
428 be specified for additional branch mappings.</simpara>\r
429 </simplesect>\r
430 <simplesect id="_named_file_in_literal_git_dir_branches_literal">\r
431 <title>Named file in <literal>$GIT_DIR/branches</literal></title>\r
432 <simpara>You can choose to provide the name of a\r
433 file in <literal>$GIT_DIR/branches</literal>.\r
434 The URL in this file will be used to access the repository.\r
435 This file should have the following format:</simpara>\r
436 <literallayout>        &lt;url&gt;#&lt;head&gt;</literallayout>\r
437 <simpara><literal>&lt;url&gt;</literal> is required; <literal>#&lt;head&gt;</literal> is optional.</simpara>\r
438 <simpara>Depending on the operation, git will use one of the following\r
439 refspecs, if you don&#8217;t provide one on the command line.\r
440 <literal>&lt;branch&gt;</literal> is the name of this file in <literal>$GIT_DIR/branches</literal> and\r
441 <literal>&lt;head&gt;</literal> defaults to <literal>master</literal>.</simpara>\r
442 <simpara>git fetch uses:</simpara>\r
443 <literallayout>        refs/heads/&lt;head&gt;:refs/heads/&lt;branch&gt;</literallayout>\r
444 <simpara>git push uses:</simpara>\r
445 <literallayout>        HEAD:refs/heads/&lt;head&gt;</literallayout>\r
446 </simplesect>\r
447 </simplesect>\r
448 <simplesect id="_see_also">\r
449 <title>SEE ALSO</title>\r
450 <simpara><xref linkend="git-pull(1)"/></simpara>\r
451 </simplesect>\r
452 <simplesect id="_author">\r
453 <title>Author</title>\r
454 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt; and\r
455 Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
456 </simplesect>\r
457 <simplesect id="_documentation">\r
458 <title>Documentation</title>\r
459 <simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
460 </simplesect>\r
461 <simplesect id="_git">\r
462 <title>GIT</title>\r
463 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
464 </simplesect>\r
465 </article>\r