Skip to content

Commit d43427d

Browse files
artagnongitster
authored andcommitted
Documentation/remote-helpers: Fix typos and improve language
Fix some typos and errors in grammar and tense. Signed-off-by: Ramkumar Ramachandra <[email protected]> Acked-by: Sverre Rabbelier <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 272a36b commit d43427d

File tree

1 file changed

+23
-28
lines changed

1 file changed

+23
-28
lines changed

Documentation/git-remote-helpers.txt

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ Commands are given by the caller on the helper's standard input, one per line.
7474

7575
'capabilities'::
7676
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
7979
helper to understand (unknown mandatory capability is fatal
8080
error).
8181

@@ -84,27 +84,27 @@ Commands are given by the caller on the helper's standard input, one per line.
8484
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
8585
a symref, or "?" to indicate that the helper could not get the
8686
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.
8989
+
9090
If 'push' is supported this may be called as 'list for-push'
9191
to obtain the current refs prior to sending one or more 'push'
9292
commands to the helper.
9393

9494
'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
9696
single line containing one of 'ok' (option successfully set),
9797
'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
9999
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.
101101
+
102102
Supported if the helper has the "option" capability.
103103

104104
'fetch' <sha1> <name>::
105105
Fetches the given object, writing the necessary objects
106106
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.
108108
Outputs a single blank line when all fetch commands in the
109109
same batch are complete. Only objects which were reported
110110
in the ref list with a sha1 may be fetched this way.
@@ -116,7 +116,7 @@ suitably updated.
116116
Supported if the helper has the "fetch" capability.
117117

118118
'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
120120
remote branch described by <dst>. A batch sequence of
121121
one or more push commands is terminated with a blank line.
122122
+
@@ -140,6 +140,9 @@ Supported if the helper has the "push" capability.
140140
by applying the refspecs from the "refspec" capability to the
141141
name of the ref.
142142
+
143+
Especially useful for interoperability with a foreign versioning
144+
system.
145+
+
143146
Supported if the helper has the "import" capability.
144147

145148
'connect' <service>::
@@ -168,16 +171,11 @@ CAPABILITIES
168171
------------
169172

170173
'fetch'::
171-
This helper supports the 'fetch' command.
172-
173174
'option'::
174-
This helper supports the option command.
175-
176175
'push'::
177-
This helper supports the 'push' command.
178-
179176
'import'::
180-
This helper supports the 'import' command.
177+
'connect'::
178+
This helper supports the corresponding command with the same name.
181179

182180
'refspec' 'spec'::
183181
When using the import command, expect the source ref to have
@@ -189,9 +187,6 @@ CAPABILITIES
189187
all, it must cover all refs reported by the list command; if
190188
it is not used, it is effectively "*:*"
191189

192-
'connect'::
193-
This helper supports the 'connect' command.
194-
195190
REF LIST ATTRIBUTES
196191
-------------------
197192

@@ -207,19 +202,19 @@ REF LIST ATTRIBUTES
207202
OPTIONS
208203
-------
209204
'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
214209
of N correspond to the number of -v flags passed on the
215210
command line.
216211

217212
'option progress' \{'true'|'false'\}::
218-
Enable (or disable) progress messages displayed by the
213+
Enables (or disables) progress messages displayed by the
219214
transport helper during a command.
220215

221216
'option depth' <depth>::
222-
Deepen the history of a shallow repository.
217+
Deepens the history of a shallow repository.
223218

224219
'option followtags' \{'true'|'false'\}::
225220
If enabled the helper should automatically fetch annotated
@@ -235,9 +230,9 @@ OPTIONS
235230
helpers this only applies to the 'push', if supported.
236231

237232
'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
241236
connect request occurs.
242237

243238
SEE ALSO

0 commit comments

Comments
 (0)