Commit d7faad15 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

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



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: default avatarKamalesh Babulal <kamalesh@linux.vnet.ibm.com>
Acked-by: default avatarSteven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 9303c9d5

Documentation/trace/ftrace-uses.rst

+6 −6
Original line number Diff line number Diff line
@@ -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