From: Masami Hiramatsu (Google) <mhiramat@kernel.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: linux-trace-kernel@vger.kernel.org, linux-kernel@vger.kernel.org,
Steven Rostedt <rostedt@goodmis.org>,
Florent Revest <revest@chromium.org>,
Mark Rutland <mark.rutland@arm.com>,
Will Deacon <will@kernel.org>,
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
Martin KaFai Lau <martin.lau@linux.dev>,
bpf@vger.kernel.org
Subject: Re: [PATCH v11 11/11] Documentation: tracing/probes: Add fprobe event tracing document
Date: Wed, 17 May 2023 23:39:12 +0900 [thread overview]
Message-ID: <20230517233912.29d69e26b9a20e9d11e1448e@kernel.org> (raw)
In-Reply-To: <ZGTRMsLQ3QqvCGew@debian.me>
On Wed, 17 May 2023 20:05:54 +0700
Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> On Wed, May 17, 2023 at 08:00:29PM +0900, Masami Hiramatsu (Google) wrote:
> > +As same as other dynamic events, fprobe events and tracepoint probe
> > +events are defined via `dynamic_events` interface file on tracefs.
>
> Backquotes are rendered as italics instead. If you mean keyword/identifier,
> inline it with double backquotes (like ``foo``). Or you can skip formatting
> it instead (to be consistent with other keywords).
Oops, thanks for pointing it out!
Let me fix that.
>
> > +For the details of TYPE, see :file:`Documentation/trace/kprobetrace.rst`.
>
> Did you mean using :doc: directive instead?
Yes, I will fix that.
>
> ---- >8 ----
> diff --git a/Documentation/trace/fprobetrace.rst b/Documentation/trace/fprobetrace.rst
> index eca64ad7216a1c..0cf8ed84bd6651 100644
> --- a/Documentation/trace/fprobetrace.rst
> +++ b/Documentation/trace/fprobetrace.rst
> @@ -64,7 +64,7 @@ Synopsis of fprobe-events
> (\*4) this is useful for fetching a field of data structures.
> (\*5) "u" means user-space dereference.
>
> -For the details of TYPE, see :file:`Documentation/trace/kprobetrace.rst`.
> +For the details of TYPE, see :doc:`kprobetrace`.
>
> BTF arguments
> -------------
>
> On the other hand, you can also directly link to intended doc section:
>
> ---- >8 ----
> diff --git a/Documentation/trace/fprobetrace.rst b/Documentation/trace/fprobetrace.rst
> index eca64ad7216a1c..83892c7512726c 100644
> --- a/Documentation/trace/fprobetrace.rst
> +++ b/Documentation/trace/fprobetrace.rst
> @@ -64,7 +64,7 @@ Synopsis of fprobe-events
> (\*4) this is useful for fetching a field of data structures.
> (\*5) "u" means user-space dereference.
>
> -For the details of TYPE, see :file:`Documentation/trace/kprobetrace.rst`.
> +For the details of TYPE, see :ref:`kprobetrace documentation <kprobetrace_types>`.
Good catch! Thanks!
>
> BTF arguments
> -------------
> diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
> index 651f9ab53f3ee9..8a2dfee3814544 100644
> --- a/Documentation/trace/kprobetrace.rst
> +++ b/Documentation/trace/kprobetrace.rst
> @@ -66,6 +66,8 @@ Synopsis of kprobe_events
> (\*3) this is useful for fetching a field of data structures.
> (\*4) "u" means user-space dereference. See :ref:`user_mem_access`.
>
> +.. _kprobetrace_types:
> +
> Types
> -----
> Several types are supported for fetchargs. Kprobe tracer will access memory
>
> Thanks.
>
> --
> An old man doll... just what I always wanted! - Clara
--
Masami Hiramatsu (Google) <mhiramat@kernel.org>
prev parent reply other threads:[~2023-05-17 14:39 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-17 10:58 [PATCH v11 00/11] tracing: Add fprobe/tracepoint events Masami Hiramatsu (Google)
2023-05-17 10:58 ` [PATCH v11 01/11] fprobe: Pass return address to the handlers Masami Hiramatsu (Google)
2023-05-17 10:59 ` [PATCH v11 02/11] tracing/probes: Add fprobe events for tracing function entry and exit Masami Hiramatsu (Google)
2023-06-08 20:52 ` Steven Rostedt
2023-07-07 14:17 ` Masami Hiramatsu
2023-05-17 10:59 ` [PATCH v11 03/11] selftests/ftrace: Add fprobe related testcases Masami Hiramatsu (Google)
2023-05-17 10:59 ` [PATCH v11 04/11] tracing/probes: Add tracepoint support on fprobe_events Masami Hiramatsu (Google)
2023-05-17 10:59 ` [PATCH v11 05/11] tracing/probes: Move event parameter fetching code to common parser Masami Hiramatsu (Google)
2023-05-17 10:59 ` [PATCH v11 06/11] tracing/probes: Support function parameters if BTF is available Masami Hiramatsu (Google)
2023-05-17 10:59 ` [PATCH v11 07/11] tracing/probes: Add $arg* meta argument for all function args Masami Hiramatsu (Google)
2023-05-17 11:00 ` [PATCH v11 08/11] tracing/probes: Add BTF retval type support Masami Hiramatsu (Google)
2023-05-17 11:00 ` [PATCH v11 09/11] selftests/ftrace: Add tracepoint probe test case Masami Hiramatsu (Google)
2023-05-17 14:37 ` Masami Hiramatsu
2023-05-17 11:00 ` [PATCH v11 10/11] selftests/ftrace: Add BTF arguments test cases Masami Hiramatsu (Google)
2023-05-17 11:00 ` [PATCH v11 11/11] Documentation: tracing/probes: Add fprobe event tracing document Masami Hiramatsu (Google)
2023-05-17 13:05 ` Bagas Sanjaya
2023-05-17 14:39 ` Masami Hiramatsu [this message]
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=20230517233912.29d69e26b9a20e9d11e1448e@kernel.org \
--to=mhiramat@kernel.org \
--cc=bagasdotme@gmail.com \
--cc=bpf@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=martin.lau@linux.dev \
--cc=mathieu.desnoyers@efficios.com \
--cc=revest@chromium.org \
--cc=rostedt@goodmis.org \
--cc=will@kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).