Re: [PATCH v2 01/39] Documentation/x86: Add CET description

From: Bagas Sanjaya
Date: Fri Sep 30 2022 - 09:41:46 EST


On 9/30/22 20:33, Jonathan Corbet wrote:
>> CET introduces Shadow Stack and Indirect Branch Tracking. Shadow stack is
>> a secondary stack allocated from memory and cannot be directly modified by
>> -applications. When executing a CALL instruction, the processor pushes the
>> +applications. When executing a ``CALL`` instruction, the processor pushes the
>
> Just to be clear, not everybody is fond of sprinkling lots of ``literal
> text`` throughout the documentation in this way. Heavy use of it will
> certainly clutter the plain-text file and can be a net negative overall.
>

Actually there is a trade-off between semantic correctness and plain-text
clarity. With regards to inline code samples (like identifiers), I fall
into the former camp. But when I'm reviewing patches for which the
surrounding documentation go latter camp (leave code samples alone without
markup), I can adapt to that style as long as it causes no warnings
whatsover.

--
An old man doll... just what I always wanted! - Clara