From 7f0295f08ae273f3d732436234cddb88b68f511f Mon Sep 17 00:00:00 2001 From: Amaury Denoyelle Date: Fri, 18 Nov 2022 15:54:40 +0100 Subject: [PATCH] MINOR: ncbuf: complete doc for ncb_advance() ncb_advance() operation may reject the operation if a too small gap is formed in buffer front. This must be documented to avoid an issue with it. This should be backported up to 2.6. --- src/ncbuf.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/ncbuf.c b/src/ncbuf.c index 120293944d..ed1878bf81 100644 --- a/src/ncbuf.c +++ b/src/ncbuf.c @@ -625,7 +625,9 @@ enum ncb_ret ncb_add(struct ncbuf *buf, ncb_sz_t off, * will be lost while some space will be formed at the end to be able to insert * new data. * - * Returns NCB_RET_OK on success. + * Returns NCB_RET_OK on success. It may return NCB_RET_GAP_SIZE if operation + * is rejected due to the formation of a too small gap in front. If advance is + * done only inside a data block it is guaranteed to succeed. */ enum ncb_ret ncb_advance(struct ncbuf *buf, ncb_sz_t adv) { -- 2.47.3