summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteven Rostedt (VMware) <rostedt@goodmis.org>2020-11-16 15:46:52 -0500
committerSteven Rostedt (VMware) <rostedt@goodmis.org>2020-11-18 11:45:23 -0500
commit3a37b918946e04da7902b83917764f73cc0bd90c (patch)
treee1c9322425bc873d80dafc74f04864da6ac95d7b
parent76980f5fa06d505879ba936b1b5066a056991de0 (diff)
downloadlinux-3a37b918946e04da7902b83917764f73cc0bd90c.tar.gz
linux-3a37b918946e04da7902b83917764f73cc0bd90c.tar.bz2
linux-3a37b918946e04da7902b83917764f73cc0bd90c.zip
ftrace/documentation: Fix RST C code blocks
Some C code in the ftrace-users.rst document is missing RST C block annotation, which has to be added. Link: https://lore.kernel.org/r/20201116173502.392a769c@canb.auug.org.au Acked-by: Jonathan Corbet <corbet@lwn.net> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
-rw-r--r--Documentation/trace/ftrace-uses.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/trace/ftrace-uses.rst b/Documentation/trace/ftrace-uses.rst
index 5981d5691745..f7d98ae5b885 100644
--- a/Documentation/trace/ftrace-uses.rst
+++ b/Documentation/trace/ftrace-uses.rst
@@ -116,6 +116,8 @@ called by a callback may also be traced, and call that same callback,
recursion protection must be used. There are two helper functions that
can help in this regard. If you start your code with:
+.. code-block:: c
+
int bit;
bit = ftrace_test_recursion_trylock(ip, parent_ip);
@@ -124,6 +126,8 @@ can help in this regard. If you start your code with:
and end it with:
+.. code-block:: c
+
ftrace_test_recursion_unlock(bit);
The code in between will be safe to use, even if it ends up calling a
@@ -145,6 +149,8 @@ protection, it is best to make sure that RCU is "watching", otherwise
that data or critical section will not be protected as expected. In this
case add:
+.. code-block:: c
+
if (!rcu_is_watching())
return;