Re: [PATCH v2 1/6] Add AutoFDO support for Clang build

From: Jonathan Corbet
Date: Sat Oct 05 2024 - 10:43:13 EST


Kees Cook <kees@xxxxxxxxxx> writes:

> The tradition in kernel .rst is to do this with the trailing "::", e.g.:
>
> +Configure the kernel with::
> +
> + CONFIG_AUTOFDO_CLANG=y
>
> This loses the language-specific highlighting when rendered. Perhaps the
> "::" extension can be further extended?
>
> +Configure the kernel with::(make)
> +
> + CONFIG_AUTOFDO_CLANG=y
>
> Then we could avoid the extra 2 lines but still gain the rendered language
> highlights?

The :: notation is standard Sphinx, not an extension we have done. So
the proposed syntax would have to be done from the beginning, I'm not
sure how easy or hard that would be, or whether it would be worth it.
But then, I've always seen relatively little value in the highlighting;
others clearly differ.

Thanks,

jon