Re: [PATCH V3 3/3] Documentation/osnoise: Add osnoise/options documentation

From: Bagas Sanjaya
Date: Sat Nov 26 2022 - 07:40:28 EST


On Fri, Nov 25, 2022 at 10:20:24PM +0100, Daniel Bristot de Oliveira wrote:
> +Tracer Options
> +--------------
> +
> +The osnoise/options file exposes a set of on/off configuration options for
> +the osnoise tracer. These options are:
> +
> + - DEFAULTS: reset the options to the default value.
> + - OSNOISE_WORKLOAD: do not dispatch osnoise workload (see dedicated
> + section below).
> + - PANIC_ON_STOP: call panic() if the tracer stops. This option serves to
> + capture a vmcore.

Excessive indentation makes PANIC_ON_STOP item above become definition list
instead. I have to make a small fixup:

---- >8 ----

diff --git a/Documentation/trace/osnoise-tracer.rst b/Documentation/trace/osnoise-tracer.rst
index 0641781b00f5e8..f2008e3172231d 100644
--- a/Documentation/trace/osnoise-tracer.rst
+++ b/Documentation/trace/osnoise-tracer.rst
@@ -125,7 +125,7 @@ the osnoise tracer. These options are:
- OSNOISE_WORKLOAD: do not dispatch osnoise workload (see dedicated
section below).
- PANIC_ON_STOP: call panic() if the tracer stops. This option serves to
- capture a vmcore.
+ capture a vmcore.
- OSNOISE_PREEMPT_DISABLE: disable preemption while running the osnoise
workload, allowing only IRQ and hardware-related noise.
- OSNOISE_IRQ_DISABLE: disable IRQs while running the osnoise workload,

> + - OSNOISE_PREEMPT_DISABLE: disable preemption while running the osnoise
> + workload, allowing only IRQ and hardware-related noise.
> + - OSNOISE_IRQ_DISABLE: disable IRQs while running the osnoise workload,
> + allowing only NMIs and hardware-related noise, like hwlat tracer.
> +

Otherwise LGTM.

--
An old man doll... just what I always wanted! - Clara

Attachment: signature.asc
Description: PGP signature