[for-next][PATCH 22/25] Documentation/osnoise: Escape underscore of NO_ prefix
From: Steven Rostedt
Date: Sat Dec 10 2022 - 08:59:43 EST
From: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
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://lkml.kernel.org/r/20221125034300.24168-1-bagasdotme@xxxxxxxxx
Cc: Masami Hiramatsu <mhiramat@xxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx>
Cc: Ammar Faizi <ammarfaizi2@xxxxxxxxxxx>
Cc: GNU/Weeb Mailing List <gwml@xxxxxxxxxxxxxxxx>
Link: https://lore.kernel.org/linux-doc/202211240447.HxRNftE5-lkp@xxxxxxxxx/
Fixes: 67543cd6b8eee5 ("Documentation/osnoise: Add osnoise/options documentation")
Reported-by: kernel test robot <lkp@xxxxxxxxx>
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
Acked-by: Daniel Bristot de Oliveira <bristot@xxxxxxxxxx>
Signed-off-by: Steven Rostedt (Google) <rostedt@xxxxxxxxxxx>
---
Documentation/trace/osnoise-tracer.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/trace/osnoise-tracer.rst b/Documentation/trace/osnoise-tracer.rst
index 3c675ed82b27..fdd562d7c22d 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.
--
2.35.1