Skip to contentSkip to conversation

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

Carlos O'Donell

author
#0 lore raw

PATCH 6/7 malloc_info.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/malloc_info.3 +2 -2
index c7774f8..f8a487e 100644
@@ -29,7 +29,7 @@ malloc_info \- export malloc state to a stream
 .nf
 .B #include <malloc.h>
 .sp
-.BI "int malloc_info(int " options ", FILE *" fp );
+.BI "int malloc_info(int " options ", FILE *" stream );
 .fi
 .SH DESCRIPTION
 The

@@ -38,7 +38,7 @@ function exports an XML string that describes the current state
 of the memory-allocation
 implementation in the caller.
 The string is printed on the file stream
-.IR fp .
+.IR stream .
 The exported string includes information about all arenas (see
 .BR malloc (3)).

---

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

Patch against master.

man3/malloc_info.3 +2 -3
index c7774f8..f8a487e 100644
@@ -29,7 +29,7 @@ malloc_info \- export malloc state to a stream
 .nf
 .B #include <malloc.h>
 .sp
-.BI "int malloc_info(int " options ", FILE *" fp );
+.BI "int malloc_info(int " options ", FILE *" stream );
 .fi
 .SH DESCRIPTION
 The

@@ -38,7 +38,7 @@ function exports an XML string that describes the current state
 of the memory-allocation
 implementation in the caller.
 The string is printed on the file stream
-.IR fp .
+.IR stream .
 The exported string includes information about all arenas (see
 .BR malloc (3)).
 
---

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