All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Daniel Bristot de Oliveira <bristot@kernel.org>
Cc: Steven Rostedt <rostedt@goodmis.org>,
	Masami Hiramatsu <mhiramat@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Juri Lelli <juri.lelli@redhat.com>,
	Clark Williams <williams@redhat.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH V3 3/3] Documentation/osnoise: Add osnoise/options documentation
Date: Sat, 26 Nov 2022 19:39:41 +0700	[thread overview]
Message-ID: <Y4IJDY2802+x17Ig@debian.me> (raw)
In-Reply-To: <0a8ecf364af29b0c1d5007f4d71265127c114a1f.1669409262.git.bristot@kernel.org>

[-- Attachment #1: Type: text/plain, Size: 1737 bytes --]

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 #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

      reply	other threads:[~2022-11-26 12:39 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-25 21:20 [PATCH V3 0/3] Add osnoise/options options Daniel Bristot de Oliveira
2022-11-25 21:20 ` [PATCH V3 1/3] tracing/osnoise: Add PANIC_ON_STOP option Daniel Bristot de Oliveira
2022-11-25 21:20 ` [PATCH V3 2/3] tracing/osnoise: Add preempt/irq disable options Daniel Bristot de Oliveira
2022-11-28 20:39   ` Steven Rostedt
2022-11-29  8:27     ` Daniel Bristot de Oliveira
2022-11-30 15:47     ` Daniel Bristot de Oliveira
2022-11-30 16:10       ` Steven Rostedt
2022-11-25 21:20 ` [PATCH V3 3/3] Documentation/osnoise: Add osnoise/options documentation Daniel Bristot de Oliveira
2022-11-26 12:39   ` Bagas Sanjaya [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=Y4IJDY2802+x17Ig@debian.me \
    --to=bagasdotme@gmail.com \
    --cc=bristot@kernel.org \
    --cc=corbet@lwn.net \
    --cc=juri.lelli@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=williams@redhat.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.