Documentation/remote-helpers: Fix typos and improve language
Fix some typos and errors in grammar and tense. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ramkumar Ramachandra committed
Apr 18, 2010 at 06:27 UTC
d43427d3d9134524d3ebbe176e30cea38f2a0818
1 file changed
+23
-28
Documentation/git-remote-helpers.txt
+23
-28
@@ -74,8 +74,8 @@ Commands are given by the caller on the helper's standard input, one per line.
74
75
'capabilities'::
76
Lists the capabilities of the helper, one per line, ending
77
- with a blank line. Each capability may be preceded with '*'.
78
- This marks them mandatory for git version using the remote
77
+ with a blank line. Each capability may be preceded with '*',
78
+ which marks them mandatory for git version using the remote
79
helper to understand (unknown mandatory capability is fatal
80
error).
81
@@ -84,27 +84,27 @@ Commands are given by the caller on the helper's standard input, one per line.
84
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
85
a symref, or "?" to indicate that the helper could not get the
86
value of the ref. A space-separated list of attributes follows
87
- the name; unrecognized attributes are ignored. After the
88
- complete list, outputs a blank line.
87
+ the name; unrecognized attributes are ignored. The list ends
88
+ with a blank line.
89
+
90
If 'push' is supported this may be called as 'list for-push'
91
to obtain the current refs prior to sending one or more 'push'
92
commands to the helper.
93
94
'option' <name> <value>::
95
- Set the transport helper option <name> to <value>. Outputs a
95
+ Sets the transport helper option <name> to <value>. Outputs a
96
single line containing one of 'ok' (option successfully set),
97
'unsupported' (option not recognized) or 'error <msg>'
98
- (option <name> is supported but <value> is not correct
98
+ (option <name> is supported but <value> is not valid
99
for it). Options should be set before other commands,
100
- and may how those commands behave.
100
+ and may influence the behavior of those commands.
101
+
102
Supported if the helper has the "option" capability.
103
104
'fetch' <sha1> <name>::
105
Fetches the given object, writing the necessary objects
106
to the database. Fetch commands are sent in a batch, one
107
- per line, and the batch is terminated with a blank line.
107
+ per line, terminated with a blank line.
108
Outputs a single blank line when all fetch commands in the
109
same batch are complete. Only objects which were reported
110
in the ref list with a sha1 may be fetched this way.
@@ -116,7 +116,7 @@ suitably updated.
116
Supported if the helper has the "fetch" capability.
117
118
'push' +<src>:<dst>::
119
- Pushes the given <src> commit or branch locally to the
119
+ Pushes the given local <src> commit or branch to the
120
remote branch described by <dst>. A batch sequence of
121
one or more push commands is terminated with a blank line.
122
+
@@ -140,6 +140,9 @@ Supported if the helper has the "push" capability.
140
by applying the refspecs from the "refspec" capability to the
141
name of the ref.
142
+
143
+Especially useful for interoperability with a foreign versioning
144
+system.
145
++
146
Supported if the helper has the "import" capability.
147
148
'connect' <service>::
@@ -168,16 +171,11 @@ CAPABILITIES
171
------------
172
173
'fetch'::
171
- This helper supports the 'fetch' command.
172
-
174
'option'::
174
- This helper supports the option command.
175
-
175
'push'::
177
- This helper supports the 'push' command.
178
-
176
'import'::
180
- This helper supports the 'import' command.
177
+'connect'::
178
+ This helper supports the corresponding command with the same name.
179
180
'refspec' 'spec'::
181
When using the import command, expect the source ref to have
@@ -189,9 +187,6 @@ CAPABILITIES
187
all, it must cover all refs reported by the list command; if
188
it is not used, it is effectively "*:*"
189
192
-'connect'::
193
- This helper supports the 'connect' command.
194
-
190
REF LIST ATTRIBUTES
191
-------------------
192
@@ -207,19 +202,19 @@ REF LIST ATTRIBUTES
202
OPTIONS
203
-------
204
'option verbosity' <N>::
210
- Change the level of messages displayed by the helper.
211
- When N is 0 the end-user has asked the process to be
212
- quiet, and the helper should produce only error output.
213
- N of 1 is the default level of verbosity, higher values
205
+ Changes the verbosity of messages displayed by the helper.
206
+ A value of 0 for N means that processes operate
207
+ quietly, and the helper produces only error output.
208
+ 1 is the default level of verbosity, and higher values
209
of N correspond to the number of -v flags passed on the
210
command line.
211
212
'option progress' \{'true'|'false'\}::
218
- Enable (or disable) progress messages displayed by the
213
+ Enables (or disables) progress messages displayed by the
214
transport helper during a command.
215
216
'option depth' <depth>::
222
- Deepen the history of a shallow repository.
217
+ Deepens the history of a shallow repository.
218
219
'option followtags' \{'true'|'false'\}::
220
If enabled the helper should automatically fetch annotated
@@ -235,9 +230,9 @@ OPTIONS
230
helpers this only applies to the 'push', if supported.
231
232
'option servpath <c-style-quoted-path>'::
238
- Set service path (--upload-pack, --receive-pack etc.) for
239
- next connect. Remote helper MAY support this option. Remote
240
- helper MUST NOT rely on this option being set before
233
+ Sets service path (--upload-pack, --receive-pack etc.) for
234
+ next connect. Remote helper may support this option, but
235
+ must not rely on this option being set before
236
connect request occurs.
237
238
SEE ALSO