Skip to contentSkip to conversation

Use "FILE * stream" everywhere.

PATCH In review Carlos O'Donell 2 participants 3 messages Jan 16, 2015 2 messages not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

cover Use "FILE * stream" everywhere.

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

Hello Carlos,

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.

Agreed, and thanks for preparing the patches.

Quoted 3 lines

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

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

A message that is not in the archive (sent off-list or not yet received): [email protected]

#4 lore raw
Quoted 16 lines · Michael Kerrisk (man-pages)

Hello Carlos,

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.

Agreed, and thanks for preparing the patches.

Quoted 3 lines

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.

Quoted 7 lines

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 [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html