[patch 5/7] getpwent_r.3: wfix

[patch 5/7] getpwent_r.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/getpwent_r.3 b/man3/getpwent_r.3
index a9076a9..ac84e3b 100644
--- a/man3/getpwent_r.3
+++ b/man3/getpwent_r.3
@@ -32,7 +32,7 @@ getpwent_r, fgetpwent_r \- get passwd file entry reentrantly
 .br
 .BI "               size_t " buflen ", struct passwd **" pwbufp );
 .sp
-.BI "int fgetpwent_r(FILE *" fp ", struct passwd *" pwbuf ", char *" buf ,
+.BI "int fgetpwent_r(FILE *" stream ", struct passwd *" pwbuf ", char *" buf ,
 .br
 .BI "                size_t " buflen ", struct passwd **" pwbufp );
 .fi
@@ -58,8 +58,8 @@ and
 .BR fgetpwent (3).
 The former reads the next passwd entry from the stream initialized by
 .BR setpwent (3).
-The latter reads the next passwd entry from the stream
-.IR fp .
+The latter reads the next passwd entry from the
+.IR stream .
 .PP
 The \fIpasswd\fP structure is defined in
 .I <pwd.h>
---

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 5/7] getpwent_r.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/getpwent_r.3 b/man3/getpwent_r.3
> index a9076a9..ac84e3b 100644
> --- a/man3/getpwent_r.3
> +++ b/man3/getpwent_r.3
> @@ -32,7 +32,7 @@ getpwent_r, fgetpwent_r \- get passwd file entry reentrantly
>  .br
>  .BI "               size_t " buflen ", struct passwd **" pwbufp );
>  .sp
> -.BI "int fgetpwent_r(FILE *" fp ", struct passwd *" pwbuf ", char *" buf ,
> +.BI "int fgetpwent_r(FILE *" stream ", struct passwd *" pwbuf ", char *" buf ,
>  .br
>  .BI "                size_t " buflen ", struct passwd **" pwbufp );
>  .fi
> @@ -58,8 +58,8 @@ and
>  .BR fgetpwent (3).
>  The former reads the next passwd entry from the stream initialized by
>  .BR setpwent (3).
> -The latter reads the next passwd entry from the stream
> -.IR fp .
> +The latter reads the next passwd entry from the
> +.IR stream .
>  .PP
>  The \fIpasswd\fP structure is defined in
>  .I <pwd.h>
> ---
> 
> 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