public inbox for libc-alpha@sourceware.org
 help / color / mirror / Atom feed
From: Joseph Myers <joseph@codesourcery.com>
To: Siddhesh Poyarekar <siddhesh@sourceware.org>
Cc: <libc-alpha@sourceware.org>
Subject: Re: [PATCH 6/6] User manual documentation for tunables
Date: Mon, 24 Oct 2016 17:22:00 -0000	[thread overview]
Message-ID: <alpine.DEB.2.20.1610241719410.30661@digraph.polyomino.org.uk> (raw)
In-Reply-To: <1477320168-23397-7-git-send-email-siddhesh@sourceware.org>

On Mon, 24 Oct 2016, Siddhesh Poyarekar wrote:

> +the @code{GLIBC_TUNABLES} environment variable by setting it to a string

@env.

> +of colon-separated @code{name=value} pairs.  For example, the following

@var{name}=@var{value}.

> +It is possible to implement multiple 'frontends' for the tunables allowing

Use ` as opening quote in Texinfo.

> +@itemize @bullet
> +@item @var{0} Disable all error reporting.  The alternate allocator is selected
> +and heap corruption detection is in place, but any such errors detected are
> +ignored.  This is currently a supported use, but is not recommended.
> +@item @var{1} Report errors.  The alternate allocator is selected and heap
> +corruption, if detected, is reported as diagnostic messages to @var{stderr} and
> +the program continues execution.
> +@item @var{2} Abort on errors.  The alternate allocator is selected and if heap
> +corruption is detected, the program is ended immediately by calling
> +@code{abort}.
> +@item @var{3} Fully enabled.  The alternate allocator is selected and is fully
> +functional.  That is, if heap corruption is detected, a verbose diagnostic
> +message is printed to @var{stderr} and the program is ended by calling
> +@code{abort}.
> +@end itemize

@var is for metasyntactic variables.  It is not for names of literal C 
language entities such as stderr (use @code) or for integers such as 0, 1, 
2, 3.

> +diverges from normal program behavior by writing to @var{stderr}, which could

Likewise.

-- 
Joseph S. Myers
joseph@codesourcery.com

  reply	other threads:[~2016-10-24 17:22 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-24 14:43 [PATCH v5 0/6] glibc tunables Siddhesh Poyarekar
2016-10-24 14:43 ` [PATCH 3/6] Add framework for tunables Siddhesh Poyarekar
2016-10-24 14:43 ` [PATCH 1/6] Static inline functions for mallopt helpers Siddhesh Poyarekar
2016-10-26 17:51   ` DJ Delorie
2016-10-27  3:12     ` Siddhesh Poyarekar
2016-10-24 14:43 ` [PATCH 2/6] New internal function __access_noerrno Siddhesh Poyarekar
2016-11-08 17:10   ` Adhemerval Zanella
2016-11-08 19:00     ` Siddhesh Poyarekar
2016-11-10  5:47       ` Siddhesh Poyarekar
2016-11-10 12:15         ` Adhemerval Zanella
2016-11-10 13:05           ` Siddhesh Poyarekar
2016-11-10 16:07             ` Adhemerval Zanella
2016-10-24 14:43 ` [PATCH 5/6] Enhance --enable-tunables to select tunables frontend at build time Siddhesh Poyarekar
2016-10-24 14:43 ` [PATCH 6/6] User manual documentation for tunables Siddhesh Poyarekar
2016-10-24 17:22   ` Joseph Myers [this message]
2016-10-26  9:53     ` Siddhesh Poyarekar
2016-10-24 14:43 ` [PATCH 4/6] Initialize tunable list with the GLIBC_TUNABLES environment variable Siddhesh Poyarekar
2016-10-24 15:01   ` Andreas Schwab
2016-10-26  9:48     ` Siddhesh Poyarekar
2016-11-03 10:26 ` [PING][PATCH v5 0/6] glibc tunables Siddhesh Poyarekar
2016-11-08  5:37   ` [PING 2][PATCH " Siddhesh Poyarekar

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=alpine.DEB.2.20.1610241719410.30661@digraph.polyomino.org.uk \
    --to=joseph@codesourcery.com \
    --cc=libc-alpha@sourceware.org \
    --cc=siddhesh@sourceware.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 read-only IMAP folder(s) and NNTP newsgroup(s).