2021-10-28 12:26:08

by Stephen Rothwell

[permalink] [raw]
Subject: linux-next: build warning after merge of the ftrace tree

Hi all,

After merging the ftrace tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis start-string without end-string.

Introduced by commit

2d2f6d4b8ce7 ("tracing/histogram: Document expression arithmetic and constants")

--
Cheers,
Stephen Rothwell


Attachments:
(No filename) (499.00 B)
OpenPGP digital signature

2021-10-28 13:19:38

by Steven Rostedt

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the ftrace tree

On Thu, 28 Oct 2021 23:23:45 +1100
Stephen Rothwell <[email protected]> wrote:

> Hi all,
>
> After merging the ftrace tree, today's linux-next build (htmldocs)
> produced this warning:
>
> Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis start-string without end-string.

I have no idea what that means.

-- Steve

>
> Introduced by commit
>
> 2d2f6d4b8ce7 ("tracing/histogram: Document expression arithmetic and constants")
>

2021-10-28 17:07:36

by Kalesh Singh

[permalink] [raw]
Subject: [PATCH] tracing/histogram: Fix documentation inline emphasis warning

This fixes the warning:

Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis
start-string without end-string

The issue was caused by an unescaped '*' character.

Signed-off-by: Kalesh Singh <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
---
Documentation/trace/histogram.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histogram.rst
index e12699abaee8..66ec972dfb78 100644
--- a/Documentation/trace/histogram.rst
+++ b/Documentation/trace/histogram.rst
@@ -1764,7 +1764,7 @@ using the same key and variable from yet another event::
# echo 'hist:key=pid:wakeupswitch_lat=$wakeup_lat+$switchtime_lat ...' >> event3/trigger

Expressions support the use of addition, subtraction, multiplication and
-division operators (+-*/).
+division operators (+-\*/).

Note that division by zero always returns -1.

--
2.33.0.1079.g6e70778dc9-goog

2021-10-28 21:15:27

by Stephen Rothwell

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the ftrace tree

Hi Steven,

On Thu, 28 Oct 2021 09:16:46 -0400 Steven Rostedt <[email protected]> wrote:
>
> On Thu, 28 Oct 2021 23:23:45 +1100
> Stephen Rothwell <[email protected]> wrote:
>
> > After merging the ftrace tree, today's linux-next build (htmldocs)
> > produced this warning:
> >
> > Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis start-string without end-string.
>
> I have no idea what that means.

I assume you need to quote (with '\') the '*' on line 1767 (?).

--
Cheers,
Stephen Rothwell


Attachments:
(No filename) (499.00 B)
OpenPGP digital signature

2021-10-28 21:31:11

by Kalesh Singh

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the ftrace tree

On Thu, Oct 28, 2021 at 2:10 PM Stephen Rothwell <[email protected]> wrote:
>
> Hi Steven,
>
> On Thu, 28 Oct 2021 09:16:46 -0400 Steven Rostedt <[email protected]> wrote:
> >
> > On Thu, 28 Oct 2021 23:23:45 +1100
> > Stephen Rothwell <[email protected]> wrote:
> >
> > > After merging the ftrace tree, today's linux-next build (htmldocs)
> > > produced this warning:
> > >
> > > Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis start-string without end-string.
> >
> > I have no idea what that means.
>
> I assume you need to quote (with '\') the '*' on line 1767 (?).

Hi Stephen,

I also found the problem to be '*' character. I posted a fix at:
https://lore.kernel.org/r/[email protected]/

Thanks,
Kalesh

>
> --
> Cheers,
> Stephen Rothwell

2021-10-28 21:33:10

by Steven Rostedt

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the ftrace tree

On Fri, 29 Oct 2021 08:10:09 +1100
Stephen Rothwell <[email protected]> wrote:

> > > Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis start-string without end-string.
> >
> > I have no idea what that means.
>
> I assume you need to quote (with '\') the '*' on line 1767 (?).

Yeah, I figured that out when Kalesh sent me the patch to fix it ;-)

-- Steve

2021-10-28 22:41:12

by Stephen Rothwell

[permalink] [raw]
Subject: Re: linux-next: build warning after merge of the ftrace tree

Hi Kalesh,

On Thu, 28 Oct 2021 14:29:47 -0700 Kalesh Singh <[email protected]> wrote:
>
> On Thu, Oct 28, 2021 at 2:10 PM Stephen Rothwell <[email protected]> wrote:
> >
> > On Thu, 28 Oct 2021 09:16:46 -0400 Steven Rostedt <[email protected]> wrote:
> > >
> > > On Thu, 28 Oct 2021 23:23:45 +1100
> > > Stephen Rothwell <[email protected]> wrote:
> > >
> > > > After merging the ftrace tree, today's linux-next build (htmldocs)
> > > > produced this warning:
> > > >
> > > > Documentation/trace/histogram.rst:1766: WARNING: Inline emphasis start-string without end-string.
> > >
> > > I have no idea what that means.
> >
> > I assume you need to quote (with '\') the '*' on line 1767 (?).
>
> I also found the problem to be '*' character. I posted a fix at:
> https://lore.kernel.org/r/[email protected]/

Yeah, every now and then I forget to read all my email before replying :-)

Thanks.
--
Cheers,
Stephen Rothwell


Attachments:
(No filename) (499.00 B)
OpenPGP digital signature