Re: [PATCH 5/6] Documentation: tracing: Add %return suffix description

From: Masami Hiramatsu
Date: Tue Sep 01 2020 - 01:47:06 EST


On Tue, 1 Sep 2020 07:27:45 +0900
Masami Hiramatsu <mhiramat@xxxxxxxxxx> wrote:

> On Mon, 31 Aug 2020 11:50:20 -0700
> Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>
> > On 8/31/20 5:46 AM, Masami Hiramatsu wrote:
> > > Add a description of the %return suffix option for kprobe tracer.
> > >
> > > Signed-off-by: Masami Hiramatsu <mhiramat@xxxxxxxxxx>
> > > ---
> > > Documentation/trace/kprobetrace.rst | 2 ++
> > > 1 file changed, 2 insertions(+)
> > >
> > > diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
> > > index c1709165c553..d29d1f9e6721 100644
> > > --- a/Documentation/trace/kprobetrace.rst
> > > +++ b/Documentation/trace/kprobetrace.rst
> >
> > Check spacing:
> >
> > > @@ -37,6 +38,7 @@ Synopsis of kprobe_events
> > > based on SYM+offs or MEMADDR.
> > > MOD : Module name which has given SYM.
> > > SYM[+offs] : Symbol+offset where the probe is inserted.
> > > + SYM%return : Return address of the symbol
> > > MEMADDR : Address where the probe is inserted.
> > > MAXACTIVE : Maximum number of instances of the specified function that
> > > can be probed simultaneously, or 0 for the default value
> >
> > If I remove the '+', the ':' lines up but the SYM does not line up.
> > Am I missing something?
> >
> > @@ -37,6 +38,7 @@ Synopsis of kprobe_events
> > based on SYM+offs or MEMADDR.
> > MOD : Module name which has given SYM.
> > SYM[+offs] : Symbol+offset where the probe is inserted.
> > SYM%return : Return address of the symbol
> > MEMADDR : Address where the probe is inserted.
> > MAXACTIVE : Maximum number of instances of the specified function that
> > can be probed simultaneously, or 0 for the default value
> >
>

Shouldn't we use the horizontal tab in .rst ? It seems other lines
use a tab to indent, but this line doesn't (VIM converted the tab to spaces.)

Thank you,

--
Masami Hiramatsu <mhiramat@xxxxxxxxxx>