git-remote-helpers.txt: document missing capabilities
Specifically, document the 'export' and '(im|ex)port-marks' capabilities as well as the export command, which were undocumented (but in active use). Signed-off-by: Max Horn <max@quendi.de> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Max Horn committed
Nov 28, 2012 at 00:03 UTC
b4b106e5a5afacb45cea08d18a241b3d7d609d91
1 file changed
+42
-3
Documentation/git-remote-helpers.txt
+42
-3
@@ -106,6 +106,10 @@ to the `capabilities` command (see COMMANDS, below).
106
For listing remote refs and fetching the associated history to
107
the local object store.
108
109
+'export'::
110
+ For listing remote refs and pushing specified objects from a
111
+ fast-import stream to remote refs.
112
+
113
'import'::
114
For listing remote refs and fetching the associated history as
115
a fast-import stream.
@@ -143,6 +147,16 @@ there is an implied `refspec *:*`.
147
This is to prevent mixing commands and fast-import responses on the
148
helper's stdin.
149
150
+'export-marks' <file>::
151
+ This modifies the 'export' capability, instructing git to dump the
152
+ internal marks table to <file> when complete. For details,
153
+ read up on '--export-marks=<file>' in linkgit:git-fast-export[1].
154
+
155
+'import-marks' <file>::
156
+ This modifies the 'export' capability, instructing git to load the
157
+ marks specified in <file> before processing any input. For details,
158
+ read up on '--import-marks=<file>' in linkgit:git-fast-export[1].
159
+
160
Capabilities for Pushing
161
~~~~~~~~~~~~~~~~~~~~~~~~
162
'connect'::
@@ -158,9 +172,18 @@ Supported commands: 'connect'.
172
+
173
Supported commands: 'list for-push', 'push'.
174
161
-If a helper advertises both 'connect' and 'push', git will use
162
-'connect' if possible and fall back to 'push' if the helper requests
163
-so when connecting (see the 'connect' command under COMMANDS).
175
+'export'::
176
+ Can discover remote refs and push specified objects from a
177
+ fast-import stream to remote refs.
178
++
179
+Supported commands: 'list for-push', 'export'.
180
+
181
+If a helper advertises 'connect', git will use it if possible and
182
+fall back to another capability if the helper requests so when
183
+connecting (see the 'connect' command under COMMANDS).
184
+When choosing between 'push' and 'export', git prefers 'push'.
185
+Other frontends may have some other order of preference.
186
+
187
188
Capabilities for Fetching
189
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -307,6 +330,22 @@ stdin.
330
+
331
Supported if the helper has the 'import' capability.
332
333
+'export'::
334
+ Instructs the remote helper that any subsequent input is
335
+ part of a fast-import stream (generated by 'git fast-export')
336
+ containing objects which should be pushed to the remote.
337
++
338
+Especially useful for interoperability with a foreign versioning
339
+system.
340
++
341
+The 'export-marks' and 'import-marks' capabilities, if specified,
342
+affect this command in so far as they are passed on to 'git
343
+fast-export', which then will load/store a table of marks for
344
+local objects. This can be used to implement for incremental
345
+operations.
346
++
347
+Supported if the helper has the 'export' capability.
348
+
349
'connect' <service>::
350
Connects to given service. Standard input and standard output
351
of helper are connected to specified service (git prefix is