changeset 29092:8ecc3ba88e79

Tweak x*printf documentation. * lib/xprintf.c (xprintf, xvprintf, xfprintf, xvfprintf): Adjust variable name and comments. Suggested by Bruno Haible. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Mon, 22 Oct 2007 16:05:18 -0600
parents a0535d2b09bc
children 0115d97fa84e
files ChangeLog lib/xprintf.c
diffstat 2 files changed, 27 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Oct 22 23:51:39 2007 +0200
+++ b/ChangeLog	Mon Oct 22 16:05:18 2007 -0600
@@ -1,3 +1,10 @@
+2007-10-22  Eric Blake  <ebb9@byu.net>
+
+	Tweak x*printf documentation.
+	* lib/xprintf.c (xprintf, xvprintf, xfprintf, xvfprintf): Adjust
+	variable name and comments.
+	Suggested by Bruno Haible.
+
 2007-10-22  Bruno Haible  <bruno@clisp.org>
 
 	* lib/acl.c (copy_acl): Fix file name in comment.
--- a/lib/xprintf.c	Mon Oct 22 23:51:39 2007 +0200
+++ b/lib/xprintf.c	Mon Oct 22 16:05:18 2007 -0600
@@ -26,54 +26,54 @@
 
 /* written by Jim Meyering */
 
-/* Just like printf, but call error if it fails without setting
-   the error indicator.  */
+/* Just like printf, but call error if it fails without setting the
+   stream's error indicator.  */
 int
 xprintf (char const *restrict format, ...)
 {
   va_list args;
-  int err;
+  int retval;
   va_start (args, format);
-  err = xvprintf (format, args);
+  retval = xvprintf (format, args);
   va_end (args);
 
-  return err;
+  return retval;
 }
 
-/* Just like vprintf, but call error if it fails without setting
-   the error indicator.  */
+/* Just like vprintf, but call error if it fails without setting the
+   stream's error indicator.  */
 int
 xvprintf (char const *restrict format, va_list args)
 {
-  int err = vprintf (format, args);
-  if (err < 0 && ! ferror (stdout))
+  int retval = vprintf (format, args);
+  if (retval < 0 && ! ferror (stdout))
     error (exit_failure, errno, gettext ("cannot perform formatted output"));
 
-  return err;
+  return retval;
 }
 
-/* Just like fprintf, but call error if it fails without setting
-   the error indicator.  */
+/* Just like fprintf, but call error if it fails without setting the
+   stream's error indicator.  */
 int
 xfprintf (FILE *restrict stream, char const *restrict format, ...)
 {
   va_list args;
-  int err;
+  int retval;
   va_start (args, format);
-  err = xvfprintf (stream, format, args);
+  retval = xvfprintf (stream, format, args);
   va_end (args);
 
-  return err;
+  return retval;
 }
 
-/* Just like vfprintf, but call error if it fails without setting
-   the error indicator.  */
+/* Just like vfprintf, but call error if it fails without setting the
+   stream's error indicator.  */
 int
 xvfprintf (FILE *restrict stream, char const *restrict format, va_list args)
 {
-  int err = vfprintf (stream, format, args);
-  if (err < 0 && ! ferror (stream))
+  int retval = vfprintf (stream, format, args);
+  if (retval < 0 && ! ferror (stream))
     error (exit_failure, errno, gettext ("cannot perform formatted output"));
 
-  return err;
+  return retval;
 }