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>
This commit is contained in:
Ramkumar Ramachandra 2010-04-18 06:27:37 +05:30 committed by Junio C Hamano
parent 272a36b67b
commit d43427d3d9

View file

@ -74,8 +74,8 @@ Commands are given by the caller on the helper's standard input, one per line.
'capabilities':: 'capabilities'::
Lists the capabilities of the helper, one per line, ending Lists the capabilities of the helper, one per line, ending
with a blank line. Each capability may be preceded with '*'. with a blank line. Each capability may be preceded with '*',
This marks them mandatory for git version using the remote which marks them mandatory for git version using the remote
helper to understand (unknown mandatory capability is fatal helper to understand (unknown mandatory capability is fatal
error). error).
@ -84,27 +84,27 @@ Commands are given by the caller on the helper's standard input, one per line.
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for [<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
a symref, or "?" to indicate that the helper could not get the a symref, or "?" to indicate that the helper could not get the
value of the ref. A space-separated list of attributes follows value of the ref. A space-separated list of attributes follows
the name; unrecognized attributes are ignored. After the the name; unrecognized attributes are ignored. The list ends
complete list, outputs a blank line. with a blank line.
+ +
If 'push' is supported this may be called as 'list for-push' If 'push' is supported this may be called as 'list for-push'
to obtain the current refs prior to sending one or more 'push' to obtain the current refs prior to sending one or more 'push'
commands to the helper. commands to the helper.
'option' <name> <value>:: 'option' <name> <value>::
Set the transport helper option <name> to <value>. Outputs a Sets the transport helper option <name> to <value>. Outputs a
single line containing one of 'ok' (option successfully set), single line containing one of 'ok' (option successfully set),
'unsupported' (option not recognized) or 'error <msg>' 'unsupported' (option not recognized) or 'error <msg>'
(option <name> is supported but <value> is not correct (option <name> is supported but <value> is not valid
for it). Options should be set before other commands, for it). Options should be set before other commands,
and may how those commands behave. and may influence the behavior of those commands.
+ +
Supported if the helper has the "option" capability. Supported if the helper has the "option" capability.
'fetch' <sha1> <name>:: 'fetch' <sha1> <name>::
Fetches the given object, writing the necessary objects Fetches the given object, writing the necessary objects
to the database. Fetch commands are sent in a batch, one to the database. Fetch commands are sent in a batch, one
per line, and the batch is terminated with a blank line. per line, terminated with a blank line.
Outputs a single blank line when all fetch commands in the Outputs a single blank line when all fetch commands in the
same batch are complete. Only objects which were reported same batch are complete. Only objects which were reported
in the ref list with a sha1 may be fetched this way. in the ref list with a sha1 may be fetched this way.
@ -116,7 +116,7 @@ suitably updated.
Supported if the helper has the "fetch" capability. Supported if the helper has the "fetch" capability.
'push' +<src>:<dst>:: 'push' +<src>:<dst>::
Pushes the given <src> commit or branch locally to the Pushes the given local <src> commit or branch to the
remote branch described by <dst>. A batch sequence of remote branch described by <dst>. A batch sequence of
one or more push commands is terminated with a blank line. one or more push commands is terminated with a blank line.
+ +
@ -140,6 +140,9 @@ Supported if the helper has the "push" capability.
by applying the refspecs from the "refspec" capability to the by applying the refspecs from the "refspec" capability to the
name of the ref. name of the ref.
+ +
Especially useful for interoperability with a foreign versioning
system.
+
Supported if the helper has the "import" capability. Supported if the helper has the "import" capability.
'connect' <service>:: 'connect' <service>::
@ -168,16 +171,11 @@ CAPABILITIES
------------ ------------
'fetch':: 'fetch'::
This helper supports the 'fetch' command.
'option':: 'option'::
This helper supports the option command.
'push':: 'push'::
This helper supports the 'push' command.
'import':: 'import'::
This helper supports the 'import' command. 'connect'::
This helper supports the corresponding command with the same name.
'refspec' 'spec':: 'refspec' 'spec'::
When using the import command, expect the source ref to have When using the import command, expect the source ref to have
@ -189,9 +187,6 @@ CAPABILITIES
all, it must cover all refs reported by the list command; if all, it must cover all refs reported by the list command; if
it is not used, it is effectively "*:*" it is not used, it is effectively "*:*"
'connect'::
This helper supports the 'connect' command.
REF LIST ATTRIBUTES REF LIST ATTRIBUTES
------------------- -------------------
@ -207,19 +202,19 @@ REF LIST ATTRIBUTES
OPTIONS OPTIONS
------- -------
'option verbosity' <N>:: 'option verbosity' <N>::
Change the level of messages displayed by the helper. Changes the verbosity of messages displayed by the helper.
When N is 0 the end-user has asked the process to be A value of 0 for N means that processes operate
quiet, and the helper should produce only error output. quietly, and the helper produces only error output.
N of 1 is the default level of verbosity, higher values 1 is the default level of verbosity, and higher values
of N correspond to the number of -v flags passed on the of N correspond to the number of -v flags passed on the
command line. command line.
'option progress' \{'true'|'false'\}:: 'option progress' \{'true'|'false'\}::
Enable (or disable) progress messages displayed by the Enables (or disables) progress messages displayed by the
transport helper during a command. transport helper during a command.
'option depth' <depth>:: 'option depth' <depth>::
Deepen the history of a shallow repository. Deepens the history of a shallow repository.
'option followtags' \{'true'|'false'\}:: 'option followtags' \{'true'|'false'\}::
If enabled the helper should automatically fetch annotated If enabled the helper should automatically fetch annotated
@ -235,9 +230,9 @@ OPTIONS
helpers this only applies to the 'push', if supported. helpers this only applies to the 'push', if supported.
'option servpath <c-style-quoted-path>':: 'option servpath <c-style-quoted-path>'::
Set service path (--upload-pack, --receive-pack etc.) for Sets service path (--upload-pack, --receive-pack etc.) for
next connect. Remote helper MAY support this option. Remote next connect. Remote helper may support this option, but
helper MUST NOT rely on this option being set before must not rely on this option being set before
connect request occurs. connect request occurs.
SEE ALSO SEE ALSO