lkml.org 
[lkml]   [2023]   [Jun]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[for-next][PATCH] tracing: Fix warnings when building htmldocs for function graph retval
  git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git
trace/for-next

Head SHA1: fc30ace06f250f79381a8e3f6ed92dd68e25a9f5


Donglin Peng (1):
tracing: Fix warnings when building htmldocs for function graph retval

----
Documentation/trace/ftrace.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
---------------------------
commit fc30ace06f250f79381a8e3f6ed92dd68e25a9f5
Author: Donglin Peng <pengdonglin@sangfor.com.cn>
Date: Fri Jun 23 15:17:28 2023 +0800

tracing: Fix warnings when building htmldocs for function graph retval

When building htmldocs, the following warnings appear:

Documentation/trace/ftrace.rst:2797: WARNING: Literal block expected; none found.
Documentation/trace/ftrace.rst:2816: WARNING: Literal block expected; none found.

So fix it.

Link: https://lore.kernel.org/all/20230623143517.19ffc6c0@canb.auug.org.au/
Link: https://lkml.kernel.org/r/20230623071728.25688-1-pengdonglin@sangfor.com.cn

Fixes: 21c094d3f8a6 ("tracing: Add documentation for funcgraph-retval and funcgraph-retval-hex")
Signed-off-by: Donglin Peng <pengdonglin@sangfor.com.cn>
Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
index b7308ab10c0e..f606c5bd1c0d 100644
--- a/Documentation/trace/ftrace.rst
+++ b/Documentation/trace/ftrace.rst
@@ -2792,7 +2792,7 @@ option, and these limitations will be eliminated in the future:
especially when larger types are truncated, whether explicitly or implicitly.
Here are some specific cases to illustrate this point:

- **Case One**::
+ **Case One**:

The function narrow_to_u8 is defined as follows::

@@ -2811,7 +2811,7 @@ option, and these limitations will be eliminated in the future:
If you pass 0x123456789abcdef to this function and want to narrow it,
it may be recorded as 0x123456789abcdef instead of 0xef.

- **Case Two**::
+ **Case Two**:

The function error_if_not_4g_aligned is defined as follows::

\
 
 \ /
  Last update: 2023-06-23 16:46    [W:0.027 / U:0.156 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site