| blob | 4d6d6165f23734c62596b6de4eed09755161ca5e |
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-vcs-*(1)">\r
5 <articleinfo>\r
6 <title>git-vcs-*(1)</title>\r
7 <indexterm>\r
8 <primary>git-vcs-*(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-vcs-* - Helper programs for interoperation with foreign systems</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git vcs-<system></emphasis> <command> [options] [arguments]</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>These programs are normally not used directly by end users, but are\r
22 invoked by various git programs that interact with remote repositories\r
23 when the repository they would operate on is part of a foreign\r
24 system.</simpara>\r
25 <simpara>Each <emphasis>git vcs-<system></emphasis> is a helper for interoperating with a\r
26 particular version control system. Different helpers have different\r
27 capabilities (limited both be the particular helper and by the\r
28 capabilities of the system they connect to), and they report what\r
29 capabilities they support.</simpara>\r
30 <simpara>In general, these programs interact with a portion of the refs\r
31 namespace that isn’t used by the rest of git. The configuration will\r
32 then (generally) map these refs into the remotes namespace. This\r
33 allows the importer to do whatever it wants with its refs without\r
34 affecting the state visible to normal git programs.</simpara>\r
35 </simplesect>\r
36 <simplesect id="_commands">\r
37 <title>COMMANDS</title>\r
38 <variablelist>\r
39 <varlistentry>\r
40 <term>\r
41 <emphasis>capabilities</emphasis>\r
42 </term>\r
43 <listitem>\r
44 <simpara>\r
45 Prints the capabilities of the helper, one per line. These are:\r
46 </simpara>\r
47 <itemizedlist>\r
48 <listitem>\r
49 <simpara>\r
50 import: the basic import command\r
51 </simpara>\r
52 </listitem>\r
53 <listitem>\r
54 <simpara>\r
55 marks: import should be done with a saved marks file\r
56 </simpara>\r
57 </listitem>\r
58 <listitem>\r
59 <simpara>\r
60 find-new-branches: detect new branches\r
61 </simpara>\r
62 </listitem>\r
63 <listitem>\r
64 <simpara>\r
65 export: the general export command\r
66 </simpara>\r
67 </listitem>\r
68 <listitem>\r
69 <simpara>\r
70 fork: create a new branch and export to it\r
71 </simpara>\r
72 </listitem>\r
73 <listitem>\r
74 <simpara>\r
75 anonymous-fork: make commits on a branch without an inherent name\r
76 </simpara>\r
77 </listitem>\r
78 <listitem>\r
79 <simpara>\r
80 merge: merge branches (of whatever type the system supports)\r
81 </simpara>\r
82 <literallayout class="monospaced">If the helper doesn't support "merge", the default for pull is\r
83 to rebase instead of merging.</literallayout>\r
84 </listitem>\r
85 </itemizedlist>\r
86 </listitem>\r
87 </varlistentry>\r
88 <varlistentry>\r
89 <term>\r
90 <emphasis>list</emphasis>\r
91 </term>\r
92 <listitem>\r
93 <simpara>\r
94 Takes the remote name, and outputs the names of refs. These\r
95 may be followed, after a single space, by "changed" or\r
96 "unchanged", indicating whether the foreign repository has\r
97 changed from the state in the ref. If the helper doesn’t know,\r
98 it doesn’t have to provide a value. (In particular, it\r
99 shouldn’t do expensive operations, such as importing the\r
100 content, to see whether it matches.)\r
101 </simpara>\r
102 </listitem>\r
103 </varlistentry>\r
104 <varlistentry>\r
105 <term>\r
106 <emphasis>import</emphasis>\r
107 </term>\r
108 <listitem>\r
109 <simpara>\r
110 Takes the remote name and a list of names of refs, and imports\r
111 whatever it describes, by outputting it in git-fast-import\r
112 format.\r
113 </simpara>\r
114 </listitem>\r
115 </varlistentry>\r
116 <varlistentry>\r
117 <term>\r
118 <emphasis>export</emphasis>\r
119 </term>\r
120 <listitem>\r
121 <simpara>\r
122 Sends the branch to the foreign system and reimports it in\r
123 fast-import format.\r
124 </simpara>\r
125 <literallayout class="monospaced">Reads a list of commits from stdin, where each commit has no\r
126 parents which were neither produced by an earlier import nor\r
127 appearing earlier in the list, where some commit has the old\r
128 value of the branch as a parent, and where all commits listed\r
129 are ancestors of the last one. Furthermore:</literallayout>\r
130 <itemizedlist>\r
131 <listitem>\r
132 <simpara>\r
133 if the system doesn’t support merges, each of these commits\r
134 has only a single parent;\r
135 </simpara>\r
136 </listitem>\r
137 <listitem>\r
138 <simpara>\r
139 if the system doesn’t support anonymous branches, the first\r
140 commit has the old value of the branch as a parent (if the\r
141 branch already had a value), and all parents are either the\r
142 commit listed immediately before or produced by an earlier\r
143 import;\r
144 </simpara>\r
145 </listitem>\r
146 <listitem>\r
147 <simpara>\r
148 if the system doesn’t support many-way merges, each commit\r
149 has at most two parents.\r
150 </simpara>\r
151 <literallayout class="monospaced">export produces output in fast-import format giving the\r
152 content after a round-trip through the foreign system. This\r
153 also contains extra headers to report the mapping of original\r
154 git commits to reimported git commits (to facilitate rewriting\r
155 local branches to use the history-as-reimported instead of the\r
156 git-only version).</literallayout>\r
157 <literallayout class="monospaced">export reports how much it managed to export by producing\r
158 commits in the fast-import stream that replace the listed\r
159 items that were successfully exported.</literallayout>\r
160 </listitem>\r
161 </itemizedlist>\r
162 </listitem>\r
163 </varlistentry>\r
164 </variablelist>\r
165 </simplesect>\r
166 </article>\r