Re: [PATCH v11 11/11] Documentation: tracing/probes: Add fprobe event tracing document

[Google]

On Wed, 17 May 2023 20:05:54 +0700
Bagas Sanjaya <bagasdotme@xxxxxxxxx> 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@xxxxxxxxxx>