linux-next: build warning after merge of the ftrace tree

linux-next: build warning after merge of the ftrace tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 348 bytes --]

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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the ftrace tree

[Steven Rostedt]

On Thu, 28 Oct 2021 23:23:45 +1100
Stephen Rothwell <sfr@canb.auug.org.au> 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")
> 

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

[Kalesh Singh]

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 <kaleshsingh@google.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
---
 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

Re: linux-next: build warning after merge of the ftrace tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 540 bytes --]

Hi Steven,

On Thu, 28 Oct 2021 09:16:46 -0400 Steven Rostedt <rostedt@goodmis.org> wrote:
>
> On Thu, 28 Oct 2021 23:23:45 +1100
> Stephen Rothwell <sfr@canb.auug.org.au> 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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the ftrace tree

[Kalesh Singh]

On Thu, Oct 28, 2021 at 2:10 PM Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>
> Hi Steven,
>
> On Thu, 28 Oct 2021 09:16:46 -0400 Steven Rostedt <rostedt@goodmis.org> wrote:
> >
> > On Thu, 28 Oct 2021 23:23:45 +1100
> > Stephen Rothwell <sfr@canb.auug.org.au> 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/20211028170548.2597449-1-kaleshsingh@google.com/

Thanks,
Kalesh

>
> --
> Cheers,
> Stephen Rothwell

Re: linux-next: build warning after merge of the ftrace tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 1004 bytes --]

Hi Kalesh,

On Thu, 28 Oct 2021 14:29:47 -0700 Kalesh Singh <kaleshsingh@google.com> wrote:
>
> On Thu, Oct 28, 2021 at 2:10 PM Stephen Rothwell <sfr@canb.auug.org.au> wrote:
> >
> > On Thu, 28 Oct 2021 09:16:46 -0400 Steven Rostedt <rostedt@goodmis.org> wrote:  
> > >
> > > On Thu, 28 Oct 2021 23:23:45 +1100
> > > Stephen Rothwell <sfr@canb.auug.org.au> 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/20211028170548.2597449-1-kaleshsingh@google.com/

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

Thanks.
-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the ftrace tree

[Steven Rostedt]

On Fri, 29 Oct 2021 08:10:09 +1100
Stephen Rothwell <sfr@canb.auug.org.au> 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