linux-kernel - [for-next][PATCH] tracing: Fix warnings when building htmldocs for function graph retval

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [day] [month] [year] [list]

Date:   Fri, 23 Jun 2023 10:45:39 -0400
From:   Steven Rostedt <rostedt@...dmis.org>
To:     LKML <linux-kernel@...r.kernel.org>
Cc:     Masami Hiramatsu <mhiramat@...nel.org>,
        Mark Rutland <mark.rutland@....com>,
        Donglin Peng <pengdonglin@...gfor.com.cn>,
        Stephen Rothwell <sfr@...b.auug.org.au>
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@...gfor.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@...gfor.com.cn>
    Acked-by: Masami Hiramatsu (Google) <mhiramat@...nel.org>
    Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
    Signed-off-by: Steven Rostedt (Google) <rostedt@...dmis.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::