From: Thorsten Glaser <tg@mirbsd.org>
Date: Thu, 10 Dec 2009 17:07:25 +0000 (+0100)
Subject: Expand on API guarantee for fgetln
X-Git-Tag: 0.2.0~22
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c17c7e13c3522c6d72ceb4bc207308b8c7452b44;p=thirdparty%2Flibbsd.git

Expand on API guarantee for fgetln

OpenBSD has begun using the API guarantee that *len is not 0 if
the fgetln(3) return value is not NULL; document this explicitly
in the manpage and add a comment to the function implementation
that this doesn’t need to be checked because getdelim/getline have
similar guarantees.

Signed-off-by: Thorsten Glaser <tg@mirbsd.org>
---

diff --git a/man/fgetln.3 b/man/fgetln.3
index d483c09..c01d1ef 100644
--- a/man/fgetln.3
+++ b/man/fgetln.3
@@ -54,7 +54,7 @@ character.
 The length of the line, including the final newline,
 is stored in the memory location to which
 .Fa len
-points.
+points and is guaranteed to be greater than 0 upon successful completion.
 (Note, however, that if the line is the last
 in a file that does not end in a newline,
 the returned text will not contain a newline.)
diff --git a/src/fgetln.c b/src/fgetln.c
index 6e3d000..317880d 100644
--- a/src/fgetln.c
+++ b/src/fgetln.c
@@ -39,6 +39,7 @@ fgetln (FILE *stream, size_t *len)
 	ssize_t nread;
 
 	nread = getline(&line, &line_len, stream);
+	/* Note: the getdelim/getline API ensures nread != 0. */
 	if (nread == -1) {
 		*len = 0;
 		return NULL;