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>

diff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt
index 2dd70031cb4fcb9401be30d68632ddca17c66bed..3a23477ce72763b562258a25c3777dd57ac1a962 100644 (file)
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -74,8 +74,8 @@ Commands are given by the caller on the helper's standard input, one per line.
 
 'capabilities'::
        Lists the capabilities of the helper, one per line, ending
 
 'capabilities'::
        Lists the capabilities of the helper, one per line, ending

-       with a blank line. Each capability may be preceded with '*'.
-       This marks them mandatory for git version using the remote
+       with a blank line. Each capability may be preceded with '*',
+       which marks them mandatory for git version using the remote

        helper to understand (unknown mandatory capability is fatal
        error).
 
        helper to understand (unknown mandatory capability is fatal
        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
        a symref, or "?" to indicate that the helper could not get the
        value of the ref. A space-separated list of attributes follows
        [<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
        a symref, or "?" to indicate that the helper could not get the
        value of the ref. A space-separated list of attributes follows

-       the name; unrecognized attributes are ignored. After the
-       complete list, outputs a blank line.
+       the name; unrecognized attributes are ignored. The list ends
+       with a blank line.

 +
 If 'push' is supported this may be called as 'list for-push'
 to obtain the current refs prior to sending one or more 'push'
 commands to the helper.
 
 'option' <name> <value>::
 +
 If 'push' is supported this may be called as 'list for-push'
 to obtain the current refs prior to sending one or more 'push'
 commands to the helper.
 
 '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),
        'unsupported' (option not recognized) or 'error <msg>'
        single line containing one of 'ok' (option successfully set),
        '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.
 
 'fetch' <sha1> <name>::
        Fetches the given object, writing the necessary objects
        to the database.  Fetch commands are sent in a batch, one
 +
 Supported if the helper has the "option" capability.
 
 'fetch' <sha1> <name>::
        Fetches the given object, writing the necessary objects
        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
        same batch are complete. Only objects which were reported
        in the ref list with a sha1 may be fetched this way.
        Outputs a single blank line when all fetch commands in the
        same batch are complete. Only objects which were reported
        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.
 
 'push' +<src>:<dst>::
 Supported if the helper has the "fetch" capability.
 
 '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
        one or more push commands is terminated with a blank line.
 +
        remote branch described by <dst>.  A batch sequence of
        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
        name of the ref.
 +
        by applying the refspecs from the "refspec" capability to the
        name of the ref.
 +

+Especially useful for interoperability with a foreign versioning
+system.
++

 Supported if the helper has the "import" capability.
 
 'connect' <service>::
 Supported if the helper has the "import" capability.
 
 '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'::
        When using the import command, expect the source ref to have
 
 'refspec' 'spec'::
        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
        it is not used, it is effectively "*:*"
 
        all, it must cover all refs reported by the list command; if
        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
 -------
 'option verbosity' <N>::
 OPTIONS
 -------
 'option verbosity' <N>::

-       Change the level of messages displayed by the helper.
-       When N is 0 the end-user has asked the process to be
-       quiet, and the helper should produce only error output.
-       N of 1 is the default level of verbosity, higher values
+       Changes the verbosity of messages displayed by the helper.
+       A value of 0 for N means that processes operate
+       quietly, and the helper produces only error output.
+       1 is the default level of verbosity, and higher values

        of N correspond to the number of -v flags passed on the
        command line.
 
 'option progress' \{'true'|'false'\}::
        of N correspond to the number of -v flags passed on the
        command line.
 
 '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.
 
 'option depth' <depth>::
        transport helper during a command.
 
 'option depth' <depth>::

-       Deepen the history of a shallow repository.
+       Deepens the history of a shallow repository.

 
 'option followtags' \{'true'|'false'\}::
        If enabled the helper should automatically fetch annotated
 
 'option followtags' \{'true'|'false'\}::
        If enabled the helper should automatically fetch annotated


@@ -235,9 +230,9 @@ OPTIONS
        helpers this only applies to the 'push', if supported.
 
 'option servpath <c-style-quoted-path>'::
        helpers this only applies to the 'push', if supported.
 
 'option servpath <c-style-quoted-path>'::

-       Set service path (--upload-pack, --receive-pack etc.) for
-       next connect. Remote helper MAY support this option. Remote
-       helper MUST NOT rely on this option being set before
+       Sets service path (--upload-pack, --receive-pack etc.) for
+       next connect. Remote helper may support this option, but
+       must not rely on this option being set before

        connect request occurs.
 
 SEE ALSO
        connect request occurs.
 
 SEE ALSO