# [PATCH] pkt-line.h: move comment closer to the associated code 3 messages from 2022-07-22 to 2022-07-22. Participants: Matheus Tavares, Ævar Arnfjörð Bjarmason. Thread: https://gitlist.dev/t/58210 ## Matheus Tavares, 2022-07-22 11:10 Subject: [PATCH] pkt-line.h: move comment closer to the associated code Message-ID: <6a14443c101fa132498297af6d7a483520688d75.1658488203.git.matheus.bernardino@usp.br> URL: https://gitlist.dev/e/6a14443c101fa132498297af6d7a483520688d75.1658488203.git.matheus.bernardino%40usp.br ``` ec9a37d ("pkt-line.[ch]: remove unused packet_read_line_buf()", 2021-10-14) removed the "src_buffer" and "src_len" parameters from packet_read(), only leaving them at packet_read_with_status(). Let's also update the function documentation by moving the comment about these parameters from the former to the latter. Signed-off-by: Matheus Tavares --- pkt-line.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pkt-line.h b/pkt-line.h index 6d2a63db23..1f623de60a 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, -- 2.37.1 ``` ## Ævar Arnfjörð Bjarmason, 2022-07-22 11:19 Subject: Re: [PATCH] pkt-line.h: move comment closer to the associated code Message-ID: <220722.867d45s81o.gmgdl@evledraar.gmail.com> URL: https://gitlist.dev/e/220722.867d45s81o.gmgdl%40evledraar.gmail.com In-Reply-To: <6a14443c101fa132498297af6d7a483520688d75.1658488203.git.matheus.bernardino@usp.br> ``` On Fri, Jul 22 2022, Matheus Tavares wrote: > ec9a37d ("pkt-line.[ch]: remove unused packet_read_line_buf()", Nit: "log --pretty=reference" for me emits this length of SHA-1 on a fresh clone: ec9a37d69b (pkt-line.[ch]: remove unused packet_read_line_buf(), 2021-10-14) In this case ec9a3 is non-colliding, but you might want to adjust whatever your local alias is to use our default hash length instead of a presumably hardcoded length of 7 ;) No need to re-roll for that... > 2021-10-14) removed the "src_buffer" and "src_len" parameters from > packet_read(), only leaving them at packet_read_with_status(). Let's > also update the function documentation by moving the comment about these > parameters from the former to the latter. > > Signed-off-by: Matheus Tavares > --- > pkt-line.h | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > diff --git a/pkt-line.h b/pkt-line.h > index 6d2a63db23..1f623de60a 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, This change looks good to me, thanks for catching this & cleaning up after my change. ``` ## Matheus Tavares, 2022-07-22 12:47 Subject: Re: [PATCH] pkt-line.h: move comment closer to the associated code Message-ID: URL: https://gitlist.dev/e/CAHd-oW6HBkZPFR-vKwVSLBkqic%3DeSiWY8EY1T4ZNEzCk%2BLx6Bw%40mail.gmail.com In-Reply-To: <220722.867d45s81o.gmgdl@evledraar.gmail.com> ``` On Fri, Jul 22, 2022 at 8:25 AM Ævar Arnfjörð Bjarmason wrote: > > > On Fri, Jul 22 2022, Matheus Tavares wrote: > > > ec9a37d ("pkt-line.[ch]: remove unused packet_read_line_buf()", > > Nit: "log --pretty=reference" for me emits this length of SHA-1 on a > fresh clone: > > ec9a37d69b (pkt-line.[ch]: remove unused packet_read_line_buf(), 2021-10-14) > > In this case ec9a3 is non-colliding, but you might want to adjust > whatever your local alias is to use our default hash length instead of a > presumably hardcoded length of 7 ;) Thanks, will do :) ```