OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-parse-remote.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-parse-remote(1)">\r
5 <articleinfo>\r
6     <title>git-parse-remote(1)</title>\r
7         <indexterm>\r
8                 <primary>git-parse-remote(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-parse-remote - Routines to help parsing remote repository access parameters</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>. "$(git --exec-path)/git-parse-remote"</emphasis></simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>This script is included in various scripts to supply\r
22 routines to parse files under $GIT_DIR/remotes/ and\r
23 $GIT_DIR/branches/ and configuration variables that are related\r
24 to fetching, pulling and pushing.</simpara>\r
25 <simpara>The primary entry points are:</simpara>\r
26 <variablelist>\r
27 <varlistentry>\r
28 <term>\r
29 get_remote_refs_for_fetch\r
30 </term>\r
31 <listitem>\r
32 <simpara>\r
33         Given the list of user-supplied <literal>&lt;repo&gt; &lt;refspec&gt;&#8230;</literal>,\r
34         return the list of refs to fetch after canonicalizing\r
35         them into <literal>$GIT_DIR</literal> relative paths\r
36         (e.g. <literal>refs/heads/foo</literal>).  When <literal>&lt;refspec&gt;&#8230;</literal> is empty\r
37         the returned list of refs consists of the defaults\r
38         for the given <literal>&lt;repo&gt;</literal>, if specified in\r
39         <literal>$GIT_DIR/remotes/</literal>, <literal>$GIT_DIR/branches/</literal>, or <literal>remote.*.fetch</literal>\r
40         configuration.\r
41 </simpara>\r
42 </listitem>\r
43 </varlistentry>\r
44 <varlistentry>\r
45 <term>\r
46 get_remote_refs_for_push\r
47 </term>\r
48 <listitem>\r
49 <simpara>\r
50         Given the list of user-supplied <literal>&lt;repo&gt; &lt;refspec&gt;&#8230;</literal>,\r
51         return the list of refs to push in a form suitable to be\r
52         fed to the <emphasis>git-send-pack</emphasis> command.  When <literal>&lt;refspec&gt;&#8230;</literal>\r
53         is empty the returned list of refs consists of the\r
54         defaults for the given <literal>&lt;repo&gt;</literal>, if specified in\r
55         <literal>$GIT_DIR/remotes/</literal>.\r
56 </simpara>\r
57 </listitem>\r
58 </varlistentry>\r
59 </variablelist>\r
60 </simplesect>\r
61 <simplesect id="_author">\r
62 <title>Author</title>\r
63 <simpara>Written by Junio C Hamano.</simpara>\r
64 </simplesect>\r
65 <simplesect id="_documentation">\r
66 <title>Documentation</title>\r
67 <simpara>Documentation by Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
68 </simplesect>\r
69 <simplesect id="_git">\r
70 <title>GIT</title>\r
71 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
72 </simplesect>\r
73 </article>\r