summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-08-11 04:52:35 (GMT)
committerJunio C Hamano <gitster@pobox.com>2022-08-11 04:52:35 (GMT)
commit3f4fa1fab8092c587960b5e8323e4b84630a064d (patch)
tree0f41ded3d69c26bff173c57e1e8373ba450803a4
parent5856cb98c016657f793ec632ea42c4bb0add0101 (diff)
parentce5f07983d1834a4d22931be3077192001fd0d70 (diff)
downloadgit-3f4fa1fab8092c587960b5e8323e4b84630a064d.zip
git-3f4fa1fab8092c587960b5e8323e4b84630a064d.tar.gz
git-3f4fa1fab8092c587960b5e8323e4b84630a064d.tar.bz2
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
-rw-r--r--pkt-line.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/pkt-line.h b/pkt-line.h
index 6d2a63d..1f623de 100644
--- a/pkt-line.h
+++ b/pkt-line.h
@@ -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,