Skip to contentSkip to conversation

putgrent.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 4/7 putgrent.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/putgrent.3 +2 -3
index 0d59c82..5954626 100644
@@ -12,7 +12,7 @@ putgrent \- write a group database entry to a file
 .br
 .B #include <grp.h>
 .sp
-.BI "int putgrent(const struct group *" grp ", FILE *" fp );
+.BI "int putgrent(const struct group *" grp ", FILE *" stream );
 .SH DESCRIPTION
 The
 .BR putgrent ()

@@ -21,8 +21,7 @@ function is the counterpart for
 The function writes the content of the provided
 .IR "struct group"
 into the
-file pointed to by
-.IR fp .
+.IR stream .
 The list of group members must be NULL-terminated or NULL-initialized.
 .sp
 The

---

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

Patch against master.

man3/putgrent.3 +2 -4
index 0d59c82..5954626 100644
@@ -12,7 +12,7 @@ putgrent \- write a group database entry to a file
 .br
 .B #include <grp.h>
 .sp
-.BI "int putgrent(const struct group *" grp ", FILE *" fp );
+.BI "int putgrent(const struct group *" grp ", FILE *" stream );
 .SH DESCRIPTION
 The
 .BR putgrent ()

@@ -21,8 +21,7 @@ function is the counterpart for
 The function writes the content of the provided
 .IR "struct group"
 into the
-file pointed to by
-.IR fp .
+.IR stream .
 The list of group members must be NULL-terminated or NULL-initialized.
 .sp
 The
---

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