Re: [PATCH] config: document value 2 for protocol.version

From: Jonathan Nieder <jrnieder@gmail.com>
Date: May 22, 2018, 22:32 UTC
Message-ID: <20180522223208.GQ10623@aiede.svl.corp.google.com>
In-Reply-To: <20180522222718.81173-1-bmwill@google.com>

Brandon Williams wrote:

Show 7 quoted lines

> Update the config documentation to note the value `2` as an acceptable
> value for the protocol.version config.
>
> Signed-off-by: Brandon Williams <bmwill@google.com>
> ---
>  Documentation/config.txt | 2 ++
>  1 file changed, 2 insertions(+)

Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.

Show 11 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index a05a88fec..ce778883d 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -2637,6 +2637,8 @@ protocol.version::
>  * `1` - the original wire protocol with the addition of a version string
>    in the initial response from the server.
>  
> +* `2` - wire protocol version 2.
> +
>  --

Should this mention where the user can find more details (e.g. by saying link:technical/protocol-v2.html[protocol version 2])?

See the reference to the credentials API in "git help credentials" for an example of how that renders.

Jonathan