Skip to contentSkip to conversation

fclose.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
#0 lore raw

PATCH 2/7 fclose.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/fclose.3 +4 -4
index 28c0d00..b07d444 100644
@@ -47,12 +47,12 @@ fclose \- close a stream
 .SH SYNOPSIS
 .B #include <stdio.h>
 .sp
-.BI "int fclose(FILE *" fp );
+.BI "int fclose(FILE *" stream );
 .SH DESCRIPTION
 The
 .BR fclose ()
 function flushes the stream pointed to by
-.I fp
+.I stream
 (writing any buffered output data using
 .BR fflush (3))
 and closes the underlying file descriptor.
@@ -71,12 +71,12 @@ to the stream results in undefined behavior.
 .TP
 .B EBADF
 The file descriptor underlying
-.I fp
+.I stream
 is not valid.
 .\"  This error cannot occur unless you are mixing ANSI C stdio operations and
 .\"  low-level file operations on the same stream. If you do get this error,
 .\"  you must have closed the stream's low-level file descriptor using
-.\"  something like close(fileno(fp)).
+.\"  something like close(fileno(stream)).
 .PP
 The
 .BR fclose ()

---

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 40 lines
man3/fclose.3 +4 -5
index 28c0d00..b07d444 100644
@@ -47,12 +47,12 @@ fclose \- close a stream
 .SH SYNOPSIS
 .B #include <stdio.h>
 .sp
-.BI "int fclose(FILE *" fp );
+.BI "int fclose(FILE *" stream );
 .SH DESCRIPTION
 The
 .BR fclose ()
 function flushes the stream pointed to by
-.I fp
+.I stream
 (writing any buffered output data using
 .BR fflush (3))
 and closes the underlying file descriptor.
@@ -71,12 +71,12 @@ to the stream results in undefined behavior.
 .TP
 .B EBADF
 The file descriptor underlying
-.I fp
+.I stream
 is not valid.
 .\"  This error cannot occur unless you are mixing ANSI C stdio operations and
 .\"  low-level file operations on the same stream. If you do get this error,
 .\"  you must have closed the stream's low-level file descriptor using
-.\"  something like close(fileno(fp)).
+.\"  something like close(fileno(stream)).
 .PP
 The
 .BR fclose ()
---

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