mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-05-20 00:36:07 +02:00
Code

Merge branch 'mt/pkt-line-comment-tweak' into maint 

In-code comment clarification.
source: <6a14443c101fa132498297af6d7a483520688d75.1658488203.git.matheus.bernardino@usp.br>

* mt/pkt-line-comment-tweak:
  pkt-line.h: move comment closer to the associated code
This commit is contained in:
Junio C Hamano 2022-08-10 21:52:35 -07:00
parent 5856cb98c0 ce5f07983d
commit 3f4fa1fab8
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
pkt-line.h
View File

@ -49,14 +49,6 @@ void packet_fflush(FILE *f);
* Read a packetized line into the buffer, which must be at least size bytes
* long. The return value specifies the number of bytes read into the buffer.
*
* If src_buffer and *src_buffer are not NULL, it should point to a buffer
* containing the packet data to parse, of at least *src_len bytes. After the
* function returns, src_buf will be incremented and src_len decremented by the
* number of bytes consumed.
*
* If src_buffer (or *src_buffer) is NULL, then data is read from the
* descriptor "fd".
*
* If options does not contain PACKET_READ_GENTLE_ON_EOF, we will die under any
* of the following conditions:
*
@ -104,6 +96,14 @@ int packet_length(const char lenbuf_hex[4]);
* returns an 'enum packet_read_status' which indicates the status of the read.
* The number of bytes read will be assigned to *pktlen if the status of the
* read was 'PACKET_READ_NORMAL'.
*
* If src_buffer and *src_buffer are not NULL, it should point to a buffer
* containing the packet data to parse, of at least *src_len bytes. After the
* function returns, src_buf will be incremented and src_len decremented by the
* number of bytes consumed.
*
* If src_buffer (or *src_buffer) is NULL, then data is read from the
* descriptor "fd".
*/
enum packet_read_status {
PACKET_READ_EOF,