diff options
author | das <das@FreeBSD.org> | 2010-11-30 21:26:21 +0000 |
---|---|---|
committer | das <das@FreeBSD.org> | 2010-11-30 21:26:21 +0000 |
commit | 705fce2dae1505594d70d91548368b9248be744e (patch) | |
tree | 1bd1a785e0b7c367ff08489ffe865b4ceaf615ae /lib | |
parent | d3abe35fb659ec850d79b5fc8b008cc6767d1f49 (diff) | |
download | FreeBSD-src-705fce2dae1505594d70d91548368b9248be744e.zip FreeBSD-src-705fce2dae1505594d70d91548368b9248be744e.tar.gz |
Update the documentation to reflect changes to the implementation in
r197752, which is related to handling of null buffer pointers. Also
make a few minor wording changes.
Reported by: jh@
Diffstat (limited to 'lib')
-rw-r--r-- | lib/libc/stdio/getline.3 | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/lib/libc/stdio/getline.3 b/lib/libc/stdio/getline.3 index a5b39da..e0dda08 100644 --- a/lib/libc/stdio/getline.3 +++ b/lib/libc/stdio/getline.3 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 29, 2009 +.Dd November 30, 2010 .Dt GETLINE 3 .Os .Sh NAME @@ -54,23 +54,23 @@ function is equivalent to with the newline character as the delimiter. The delimiter character is included as part of the line, unless the end of the file is reached. -The caller may provide a pointer to a malloc buffer for the line in +.Pp +The caller may provide a pointer to a malloced buffer for the line in .Fa *linep , and the capacity of that buffer in -.Fa *linecapp ; -if -.Fa *linecapp -is 0, then -.Fa *linep -is treated as -.Dv NULL . -These functions may expand the buffer as needed, as if via -.Fn realloc , -and update +.Fa *linecapp . +These functions expand the buffer as needed, as if via +.Fn realloc . +If +.Fa linep +points to a +.Dv NULL +pointer, a new buffer will be allocated. +In either case, .Fa *linep and .Fa *linecapp -accordingly. +will be updated accordingly. .Sh RETURN VALUES The .Fn getdelim @@ -140,7 +140,7 @@ No delimiter was found in the first characters. .El .Pp -These functions may also fail for any of the errors specified for +These functions may also fail due to any of the errors specified for .Fn fgets and .Fn malloc . |