2019-06-18 18:54:07

by Mauro Carvalho Chehab

Subject: [PATCH 1/6] docs: trace: fix a broken label

Sphinx warnings about his:

Documentation/trace/kprobetrace.rst:68: WARNING: undefined label: user_mem_access (if the link has no caption the label must precede a section header)

The problem is quite simple: Sphinx wants a blank line after
references.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/trace/kprobetrace.rst | 1 +
1 file changed, 1 insertion(+)

diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
index b729b40a5ba5..3d162d432a3c 100644
--- a/Documentation/trace/kprobetrace.rst
+++ b/Documentation/trace/kprobetrace.rst
@@ -96,6 +96,7 @@ which shows given pointer in "symbol+offset" style.
For $comm, the default type is "string"; any other type is invalid.

.. _user_mem_access:
+
User Memory Access
------------------
Kprobe events supports user-space memory access. For that purpose, you can use
--
2.21.0

2019-06-19 15:11:33

by Masami Hiramatsu

Subject: Re: [PATCH 1/6] docs: trace: fix a broken label

On Tue, 18 Jun 2019 15:51:17 -0300
Mauro Carvalho Chehab <[email protected]> wrote:

> Sphinx warnings about his:
>
> Documentation/trace/kprobetrace.rst:68: WARNING: undefined label: user_mem_access (if the link has no caption the label must precede a section header)
>
> The problem is quite simple: Sphinx wants a blank line after
> references.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

This also looks good to me.

Acked-by: Masami Hiramatsu <[email protected]>

Thank you,

> ---
> Documentation/trace/kprobetrace.rst | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
> index b729b40a5ba5..3d162d432a3c 100644
> --- a/Documentation/trace/kprobetrace.rst
> +++ b/Documentation/trace/kprobetrace.rst
> @@ -96,6 +96,7 @@ which shows given pointer in "symbol+offset" style.
> For $comm, the default type is "string"; any other type is invalid.
>
> .. _user_mem_access:
> +
> User Memory Access
> ------------------
> Kprobe events supports user-space memory access. For that purpose, you can use
> --
> 2.21.0
>


--
Masami Hiramatsu <[email protected]>

2019-06-20 20:07:30

by Jonathan Corbet

Subject: Re: [PATCH 1/6] docs: trace: fix a broken label

On Tue, 18 Jun 2019 15:51:17 -0300
Mauro Carvalho Chehab <[email protected]> wrote:

> Sphinx warnings about his:
>
> Documentation/trace/kprobetrace.rst:68: WARNING: undefined label: user_mem_access (if the link has no caption the label must precede a section header)
>
> The problem is quite simple: Sphinx wants a blank line after
> references.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/trace/kprobetrace.rst | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
> index b729b40a5ba5..3d162d432a3c 100644
> --- a/Documentation/trace/kprobetrace.rst
> +++ b/Documentation/trace/kprobetrace.rst
> @@ -96,6 +96,7 @@ which shows given pointer in "symbol+offset" style.
> For $comm, the default type is "string"; any other type is invalid.
>
> .. _user_mem_access:

This one doesn't apply to docs-next; it should probably go through
whichever tree introduced the issue into linux-next.

Thanks,

jon