Re: [PATCH 6/6] User manual documentation for tunables

[Siddhesh Poyarekar <siddhesh at sourceware dot org>]

On Monday 24 October 2016 10:51 PM, Joseph Myers wrote:
> 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.
> 

Thanks, fixed all this and more in my local copy.

Siddhesh