CLEANUP: h3: fix documentation of h3_rcv_buf()
authorAmaury Denoyelle <adenoyelle@haproxy.com>
Thu, 27 Feb 2025 10:28:07 +0000 (11:28 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 28 Feb 2025 15:27:59 +0000 (16:27 +0100)
commitda6832fd2fb065cb32f030609b53fee87488aab7
tree9c1f284ecddc88c8c26639ec1ce3e4709a032af9
parent00177c6f78d37a7fdbf22d86f1eb7c7403035fbb
CLEANUP: h3: fix documentation of h3_rcv_buf()

Return value of h3_rcv_buf() is incorrectly documented. Indeed, it may
return a positive value to indicate that input bytes were converted into
HTX. This is especially important, as caller uses this value to consume
the reported data amount in QCS Rx buffer.

This should be backported up to 2.6. Note that on 2.8, h3_rcv_buf() was
named h3_decode_qcs().

(cherry picked from commit 0aa35289b3b51e09a5757c9991212ec416d281f2)
Signed-off-by: Christopher Faulet <cfaulet@haproxy.com>
src/h3.c