Add support for "import" helper command
[git/git.git] / Documentation / git-remote-helpers.txt
CommitLineData
6eb996b5
DB
1git-remote-helpers(1)
2=====================
3
4NAME
5----
6git-remote-helpers - Helper programs for interoperation with remote git
7
8SYNOPSIS
9--------
10'git remote-<transport>' <remote>
11
12DESCRIPTION
13-----------
14
15These programs are normally not used directly by end users, but are
16invoked by various git programs that interact with remote repositories
17when the repository they would operate on will be accessed using
18transport code not linked into the main git binary. Various particular
19helper programs will behave as documented here.
20
21COMMANDS
22--------
23
24Commands are given by the caller on the helper's standard input, one per line.
25
26'capabilities'::
27 Lists the capabilities of the helper, one per line, ending
28 with a blank line.
29
30'list'::
31 Lists the refs, one per line, in the format "<value> <name>
32 [<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
33 a symref, or "?" to indicate that the helper could not get the
34 value of the ref. A space-separated list of attributes follows
35 the name; unrecognized attributes are ignored. After the
36 complete list, outputs a blank line.
37
38'fetch' <sha1> <name>::
39 Fetches the given object, writing the necessary objects to the
40 database. Outputs a blank line when the fetch is
41 complete. Only objects which were reported in the ref list
42 with a sha1 may be fetched this way.
43+
44Supported if the helper has the "fetch" capability.
45
e65e91ed
DB
46'import' <name>::
47 Produces a fast-import stream which imports the current value
48 of the named ref. It may additionally import other refs as
49 needed to construct the history efficiently.
50+
51Supported if the helper has the "import" capability.
52
6eb996b5
DB
53If a fatal error occurs, the program writes the error message to
54stderr and exits. The caller should expect that a suitable error
55message has been printed if the child closes the connection without
56completing a valid response for the current command.
57
58Additional commands may be supported, as may be determined from
59capabilities reported by the helper.
60
61CAPABILITIES
62------------
63
64'fetch'::
65 This helper supports the 'fetch' command.
66
e65e91ed
DB
67'import'::
68 This helper supports the 'import' command.
69
6eb996b5
DB
70REF LIST ATTRIBUTES
71-------------------
72
73None are defined yet, but the caller must accept any which are supplied.
74
75Documentation
76-------------
77Documentation by Daniel Barkalow.
78
79GIT
80---
81Part of the linkgit:git[1] suite