Skip to contentSkip to conversation

getspnam.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 3/7 getspnam.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/getspnam.3 +5 -5
index 13d6157..e230b78 100644
@@ -24,11 +24,11 @@ lckpwdf, ulckpwdf \- get shadow password file entry
 .sp
 .B void endspent(void);
 .sp
-.BI "struct spwd *fgetspent(FILE *" fp );
+.BI "struct spwd *fgetspent(FILE *" stream );
 .sp
 .BI "struct spwd *sgetspent(const char *" s );
 .sp
-.BI "int putspent(const struct spwd *" p ", FILE *" fp );
+.BI "int putspent(const struct spwd *" p ", FILE *" stream );
 .sp
 .B int lckpwdf(void);
 .sp

@@ -46,7 +46,7 @@ lckpwdf, ulckpwdf \- get shadow password file entry
 .br
 .BI "        char *" buf ", size_t " buflen ", struct spwd **" spbufp );
 .sp
-.BI "int fgetspent_r(FILE *" fp ", struct spwd *" spbuf ,
+.BI "int fgetspent_r(FILE *" stream ", struct spwd *" spbuf ,
 .br
 .BI "        char *" buf ", size_t " buflen ", struct spwd **" spbufp );
 .sp

@@ -137,8 +137,8 @@ The
 function writes the contents of the supplied struct
 .I spwd
 .I *p
-as a text line in the shadow password file format to the stream
-.IR fp .
+as a text line in the shadow password file format to the
+.IR stream .
 String entries with value NULL and numerical entries with value \-1
 are written as an empty string.
 .LP

---

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 45 lines

Patch against master.

man3/getspnam.3 +5 -6
index 13d6157..e230b78 100644
@@ -24,11 +24,11 @@ lckpwdf, ulckpwdf \- get shadow password file entry
 .sp
 .B void endspent(void);
 .sp
-.BI "struct spwd *fgetspent(FILE *" fp );
+.BI "struct spwd *fgetspent(FILE *" stream );
 .sp
 .BI "struct spwd *sgetspent(const char *" s );
 .sp
-.BI "int putspent(const struct spwd *" p ", FILE *" fp );
+.BI "int putspent(const struct spwd *" p ", FILE *" stream );
 .sp
 .B int lckpwdf(void);
 .sp

@@ -46,7 +46,7 @@ lckpwdf, ulckpwdf \- get shadow password file entry
 .br
 .BI "        char *" buf ", size_t " buflen ", struct spwd **" spbufp );
 .sp
-.BI "int fgetspent_r(FILE *" fp ", struct spwd *" spbuf ,
+.BI "int fgetspent_r(FILE *" stream ", struct spwd *" spbuf ,
 .br
 .BI "        char *" buf ", size_t " buflen ", struct spwd **" spbufp );
 .sp

@@ -137,8 +137,8 @@ The
 function writes the contents of the supplied struct
 .I spwd
 .I *p
-as a text line in the shadow password file format to the stream
-.IR fp .
+as a text line in the shadow password file format to the
+.IR stream .
 String entries with value NULL and numerical entries with value \-1
 are written as an empty string.
 .LP
---

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