[PATCH] doc: fix want-capability separator

Masaya Suzuki· Jul 28, 2018, 21:16 UTC · lore

Unlike ref advertisement, client capabilities and the first want are separated by SP, not NUL, in the implementation. Fix the documentation to align with the implementation. pack-protocol.txt is already fixed.

Signed-off-by: Masaya Suzuki <masayasuzuki@google.com>
---
 Documentation/technical/http-protocol.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/technical/http-protocol.txt +2 −2

diff --git a/Documentation/technical/http-protocol.txt b/Documentation/technical/http-protocol.txt
index 64f49d0bb..9c5b6f0fa 100644
--- a/Documentation/technical/http-protocol.txt
+++ b/Documentation/technical/http-protocol.txt
@@ -338,11 +338,11 @@ server advertises capability `allow-tip-sha1-in-want` or
 		       request_end
   request_end       =  "0000" / "done"
 
-  want_list         =  PKT-LINE(want NUL cap_list LF)
+  want_list         =  PKT-LINE(want SP cap_list LF)
 		       *(want_pkt)
   want_pkt          =  PKT-LINE(want LF)
   want              =  "want" SP id
-  cap_list          =  *(SP capability) SP
+  cap_list          =  capability *(SP capability)
 
   have_list         =  *PKT-LINE("have" SP id LF)

-- 
2.18.0

Stefan Beller· Jul 30, 2018, 18:26 UTC · re: Masaya Suzuki · lore

Re: [PATCH] doc: fix want-capability separator

On Sat, Jul 28, 2018 at 2:16 PM Masaya Suzuki <draftcode@gmail.com> wrote:

> Signed-off-by: Masaya Suzuki <masayasuzuki@google.com>

The email addresses mismatch?

> Unlike ref advertisement, client capabilities and the first want are
> separated by SP, not NUL, in the implementation. Fix the documentation
> to align with the implementation.

Makes sense! Thanks for the fix!

> pack-protocol.txt is already fixed.

which has

  capability-list  =  capability *(SP capability)

since b31222cfb7f (Update packfile transfer protocol documentation, 2009-11-03), which is the first to mention the capability line, so I'd claim it was always correct?

Show 22 quoted lines

>
> ---
>  Documentation/technical/http-protocol.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/technical/http-protocol.txt b/Documentation/technical/http-protocol.txt
> index 64f49d0bb..9c5b6f0fa 100644
> --- a/Documentation/technical/http-protocol.txt
> +++ b/Documentation/technical/http-protocol.txt
> @@ -338,11 +338,11 @@ server advertises capability `allow-tip-sha1-in-want` or
>                        request_end
>    request_end       =  "0000" / "done"
>
> -  want_list         =  PKT-LINE(want NUL cap_list LF)
> +  want_list         =  PKT-LINE(want SP cap_list LF)
>                        *(want_pkt)
>    want_pkt          =  PKT-LINE(want LF)
>    want              =  "want" SP id
> -  cap_list          =  *(SP capability) SP
> +  cap_list          =  capability *(SP capability)
>
>    have_list         =  *PKT-LINE("have" SP id LF)

Just after these context lines we have

  TODO: Document this further.

which is a good hint that the existing documentation can benefit from patches like these.

Thanks, Stefan

patchdoc: fix want-capability separator