From: "Paul A. Clarke" <pc@us.ibm.com>
To: Stephen Brennan <stephen.s.brennan@oracle.com>
Cc: Peter Zijlstra <peterz@infradead.org>,
Ingo Molnar <mingo@redhat.com>,
Arnaldo Carvalho de Melo <acme@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Alexander Shishkin <alexander.shishkin@linux.intel.com>,
Jiri Olsa <jolsa@redhat.com>, Namhyung Kim <namhyung@kernel.org>,
linux-perf-users@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] perf script python: fix unintended underline
Date: Fri, 6 Aug 2021 16:13:48 -0500 [thread overview]
Message-ID: <20210806211348.GA66379@li-24c3614c-2adc-11b2-a85c-85f334518bdb.ibm.com> (raw)
In-Reply-To: <20210806204502.110305-1-stephen.s.brennan@oracle.com>
On Fri, Aug 06, 2021 at 01:45:01PM -0700, Stephen Brennan wrote:
> 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.
I think it would be better to escape the second double-underscore as well,
to prevent the same problem recurring with future changes.
> 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
escape this ^ , too.
> more info on event handlers).
> --
PC
next prev parent reply other threads:[~2021-08-06 21:14 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-06 20:45 [PATCH] perf script python: fix unintended underline Stephen Brennan
2021-08-06 21:13 ` Paul A. Clarke [this message]
2021-08-06 21:28 ` Stephen Brennan
2021-08-06 22:28 ` Paul A. Clarke
2021-08-09 19:55 ` Arnaldo Carvalho de Melo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210806211348.GA66379@li-24c3614c-2adc-11b2-a85c-85f334518bdb.ibm.com \
--to=pc@us.ibm.com \
--cc=acme@kernel.org \
--cc=alexander.shishkin@linux.intel.com \
--cc=jolsa@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
--cc=stephen.s.brennan@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.