linux-kernel - Re: [PATCH] perf script python: fix unintended underline

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <YRGIMJlG/HPh3y4U@kernel.org>
Date:   Mon, 9 Aug 2021 16:55:28 -0300
From:   Arnaldo Carvalho de Melo <acme@...nel.org>
To:     Stephen Brennan <stephen.s.brennan@...cle.com>
Cc:     Peter Zijlstra <peterz@...radead.org>,
        Ingo Molnar <mingo@...hat.com>,
        Mark Rutland <mark.rutland@....com>,
        Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
        Jiri Olsa <jolsa@...hat.com>,
        Namhyung Kim <namhyung@...nel.org>,
        linux-perf-users@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] perf script python: fix unintended underline

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

 
> Signed-off-by: Stephen Brennan <stephen.s.brennan@...cle.com>
> ---
>  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