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 7/7] getmntent.3: wfix
Date: Thu, 15 Jan 2015 22:18:33 -0500 [thread overview]
Message-ID: <54B88309.6050505@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/getmntent.3 b/man3/getmntent.3
index 02759a2..8540bc5 100644
--- a/man3/getmntent.3
+++ b/man3/getmntent.3
@@ -40,18 +40,18 @@ getmntent_r \- get filesystem descriptor file entry
.sp
.BI "FILE *setmntent(const char *" filename ", const char *" type );
.sp
-.BI "struct mntent *getmntent(FILE *" fp );
+.BI "struct mntent *getmntent(FILE *" stream );
.sp
-.BI "int addmntent(FILE *" fp ", const struct mntent *" mnt );
+.BI "int addmntent(FILE *" stream ", const struct mntent *" mnt );
.sp
-.BI "int endmntent(FILE *" fp );
+.BI "int endmntent(FILE *" streamp );
.sp
.BI "char *hasmntopt(const struct mntent *" mnt ", const char *" opt );
.sp
/* GNU extension */
.B #include <mntent.h>
.sp
-.BI "struct mntent *getmntent_r(FILE *" fp ", struct mntent *" mntbuf ,
+.BI "struct mntent *getmntent_r(FILE *" streamp ", struct mntent *" mntbuf ,
.BI " char *" buf ", int " buflen );
.fi
.sp
@@ -84,9 +84,9 @@ argument of
.PP
The
.BR getmntent ()
-function reads the next line from the filesystem
-description file
-.I fp
+function reads the next line of the filesystem
+description file from
+.I stream
and returns a pointer to a structure
containing the broken out fields from a line in the file.
The pointer
@@ -101,13 +101,14 @@ function adds the
structure
.I mnt
to
-the end of the open file
-.IR fp .
+the end of the open
+.IR stream .
.PP
The
.BR endmntent ()
-function closes the filesystem description file
-.IR fp .
+function closes the
+.IR stream
+associated with the filesystem description file.
.PP
The
.BR hasmntopt ()
---
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
next 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] ` <54B88309.6050505-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2015-01-16 5:59 ` [patch 7/7] getmntent.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=54B88309.6050505@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.