[OUTREACHY][PATCH v1] doc: fix naming of response-end-pkt

Subsystems: documentation, the rest

3 messages, 2 authors, 2021-02-18 · open the first message on its own page

[OUTREACHY][PATCH v1] doc: fix naming of response-end-pkt

From: Joey Salazar <hidden>
Date: 2021-02-16 21:22:37

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.

[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 <redacted>
---
 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..6c55d566d8b 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

Re: [OUTREACHY][PATCH v1] doc: fix naming of response-end-pkt

From: Denton Liu <hidden>
Date: 2021-02-17 11:08:42

Hi Joey,

On Tue, Feb 16, 2021 at 09:21:50PM +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.
Thanks for catching this, this is an obvious error on my part. In fact,
I'd go as far as saying that in the commit where this was defined,
b0df0c16 (stateless-connect: send response end packet, 2020-05-19), I
erroneously called it a "Message Packet" when I meant to type "Response
End Packet", which you are now correcting.
quoted hunk
[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 <redacted>
---
 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..6c55d566d8b 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
A couple of aesthetic details: I see that these changes are based on MR
!1922 so if you decide to take these suggestions, you'll probably need
to apply them there too.

	1. It'd probably read better as "Response End Packet" (with the
	   "e" capitalised)

	2. The mix of underscore and hyphen in response_end-pkt is a
	   little odd, although I see that you've done it to make it
	   match the surrounding code[3].

I think that I'd prefer if 1. is taken and 2. can be ignored. But with
or without those changes, consider this patch

	Acked-by: Denton Liu [off-list ref]

Thanks,
Denton

[3]: https://gitlab.com/wireshark/wireshark/-/merge_requests/1922#note_502316230
 Initial Client Request
 ----------------------
--
2.29.0.rc2

Re: [OUTREACHY][PATCH v1] doc: fix naming of response-end-pkt

From: Joey Salazar <hidden>
Date: 2021-02-18 00:01:20

Hi Denton,

On Wednesday, February 17, 2021 5:07 AM, Denton Liu wrote:
Hi Joey,

A couple of aesthetic details: I see that these changes are based on MR
!1922 so if you decide to take these suggestions, you'll probably need
to apply them there too.

1. It'd probably read better as "Response End Packet" (with the
"e" capitalised)

2. The mix of underscore and hyphen in response_end-pkt is a
little odd, although I see that you've done it to make it
match the surrounding code[3].
Well noted, I'll follow up shortly with PATCH v2 to incorporate both changes.

Thank you,
Joey
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help