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>

diff --git a/ChangeLog b/ChangeLog
index c05974ac5e8fa15ae5d8f865d1310426eb67e654..cf77f51ac380345fe19536182d1cf9c940d736fc 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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.

diff --git a/lib/xprintf.c b/lib/xprintf.c
index 7738cc4ee38a70ce36806bc92a9707cf8efd03a6..8f279faf41b00f553bff69841f85ed40e0866241 100644 (file)
--- a/lib/xprintf.c
+++ b/lib/xprintf.c
@@ -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;
 }