{"thread":{"id":"23217","subject":"[PATCH 2/2] Documentation/remote-helpers: Fix some typos","startedAt":"2010-03-28T18:04:55Z","lastAt":"2010-04-06T02:46:43Z","messageCount":3,"participants":["Ramkumar Ramachandra","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"138029","messageId":"f3271551003281104h9b672abk1a8ecccd7a4f8964@mail.gmail.com","threadId":"23217","inReplyTo":null,"subject":"[PATCH 2/2] Documentation/remote-helpers: Fix some typos","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-03-28T18:04:55Z","receivedAt":"2010-03-28T18:04:55Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Fix some typos.\n\n---\n Documentation/git-remote-helpers.txt |   57 +++++++++++++++------------------\n 1 files changed, 26 insertions(+), 31 deletions(-)\n\ndiff --git a/Documentation/git-remote-helpers.txt\nb/Documentation/git-remote-helpers.txt\nindex 1304813..2382fb4 100644\n--- a/Documentation/git-remote-helpers.txt\n+++ b/Documentation/git-remote-helpers.txt\n@@ -45,8 +45,8 @@ Commands are given by the caller on the helper's\nstandard input, one per line.\n\n 'capabilities'::\n \tLists the capabilities of the helper, one per line, ending\n-\twith a blank line. Each capability may be preceded with '*'.\n-\tThis marks them mandatory for git version using the remote\n+\twith a blank line. Each capability may be preceded with '*',\n+\twhich marks them mandatory for git version using the remote\n \thelper to understand (unknown mandatory capability is fatal\n \terror).\n\n@@ -55,27 +55,27 @@ Commands are given by the caller on the helper's\nstandard input, one per line.\n \t[<attr> ...]\". The value may be a hex sha1 hash, \"@<dest>\" for\n \ta symref, or \"?\" to indicate that the helper could not get the\n \tvalue of the ref. A space-separated list of attributes follows\n-\tthe name; unrecognized attributes are ignored. After the\n-\tcomplete list, outputs a blank line.\n+\tthe name; unrecognized attributes are ignored. The list ends\n+\twith a blank line.\n +\n If 'push' is supported this may be called as 'list for-push'\n to obtain the current refs prior to sending one or more 'push'\n commands to the helper.\n\n 'option' <name> <value>::\n-\tSet the transport helper option <name> to <value>.  Outputs a\n+\tSets the transport helper option <name> to <value>.  Outputs a\n \tsingle line containing one of 'ok' (option successfully set),\n \t'unsupported' (option not recognized) or 'error <msg>'\n-\t(option <name> is supported but <value> is not correct\n+\t(option <name> is supported but <value> is not valid\n \tfor it).  Options should be set before other commands,\n-\tand may how those commands behave.\n+\tand may influence the behavior of those commands.\n +\n Supported if the helper has the \"option\" capability.\n\n 'fetch' <sha1> <name>::\n \tFetches the given object, writing the necessary objects\n \tto the database.  Fetch commands are sent in a batch, one\n-\tper line, and the batch is terminated with a blank line.\n+\tper line, terminated with a blank line.\n \tOutputs a single blank line when all fetch commands in the\n \tsame batch are complete. Only objects which were reported\n \tin the ref list with a sha1 may be fetched this way.\n@@ -87,7 +87,7 @@ suitably updated.\n Supported if the helper has the \"fetch\" capability.\n\n 'push' +<src>:<dst>::\n-\tPushes the given <src> commit or branch locally to the\n+\tPushes the given local <src> commit or branch to the\n \tremote branch described by <dst>.  A batch sequence of\n \tone or more push commands is terminated with a blank line.\n +\n@@ -111,6 +111,9 @@ Supported if the helper has the \"push\" capability.\n \tby applying the refspecs from the \"refspec\" capability to the\n \tname of the ref.\n +\n+Especially useful for interoperability with a foreign versioning\n+system.\n++\n Supported if the helper has the \"import\" capability.\n\n 'connect' <service>::\n@@ -128,9 +131,9 @@ Supported if the helper has the \"import\" capability.\n Supported if the helper has the \"connect\" capability.\n\n If a fatal error occurs, the program writes the error message to\n-stderr and exits. The caller should expect that a suitable error\n-message has been printed if the child closes the connection without\n-completing a valid response for the current command.\n+stderr and exits. The caller should expect a suitable error\n+if the child closes the connection without\n+giving a valid response for the current command.\n\n Additional commands may be supported, as may be determined from\n capabilities reported by the helper.\n@@ -139,16 +142,11 @@ CAPABILITIES\n ------------\n\n 'fetch'::\n-\tThis helper supports the 'fetch' command.\n-\n 'option'::\n-\tThis helper supports the option command.\n-\n 'push'::\n-\tThis helper supports the 'push' command.\n-\n 'import'::\n-\tThis helper supports the 'import' command.\n+'connect'::\n+\tThis helper supports the corresponding command with the same name.\n\n 'refspec' 'spec'::\n \tWhen using the import command, expect the source ref to have\n@@ -160,9 +158,6 @@ CAPABILITIES\n \tall, it must cover all refs reported by the list command; if\n \tit is not used, it is effectively \"*:*\"\n\n-'connect'::\n-\tThis helper supports the 'connect' command.\n-\n REF LIST ATTRIBUTES\n -------------------\n\n@@ -178,19 +173,19 @@ REF LIST ATTRIBUTES\n OPTIONS\n -------\n 'option verbosity' <N>::\n-\tChange the level of messages displayed by the helper.\n-\tWhen N is 0 the end-user has asked the process to be\n-\tquiet, and the helper should produce only error output.\n-\tN of 1 is the default level of verbosity, higher values\n+\tChanges the verbosity of messages displayed by the helper.\n+\tA value of 0 for N means that processes operate\n+\tquietly, and the helper produces only error output.\n+\t1 is the default level of verbosity, and higher values\n \tof N correspond to the number of -v flags passed on the\n \tcommand line.\n\n 'option progress' \\{'true'|'false'\\}::\n-\tEnable (or disable) progress messages displayed by the\n+\tEnables (or disables) progress messages displayed by the\n \ttransport helper during a command.\n\n 'option depth' <depth>::\n-\tDeepen the history of a shallow repository.\n+\tDeepens the history of a shallow repository.\n\n 'option followtags' \\{'true'|'false'\\}::\n \tIf enabled the helper should automatically fetch annotated\n@@ -206,9 +201,9 @@ OPTIONS\n \thelpers this only applies to the 'push', if supported.\n\n 'option servpath <c-style-quoted-path>'::\n-\tSet service path (--upload-pack, --receive-pack etc.) for\n-\tnext connect. Remote helper MAY support this option. Remote\n-\thelper MUST NOT rely on this option being set before\n+\tSets service path (--upload-pack, --receive-pack etc.) for\n+\tnext connect. Remote helper may support this option, but\n+\tmust not rely on this option being set before\n \tconnect request occurs.\n\n Documentation\n-- \n1.7.0.3\n"},{"id":"138677","messageId":"7vpr2dmu9y.fsf@alter.siamese.dyndns.org","threadId":"23217","inReplyTo":"f3271551003281104h9b672abk1a8ecccd7a4f8964@mail.gmail.com","subject":"Re: [PATCH 2/2] Documentation/remote-helpers: Fix some typos","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2010-04-05T22:03:37Z","receivedAt":"2010-04-05T22:03:37Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ramkumar Ramachandra <artagnon@gmail.com> writes:\n\n> @@ -128,9 +131,9 @@ Supported if the helper has the \"import\" capability.\n>  Supported if the helper has the \"connect\" capability.\n>\n>  If a fatal error occurs, the program writes the error message to\n> -stderr and exits. The caller should expect that a suitable error\n> -message has been printed if the child closes the connection without\n> -completing a valid response for the current command.\n> +stderr and exits. The caller should expect a suitable error\n> +if the child closes the connection without\n> +giving a valid response for the current command.\n\nThis not just fixes typo but changes what is being said, doesn't it?  The\npoint of the original about the \"error\" is that the caller does not have\nto issue a redundant error message when the helper closes the connection\nwithout reporting the status back, but that information which probably is\ncritical when maintaining the caller (and writing a new callee) is lost.\n\nOther parts looked Ok to me.\n\nThanks.\n"},{"id":"138696","messageId":"i2vf3271551004051946i26856d58lb5d093a5656c3953@mail.gmail.com","threadId":"23217","inReplyTo":"7vpr2dmu9y.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH 2/2] Documentation/remote-helpers: Fix some typos","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-04-06T02:46:43Z","receivedAt":"2010-04-06T02:46:43Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"On Tue, Apr 6, 2010 at 3:33 AM, Junio C Hamano <gitster@pobox.com> wrote:\n> This not just fixes typo but changes what is being said, doesn't it?  The\n> point of the original about the \"error\" is that the caller does not have\n> to issue a redundant error message when the helper closes the connection\n> without reporting the status back, but that information which probably is\n> critical when maintaining the caller (and writing a new callee) is lost.\n\nYes, I think you're right. Kindly revert this hunk.\n\n-- Ram\n"}]}