doc: Update NMI-RCU.rst
authorPaul E. McKenney <paulmck@kernel.org>
Fri, 4 Nov 2022 18:00:14 +0000 (11:00 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Wed, 4 Jan 2023 01:27:37 +0000 (17:27 -0800)
This commit updates NMI-RCU.rst to highlight the ancient heritage of
the example code and to discourage wanton compiler "optimizations".

Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Documentation/RCU/NMI-RCU.rst

index 2a92bc6..dff60a8 100644 (file)
@@ -8,7 +8,7 @@ Although RCU is usually used to protect read-mostly data structures,
 it is possible to use RCU to provide dynamic non-maskable interrupt
 handlers, as well as dynamic irq handlers.  This document describes
 how to do this, drawing loosely from Zwane Mwaikambo's NMI-timer
-work in "arch/x86/kernel/traps.c".
+work in an old version of "arch/x86/kernel/traps.c".
 
 The relevant pieces of code are listed below, each followed by a
 brief explanation::
@@ -116,7 +116,7 @@ Answer to Quick Quiz:
 
        This same sad story can happen on other CPUs when using
        a compiler with aggressive pointer-value speculation
-       optimizations.
+       optimizations.  (But please don't!)
 
        More important, the rcu_dereference_sched() makes it
        clear to someone reading the code that the pointer is