getmntent.3: wfix
PATCH 7/7 getmntent.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/getmntent.3 +12 -11
@@ -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 [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]
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 66 lines
Patch against master.
man3/getmntent.3 +12
-12@@ -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.
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