[patch 4/7] putgrent.3: wfix

[patch 4/7] putgrent.3: wfix

[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.

Patch against master.

diff --git a/man3/putgrent.3 b/man3/putgrent.3
index 0d59c82..5954626 100644
--- a/man3/putgrent.3
+++ b/man3/putgrent.3
@@ -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 majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [patch 4/7] putgrent.3: wfix

[Michael Kerrisk (man-pages)]

On 01/16/2015 04:18 AM, Carlos O'Donell wrote:
> 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



> Patch against master.
> 
> diff --git a/man3/putgrent.3 b/man3/putgrent.3
> index 0d59c82..5954626 100644
> --- a/man3/putgrent.3
> +++ b/man3/putgrent.3
> @@ -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.
> 


-- 
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 majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html