diff mbox series

[OUTREACHY,v2] doc: fix naming of response-end-pkt

Message ID k1OL_yTjmhqRPUI_3wZNi4FpD0yadrwMKu1CaOXO07YyMBQG5hYoUKFtndt6mlNBKMxyCgm3JGf2YcENx-vRasj1W8keEI6ITVvkaqOi2_Q=@protonmail.com (mailing list archive)
State New, archived
Headers show
Series [OUTREACHY,v2] doc: fix naming of response-end-pkt | expand

Commit Message

Joey Salazar Feb. 18, 2021, 12:11 a.m. UTC
Git Protocol version 2[1] defines 0002 as a Message Packet that indicates
the end of a response for stateless connections.

Change the naming of the 0002 Packet to 'Response End' to match the
parsing introduced in Wireshark's MR !1922 for consistency. A subsequent
MR in Wireshark will address additional mismatches.

[1] kernel.org/pub/software/scm/git/docs/technical/protocol-v2.html
[2] gitlab.com/wireshark/wireshark/-/merge_requests/1922

Signed-off-by: Joey Salazar <jgsal@protonmail.com>
---
 Documentation/technical/protocol-v2.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--
2.29.0.rc2

Comments

Denton Liu Feb. 18, 2021, 3:49 a.m. UTC | #1
On Thu, Feb 18, 2021 at 12:11:22AM +0000, Joey Salazar wrote:
> Git Protocol version 2[1] defines 0002 as a Message Packet that indicates
> the end of a response for stateless connections.
> 
> Change the naming of the 0002 Packet to 'Response End' to match the
> parsing introduced in Wireshark's MR !1922 for consistency. A subsequent
> MR in Wireshark will address additional mismatches.
> 
> [1] kernel.org/pub/software/scm/git/docs/technical/protocol-v2.html
> [2] gitlab.com/wireshark/wireshark/-/merge_requests/1922
> 
> Signed-off-by: Joey Salazar <jgsal@protonmail.com>

Reviewed-by: Denton Liu <liu.denton@gmail.com>

> ---
>  Documentation/technical/protocol-v2.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/technical/protocol-v2.txt b/Documentation/technical/protocol-v2.txt
> index e597b74da39..fc163ca605c 100644
> --- a/Documentation/technical/protocol-v2.txt
> +++ b/Documentation/technical/protocol-v2.txt
> @@ -33,8 +33,8 @@ In protocol v2 these special packets will have the following semantics:
> 
>    * '0000' Flush Packet (flush-pkt) - indicates the end of a message
>    * '0001' Delimiter Packet (delim-pkt) - separates sections of a message
> -  * '0002' Message Packet (response-end-pkt) - indicates the end of a response
> -    for stateless connections
> +  * '0002' Response End Packet (response-end-pkt) - indicates the end of a
> +    response for stateless connections
> 
>  Initial Client Request
>  ----------------------
> --
> 2.29.0.rc2
>
diff mbox series

Patch

diff --git a/Documentation/technical/protocol-v2.txt b/Documentation/technical/protocol-v2.txt
index e597b74da39..fc163ca605c 100644
--- a/Documentation/technical/protocol-v2.txt
+++ b/Documentation/technical/protocol-v2.txt
@@ -33,8 +33,8 @@  In protocol v2 these special packets will have the following semantics:

   * '0000' Flush Packet (flush-pkt) - indicates the end of a message
   * '0001' Delimiter Packet (delim-pkt) - separates sections of a message
-  * '0002' Message Packet (response-end-pkt) - indicates the end of a response
-    for stateless connections
+  * '0002' Response End Packet (response-end-pkt) - indicates the end of a
+    response for stateless connections

 Initial Client Request
 ----------------------