Re: [PATCH V7 11/16] Documentation/rv: Add deterministic automata instrumentation documentation

From: Steven Rostedt <rostedt@goodmis.org>
To: Daniel Bristot de Oliveira <bristot@kernel.org>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>,
	Guenter Roeck <linux@roeck-us.net>,
	Jonathan Corbet <corbet@lwn.net>, Ingo Molnar <mingo@redhat.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	Peter Zijlstra <peterz@infradead.org>,
	Will Deacon <will@kernel.org>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Marco Elver <elver@google.com>,
	Dmitry Vyukov <dvyukov@google.com>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Gabriele Paoloni <gpaoloni@redhat.com>,
	Juri Lelli <juri.lelli@redhat.com>,
	Clark Williams <williams@redhat.com>,
	Tao Zhou <tao.zhou@linux.dev>,
	Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-trace-devel@vger.kernel.org
Subject: Re: [PATCH V7 11/16] Documentation/rv: Add deterministic automata instrumentation documentation
Date: Tue, 26 Jul 2022 12:31:50 -0400	[thread overview]
Message-ID: <20220726123150.208e7a17@gandalf.local.home> (raw)
In-Reply-To: <9ed16a6d24b9d993e09755d6e18ff5e7d5434636.1658778484.git.bristot@kernel.org>

On Mon, 25 Jul 2022 22:11:23 +0200
Daniel Bristot de Oliveira <bristot@kernel.org> wrote:

> +++ b/Documentation/trace/rv/da_monitor_instrumentation.rst
> @@ -0,0 +1,171 @@

> +Finally, the "handle_sched_waking()" will look like::
> +
> +  void handle_sched_waking(void *data, struct task_struct *task)
> +  {
> +        da_handle_event_wip(sched_waking_wip);
> +  }
> +
> +And the explanation is left for the reader as an exercise.
> +
> +enable and disable functions
> +------------------------

The doc processing requires that the '-' count matches the above string
count. And you may want to capitalize the first letter:

Enable and disable functions
----------------------------

-- Steve

> +
> +dot2k automatically creates two special functions::
> +
> +  enable_$(MONITOR_NAME)()
> +  disable_$(MONITOR_NAME)()
> +