diff mbox series

Documentation/osnoise: escape underscore of NO_ prefix

Message ID 20221125034300.24168-1-bagasdotme@gmail.com
State New
Headers
Series Documentation/osnoise: escape underscore of NO_ prefix |

Commit Message

Bagas Sanjaya Nov. 25, 2022, 3:43 a.m. UTC 
  kernel test robot reported unknown target name warning:

Documentation/trace/osnoise-tracer.rst:112: WARNING: Unknown target name: "no".

The warning causes NO_ prefix to be rendered as link text instead, which
points to non-existent link target.

Escape the prefix underscore to fix the warning.

Link: https://lore.kernel.org/linux-doc/202211240447.HxRNftE5-lkp@intel.com/
Fixes: 67543cd6b8eee5 ("Documentation/osnoise: Add osnoise/options documentation")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/trace/osnoise-tracer.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: bd604f3db49c5b21171abea0414a2020dcbf2646

Comments

Daniel Bristot de Oliveira Nov. 25, 2022, 6:16 p.m. UTC | #1 
On 11/25/22 04:43, Bagas Sanjaya wrote:
> kernel test robot reported unknown target name warning:
> 
> Documentation/trace/osnoise-tracer.rst:112: WARNING: Unknown target name: "no".
> 
> The warning causes NO_ prefix to be rendered as link text instead, which
> points to non-existent link target.
> 
> Escape the prefix underscore to fix the warning.
> 
> Link: https://lore.kernel.org/linux-doc/202211240447.HxRNftE5-lkp@intel.com/
> Fixes: 67543cd6b8eee5 ("Documentation/osnoise: Add osnoise/options documentation")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Acked-by: Daniel Bristot de Oliveira <bristot@kernel.org>

Thanks!
-- Daniel
Steven Rostedt Nov. 28, 2022, 8:50 p.m. UTC | #2 
Jon,

Care to take this?

Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

Thanks,

-- Steve


On Fri, 25 Nov 2022 19:16:56 +0100
Daniel Bristot de Oliveira <bristot@kernel.org> wrote:

> On 11/25/22 04:43, Bagas Sanjaya wrote:
> > kernel test robot reported unknown target name warning:
> > 
> > Documentation/trace/osnoise-tracer.rst:112: WARNING: Unknown target name: "no".
> > 
> > The warning causes NO_ prefix to be rendered as link text instead, which
> > points to non-existent link target.
> > 
> > Escape the prefix underscore to fix the warning.
> > 
> > Link: https://lore.kernel.org/linux-doc/202211240447.HxRNftE5-lkp@intel.com/
> > Fixes: 67543cd6b8eee5 ("Documentation/osnoise: Add osnoise/options documentation")
> > Reported-by: kernel test robot <lkp@intel.com>
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>  
> 
> Acked-by: Daniel Bristot de Oliveira <bristot@kernel.org>
> 
> Thanks!
> -- Daniel
Jonathan Corbet Dec. 3, 2022, 10:35 a.m. UTC | #3 
Steven Rostedt <rostedt@goodmis.org> writes:

> Jon,
>
> Care to take this?
>
> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

I was about to, but it doesn't apply here.  The problem being fixed
seemingly came in through your tree and currently only exists in
linux-next, so I think you need to apply it.

Thanks,

jon
Steven Rostedt Dec. 3, 2022, 1:54 p.m. UTC | #4 
On Sat, 03 Dec 2022 03:35:39 -0700
Jonathan Corbet <corbet@lwn.net> wrote:

> Steven Rostedt <rostedt@goodmis.org> writes:
> 
> > Jon,
> >
> > Care to take this?
> >
> > Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>  
> 
> I was about to, but it doesn't apply here.  The problem being fixed
> seemingly came in through your tree and currently only exists in
> linux-next, so I think you need to apply it.

Thanks, I'll take it then.

-- Steve
diff mbox series

Patch

diff --git a/Documentation/trace/osnoise-tracer.rst b/Documentation/trace/osnoise-tracer.rst
index 3c675ed82b27ae..fdd562d7c22d18 100644
--- a/Documentation/trace/osnoise-tracer.rst
+++ b/Documentation/trace/osnoise-tracer.rst
@@ -111,7 +111,7 @@  The tracer has a set of options inside the osnoise directory, they are:
    be used, which is currently 5 us.
  - osnoise/options: a set of on/off options that can be enabled by
    writing the option name to the file or disabled by writing the option
-   name preceded with the 'NO_' prefix. For example, writing
+   name preceded with the 'NO\_' prefix. For example, writing
    NO_OSNOISE_WORKLOAD disables the OSNOISE_WORKLOAD option. The
    special DEAFAULTS option resets all options to the default value.