aboutsummaryrefslogtreecommitdiff
path: root/libiberty/snprintf.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/snprintf.c
parent94cdfcffc3e97a817b8c918c11b2e00f95a4c070 (diff)
downloadgdb-8893fa20206a4f651a5469eb0dfae419c178f2a7.zip
gdb-8893fa20206a4f651a5469eb0dfae419c178f2a7.tar.gz
gdb-8893fa20206a4f651a5469eb0dfae419c178f2a7.tar.bz2
merge from gcc
Diffstat (limited to 'libiberty/snprintf.c')
-rw-r--r--libiberty/snprintf.c16
1 files changed, 9 insertions, 7 deletions
diff --git a/libiberty/snprintf.c b/libiberty/snprintf.c
index f1ba49f..36c8e9b 100644
--- a/libiberty/snprintf.c
+++ b/libiberty/snprintf.c
@@ -27,13 +27,15 @@ the executable file might be covered by the GNU General Public License. */
@deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, ...)
-This function is similar to sprintf, 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{sprintf}, 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
+bytes, not including the terminating null byte, that would have been
+written 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