linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: Carlos O'Donell <carlos-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>,
	"linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
Subject: Re: [patch 6/7] malloc_info.3: wfix
Date: Fri, 16 Jan 2015 06:45:48 +0100	[thread overview]
Message-ID: <54B8A58C.6060600@gmail.com> (raw)
In-Reply-To: <54B88305.8000509-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>

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/malloc_info.3 b/man3/malloc_info.3
> index c7774f8..f8a487e 100644
> --- a/man3/malloc_info.3
> +++ b/man3/malloc_info.3
> @@ -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.
> 


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

      parent reply	other threads:[~2015-01-16  5:45 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-16  3:18 [patch 6/7] malloc_info.3: wfix Carlos O'Donell
     [not found] ` <54B88305.8000509-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2015-01-16  5:45   ` Michael Kerrisk (man-pages) [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=54B8A58C.6060600@gmail.com \
    --to=mtk.manpages-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
    --cc=carlos-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).