Skip to contentSkip to conversation

getgrent_r.3: wfix

PATCH In review Carlos O'Donell 2 participants 2 messages Jan 16, 2015 1 message not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore

Carlos O'Donell

author
#0 lore raw

PATCH 1/7 getgrent_r.3: wfix

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.

man3/getgrent_r.3 +3 -3
index 8f33851..6e1078d 100644
@@ -32,7 +32,7 @@ getgrent_r, fgetgrent_r \- get group file entry reentrantly
 .br
 .BI "               size_t " buflen ", struct group **" gbufp );
 .sp
-.BI "int fgetgrent_r(FILE *" fp ", struct group *" gbuf ", char *" buf ,
+.BI "int fgetgrent_r(FILE *" stream ", struct group *" gbuf ", char *" buf ,
 .br
 .BI "                size_t " buflen ", struct group **" gbufp );
 .fi

@@ -59,8 +59,8 @@ and
 .BR fgetgrent (3).
 The former reads the next group entry from the stream initialized by
 .BR setgrent (3).
-The latter reads the next group entry from the stream
-.IR fp .
+The latter reads the next group entry from the
+.IR stream .
 .PP
 The \fIgroup\fP structure is defined in
 .I <grp.h>

---

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

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw
Quoted 4 lines · Carlos O'Donell

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.

Thanks, Carlos. Applied.

Cheers,

Michael

Quoted 31 lines

Patch against master.

man3/getgrent_r.3 +3 -4
index 8f33851..6e1078d 100644
@@ -32,7 +32,7 @@ getgrent_r, fgetgrent_r \- get group file entry reentrantly
 .br
 .BI "               size_t " buflen ", struct group **" gbufp );
 .sp
-.BI "int fgetgrent_r(FILE *" fp ", struct group *" gbuf ", char *" buf ,
+.BI "int fgetgrent_r(FILE *" stream ", struct group *" gbuf ", char *" buf ,
 .br
 .BI "                size_t " buflen ", struct group **" gbufp );
 .fi

@@ -59,8 +59,8 @@ and
 .BR fgetgrent (3).
 The former reads the next group entry from the stream initialized by
 .BR setgrent (3).
-The latter reads the next group entry from the stream
-.IR fp .
+The latter reads the next group entry from the
+.IR stream .
 .PP
 The \fIgroup\fP structure is defined in
 .I <grp.h>
---

Cheers,
Carlos.

Signature · 7 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html