linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Carlos O'Donell" <carlos-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
To: Michael Kerrisk
	<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	"linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Subject: [patch 2/7] fclose.3: wfix
Date: Thu, 15 Jan 2015 22:18:18 -0500	[thread overview]
Message-ID: <54B882FA.9070500@redhat.com> (raw)

Harmonize all the manual pages to use "stream" for FILE*
instead of randomly using "fp" or "stream." Choosing something
and being consistent helps users scan the man pages quickly
and understand what they are looking at.

Patch against master.

diff --git a/man3/fclose.3 b/man3/fclose.3
index 28c0d00..b07d444 100644
--- a/man3/fclose.3
+++ b/man3/fclose.3
@@ -47,12 +47,12 @@ fclose \- close a stream
 .SH SYNOPSIS
 .B #include <stdio.h>
 .sp
-.BI "int fclose(FILE *" fp );
+.BI "int fclose(FILE *" stream );
 .SH DESCRIPTION
 The
 .BR fclose ()
 function flushes the stream pointed to by
-.I fp
+.I stream
 (writing any buffered output data using
 .BR fflush (3))
 and closes the underlying file descriptor.
@@ -71,12 +71,12 @@ to the stream results in undefined behavior.
 .TP
 .B EBADF
 The file descriptor underlying
-.I fp
+.I stream
 is not valid.
 .\"  This error cannot occur unless you are mixing ANSI C stdio operations and
 .\"  low-level file operations on the same stream. If you do get this error,
 .\"  you must have closed the stream's low-level file descriptor using
-.\"  something like close(fileno(fp)).
+.\"  something like close(fileno(stream)).
 .PP
 The
 .BR fclose ()
---

Cheers,
Carlos.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

             reply	other threads:[~2015-01-16  3:18 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-16  3:18 Carlos O'Donell [this message]
     [not found] ` <54B882FA.9070500-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2015-01-16  5:44   ` [patch 2/7] fclose.3: wfix Michael Kerrisk (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=54B882FA.9070500@redhat.com \
    --to=carlos-h+wxahxf7alqt0dzr+alfa@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).