Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2025-01-01 10:45:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: trace-uses.rst: remove bogus c-domain tags

Browse Source 
There are some c-domain tags that are wrong. While this won't
cause problems with Sphinx < 3.0, this cause troubles with
newer versions, as the C parser won't recognize the contents
of the tag, and will drop it from the output.

Let's just place them at literal blocks.

Reviewed-by: Kamalesh Babulal <kamalesh@linux.vnet.ibm.com>
Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-09-26 09:06:17 +02:00
parent 9303c9d5e9
commit d7faad159a
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/trace/ftrace-uses.rst
View File

@ -55,17 +55,17 @@ an ftrace_ops with ftrace:
Both .flags and .private are optional. Only .func is required.
To enable tracing call:
To enable tracing call::
.. c:function:: register_ftrace_function(&ops);
register_ftrace_function(&ops);
To disable tracing call:
To disable tracing call::
.. c:function:: unregister_ftrace_function(&ops);
unregister_ftrace_function(&ops);
The above is defined by including the header:
The above is defined by including the header::
.. c:function:: #include <linux/ftrace.h>
#include <linux/ftrace.h>
The registered callback will start being called some time after the
register_ftrace_function() is called and before it returns. The exact time