mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: order protocol v2 sections

Browse Source 
The current C Git implementation expects Git servers to follow a
specific order of sections when transmitting protocol v2 responses, but
this is not explicit in the documentation. Make the order explicit.

Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jonathan Tan
2020-06-10 13:57:19 -07:00
committed by Junio C Hamano
parent 8d5d2a34df
commit fd194dd56a
1 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/technical/protocol-v2.txt
View File

@ -325,11 +325,11 @@ included in the client's request:
The response of `fetch` is broken into a number of sections separated by The response of `fetch` is broken into a number of sections separated by
delimiter packets (0001), with each section beginning with its section delimiter packets (0001), with each section beginning with its section
header. header. Most sections are sent only when the packfile is sent.
output = *section output = acknowledgements flush-pkt |
section = (acknowledgments | shallow-info | wanted-refs | packfile) [acknowledgments delim-pkt] [shallow-info delim-pkt]
(flush-pkt | delim-pkt) [wanted-refs delim-pkt] packfile flush-pkt
acknowledgments = PKT-LINE("acknowledgments" LF) acknowledgments = PKT-LINE("acknowledgments" LF)
(nak | *ack) (nak | *ack)
@ -351,9 +351,10 @@ header.
*PKT-LINE(%x01-03 *%x00-ff) *PKT-LINE(%x01-03 *%x00-ff)
acknowledgments section acknowledgments section
* If the client determines that it is finished with negotiations * If the client determines that it is finished with negotiations by
by sending a "done" line, the acknowledgments sections MUST be sending a "done" line (thus requiring the server to send a packfile),
omitted from the server's response. the acknowledgments sections MUST be omitted from the server's
response.
* Always begins with the section header "acknowledgments" * Always begins with the section header "acknowledgments"
@ -404,9 +405,6 @@ header.
which the client has not indicated was shallow as a part of which the client has not indicated was shallow as a part of
its request. its request.
* This section is only included if a packfile section is also
included in the response.
wanted-refs section wanted-refs section
* This section is only included if the client has requested a * This section is only included if the client has requested a
ref using a 'want-ref' line and if a packfile section is also ref using a 'want-ref' line and if a packfile section is also