summaryrefslogtreecommitdiff
path: root/libiberty/vsnprintf.c
diff options
context:
space:
mode:
authorDJ Delorie <dj@redhat.com>2009-05-30 05:18:46 +0000
committerDJ Delorie <dj@redhat.com>2009-05-30 05:18:46 +0000
commit8893fa20206a4f651a5469eb0dfae419c178f2a7 (patch)
treea31743d5168a52b7c8b47dbcf5c4d3db7f3a7b4b /libiberty/vsnprintf.c
parent94cdfcffc3e97a817b8c918c11b2e00f95a4c070 (diff)
downloadbinutils-gdb-8893fa20206a4f651a5469eb0dfae419c178f2a7.tar.gz
merge from gcc
Diffstat (limited to 'libiberty/vsnprintf.c')
-rw-r--r--libiberty/vsnprintf.c16
1 files changed, 9 insertions, 7 deletions
diff --git a/libiberty/vsnprintf.c b/libiberty/vsnprintf.c
index 7df5bd88e52..5470df2223b 100644
--- a/libiberty/vsnprintf.c
+++ b/libiberty/vsnprintf.c
@@ -27,13 +27,15 @@ the executable file might be covered by the GNU General Public License. */
@deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, va_list @var{ap})
-This function is similar to vsprintf, but it will print at most
-@var{n} characters. On error the return value is -1, otherwise it
-returns the number of characters that would have been printed had
-@var{n} been sufficiently large, regardless of the actual value of
-@var{n}. Note some pre-C99 system libraries do not implement this
-correctly so users cannot generally rely on the return value if the
-system version of this function is used.
+This function is similar to @code{vsprintf}, but it will write to
+@var{buf} at most @code{@var{n}-1} bytes of text, followed by a
+terminating null byte, for a total of @var{n} bytes. On error the
+return value is -1, otherwise it returns the number of characters that
+would have been printed had @var{n} been sufficiently large,
+regardless of the actual value of @var{n}. Note some pre-C99 system
+libraries do not implement this correctly so users cannot generally
+rely on the return value if the system version of this function is
+used.
@end deftypefn