aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Svoboda <svoboda@cert.org>2014-04-02 05:13:02 -0400
committerMike Frysinger <vapier@gentoo.org>2014-04-03 18:23:57 -0400
commit1c21d115e3e47cd66007341de4bae5c4b0a2d547 (patch)
treea5fa2bf5c51461c06b2438ae16580aa3bd324bc4
parentfcccd51286acbf9c19ac57ab7143e257d58323fd (diff)
downloadglibc-1c21d115e3e47cd66007341de4bae5c4b0a2d547.tar
glibc-1c21d115e3e47cd66007341de4bae5c4b0a2d547.tar.gz
glibc-1c21d115e3e47cd66007341de4bae5c4b0a2d547.tar.bz2
glibc-1c21d115e3e47cd66007341de4bae5c4b0a2d547.zip
manual: clarify buffer behavior in getline [BZ #5666]
If the user has requested automatic buffer creation, getline may create it and not free things when an error occurs. That means the user is always responsible for calling free() regardless of the return value. The current documentation does not explicitly cover this which leaves it slightly ambiguous to the reader. So clarify things. URL: https://sourceware.org/bugzilla/show_bug.cgi?id=5666
-rw-r--r--ChangeLog6
-rw-r--r--manual/stdio.texi3
2 files changed, 8 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index 7a1c10620a..da8ea6d06f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2014-04-03 David Svoboda <svoboda@cert.org>
+
+ [BZ #5666]
+ * manual/stdio.texi (Line-Oriented Input): Document buffer allocation
+ explicitly.
+
2014-04-03 Roland McGrath <roland@hack.frob.com>
* elf/dl-unmap-segments.h: New file.
diff --git a/manual/stdio.texi b/manual/stdio.texi
index a4364f79f9..efdaaadf27 100644
--- a/manual/stdio.texi
+++ b/manual/stdio.texi
@@ -1298,7 +1298,8 @@ back in @code{*@var{n}}.
If you set @code{*@var{lineptr}} to a null pointer, and @code{*@var{n}}
to zero, before the call, then @code{getline} allocates the initial
-buffer for you by calling @code{malloc}.
+buffer for you by calling @code{malloc}. This buffer remains allocated
+even if @code{getline} encounters errors and is unable to read any bytes.
In either case, when @code{getline} returns, @code{*@var{lineptr}} is
a @code{char *} which points to the text of the line.