[patch 0/7] Use "FILE * stream" everywhere.

[patch 0/7] Use "FILE * stream" everywhere.

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

The next 7 patches convert all instances of "FILE *fp" to
"FILE *stream". The vast majority of man pages already use
the "FILE *stream" version which I also prefer.

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 0/7] Use "FILE * stream" everywhere.

[Michael Kerrisk (man-pages)]

Hello Carlos,

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.

Agreed, and thanks for preparing the patches.

> The next 7 patches convert all instances of "FILE *fp" to
> "FILE *stream". The vast majority of man pages already use
> the "FILE *stream" version which I also prefer.

Yes, good. It's what POSIX uses too.

I tweaked some wordings very slightly (adding or removing "the" 
in a couple of places), and gave the patches the title:

    Consistency fix: use "stream" as name for "FILE *" argument

I also made related changes in fmemopen(3), fopencookie(3), and
getline(3).

Thanks,

Michael


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

Re: [patch 0/7] Use "FILE * stream" everywhere.

[Carlos O'Donell]

On 01/16/2015 01:12 AM, Michael Kerrisk (man-pages) wrote:
> Hello Carlos,
> 
> 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.
> 
> Agreed, and thanks for preparing the patches.
> 
>> The next 7 patches convert all instances of "FILE *fp" to
>> "FILE *stream". The vast majority of man pages already use
>> the "FILE *stream" version which I also prefer.
> 
> Yes, good. It's what POSIX uses too.
> 
> I tweaked some wordings very slightly (adding or removing "the" 
> in a couple of places), and gave the patches the title:
> 
>     Consistency fix: use "stream" as name for "FILE *" argument
> 
> I also made related changes in fmemopen(3), fopencookie(3), and
> getline(3).

Thanks!

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