Thread (222 messages) 222 messages, 21 authors, 2022-11-03

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

From: Jonathan Corbet <corbet@lwn.net>
Date: 2022-09-30 13:33:20
Also in: linux-arch, linux-doc, linux-mm, lkml

Bagas Sanjaya [off-list ref] writes:
quoted hunk ↗ jump to hunk
The documentation above can be improved (both grammar and formatting):

---- >8 ----
diff --git a/Documentation/x86/cet.rst b/Documentation/x86/cet.rst
index 6b270a24ebc3a2..f691f7995cf088 100644
--- a/Documentation/x86/cet.rst
+++ b/Documentation/x86/cet.rst
@@ -15,92 +15,101 @@ in the 64-bit kernel.
 
 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.

Thanks,

jon
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help