[libnf_ct,v2,2/9] Fix nfexp_snprintf return value docs

Message ID	20200624133005.22046-2-dxld@darkboxed.org
State	Accepted
Delegated to:	Pablo Neira
Headers	show Return-Path: <netfilter-devel-owner@vger.kernel.org> From: =?utf-8?q?Daniel_Gr=C3=B6ber?= <dxld@darkboxed.org> To: netfilter-devel@vger.kernel.org Subject: [libnf_ct PATCH v2 2/9] Fix nfexp_snprintf return value docs Date: Wed, 24 Jun 2020 15:29:58 +0200 Message-Id: <20200624133005.22046-2-dxld@darkboxed.org> In-Reply-To: <20200624133005.22046-1-dxld@darkboxed.org> References: <20200624133005.22046-1-dxld@darkboxed.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: netfilter-devel-owner@vger.kernel.org Precedence: bulk
Series	[libnf_ct,v2,1/9] Handle negative snprintf return values properly \| expand [libnf_ct,v2,1/9] Handle negative snprintf return values properly [libnf_ct,v2,2/9] Fix nfexp_snprintf return value docs [libnf_ct,v2,3/9] Replace strncpy with snprintf to improve null byte handling [libnf_ct,v2,4/9] Fix incorrect snprintf size calculation [libnf_ct,v2,5/9] Add ARRAY_SIZE() macro [libnf_ct,v2,6/9] Fix buffer overflow on invalid icmp type in setters [libnf_ct,v2,7/9] Move icmp request>reply type mapping to common file [libnf_ct,v2,8/9] Fix buffer overflow in protocol related snprintf functions [libnf_ct,v2,9/9] Fix buffer overflows in __snprintf_protoinfo* like in *2str fns

Message ID

20200624133005.22046-2-dxld@darkboxed.org

State

Accepted

Delegated to:

Pablo Neira

Headers

From: =?utf-8?q?Daniel_Gr=C3=B6ber?= <dxld@darkboxed.org>
To: netfilter-devel@vger.kernel.org
Subject: [libnf_ct PATCH v2 2/9] Fix nfexp_snprintf return value docs
Date: Wed, 24 Jun 2020 15:29:58 +0200
Message-Id: <20200624133005.22046-2-dxld@darkboxed.org>
In-Reply-To: <20200624133005.22046-1-dxld@darkboxed.org>
References: <20200624133005.22046-1-dxld@darkboxed.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Sender: netfilter-devel-owner@vger.kernel.org
Precedence: bulk

Series

[libnf_ct,v2,1/9] Handle negative snprintf return values properly | expand

Commit Message

Daniel Gröber June 24, 2020, 1:29 p.m. UTC

The docs currently say "[...] Otherwise, 0 is returned."  which is just
completely wrong. Just like nfct_snprintf the expected buffer size is
returned.

Signed-off-by: Daniel Gröber <dxld@darkboxed.org>
---
 src/expect/api.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/expect/api.c b/src/expect/api.c
index 33099d8..39cd092 100644
--- a/src/expect/api.c
+++ b/src/expect/api.c
@@ -795,8 +795,9 @@  int nfexp_catch(struct nfct_handle *h)
  * 	- NFEXP_O_LAYER: include layer 3 information in the output, this is
  * 			*only* required by NFEXP_O_DEFAULT.
  * 
- * On error, -1 is returned and errno is set appropiately. Otherwise,
- * 0 is returned.
+ * On error, -1 is returned and errno is set appropiately. Otherwise the
+ * size of what _would_ be written is returned, even if the size of the
+ * buffer is insufficient. This behaviour is similar to snprintf.
  */
 int nfexp_snprintf(char *buf,
 		  unsigned int size,

[libnf_ct,v2,2/9] Fix nfexp_snprintf return value docs

Commit Message

Patch