lkml.org 
[lkml]   [2020]   [Nov]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: linux-next: build warning after merge of the ftrace tree
On Mon, 16 Nov 2020 12:43:38 -0500
Steven Rostedt <rostedt@goodmis.org> wrote:

> > After merging the ftrace tree, today's linux-next build (htmldocs)
> > produced this warning:
> >
> > Documentation/trace/ftrace-uses.rst:123: WARNING: Unexpected indentation.
> >
> > Introduced by commit
> >
> > a25d036d939a ("ftrace: Reverse what the RECURSION flag means in the ftrace_ops")
> >
>
> I'm not good at rst markup. Not sure how to fix this.

Looking at the commit in question:

> +Protect your callback
> +=====================
> +
> +As functions can be called from anywhere, and it is possible that a function
> +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:
> +
> + int bit;
> +
> + bit = ftrace_test_recursion_trylock();
> + if (bit < 0)
> + return;

The problem is those literal blocks. The easiest fix will be to just use
the double-colon notation to indicate a literal block, so the paragraph
above would end with "...start your code with::". Note that there's a few
of them to fix.

Thanks,

jon

\
 
 \ /
  Last update: 2020-11-16 20:27    [W:1.233 / U:1.640 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site