Thread (5 messages) flat view 5 messages, 3 authors, 2021-08-09

Re: [PATCH] perf script python: fix unintended underline

From: Arnaldo Carvalho de Melo <acme@kernel.org>
Date: 2021-08-09 19:55:34
Also in: lkml

Em Fri, Aug 06, 2021 at 01:45:01PM -0700, Stephen Brennan escreveu:
The text ranging from "subsystem__event_name" to
"raw_syscalls__sys_enter()" is interpreted by asciidoc as a pair of
unconstrained text formatting markers. The result is that the manual
page displayed this text as underlined, and the HTML pages displayed
this text as italicized. Escape the first double-underscore to prevent
this.

https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/
Thanks, applied.

- Arnaldo

 
quoted hunk ↗ jump to hunk
Signed-off-by: Stephen Brennan <redacted>
---
 tools/perf/Documentation/perf-script-python.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt
index 5e43cfa5ea1e..0250dc61cf98 100644
--- a/tools/perf/Documentation/perf-script-python.txt
+++ b/tools/perf/Documentation/perf-script-python.txt
@@ -167,7 +167,7 @@ below).
 
 Following those are the 'event handler' functions generated one for
 every event in the 'perf record' output.  The handler functions take
-the form subsystem__event_name, and contain named parameters, one for
+the form subsystem\__event_name, and contain named parameters, one for
 each field in the event; in this case, there's only one event,
 raw_syscalls__sys_enter().  (see the EVENT HANDLERS section below for
 more info on event handlers).
-- 
2.30.2
-- 

- Arnaldo
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help