Skip to content

Commit b4b106e

Browse files
fingolfingitster
authored andcommitted
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 <[email protected]> Acked-by: Sverre Rabbelier <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent f829a9e commit b4b106e

File tree

1 file changed

+42
-3
lines changed

1 file changed

+42
-3
lines changed

Documentation/git-remote-helpers.txt

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,10 @@ to the `capabilities` command (see COMMANDS, below).
106106
For listing remote refs and fetching the associated history to
107107
the local object store.
108108

109+
'export'::
110+
For listing remote refs and pushing specified objects from a
111+
fast-import stream to remote refs.
112+
109113
'import'::
110114
For listing remote refs and fetching the associated history as
111115
a fast-import stream.
@@ -143,6 +147,16 @@ there is an implied `refspec *:*`.
143147
This is to prevent mixing commands and fast-import responses on the
144148
helper's stdin.
145149

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+
146160
Capabilities for Pushing
147161
~~~~~~~~~~~~~~~~~~~~~~~~
148162
'connect'::
@@ -158,9 +172,18 @@ Supported commands: 'connect'.
158172
+
159173
Supported commands: 'list for-push', 'push'.
160174

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+
164187

165188
Capabilities for Fetching
166189
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -307,6 +330,22 @@ stdin.
307330
+
308331
Supported if the helper has the 'import' capability.
309332

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+
310349
'connect' <service>::
311350
Connects to given service. Standard input and standard output
312351
of helper are connected to specified service (git prefix is

0 commit comments

Comments
 (0)