[PATCH 3/4] Enhance --enable-tunables to select tunables frontend at build time
Joseph Myers
joseph@codesourcery.com
Fri Dec 30 14:55:00 GMT 2016
On Fri, 30 Dec 2016, Siddhesh Poyarekar wrote:
> +@itemize @bullet
> +@item @var{no}
> +This is the default if the option is not passed to configure. This disables
> +tunables.
> +
> +@item @var{yes}
> +This is the default if the option is passed to configure. This enables tunables
> +and selects the default frontend (currently @var{valstring}).
> +
> +@item @var{valstring}
> +This enables tunables and selects the @var{valstring} frontend for tunables.
> +This frontend allows users to specify tunables as a colon-separated list in a
> +single environment variable @var{GLIBC_TUNABLES}.
None of these uses of @var is correct. @var is for a metasyntactic
variable. It is not for environment variables (use @env), and nor is it
for literal text (note how the contents of @var get put in uppercase in
plain text / info output such as the INSTALL file). You probably want
"@table @code" for the list of possible configure option arguments, with
no @var{} or other markup on the individual @item lines (and then use
@samp{valstring} for references to it in the text).
--
Joseph S. Myers
joseph@codesourcery.com
More information about the Libc-alpha
mailing list