From: Randy Dunlap <rdunlap@infradead.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux Kernel Tracing <linux-trace-kernel@vger.kernel.org>
Cc: "Steven Rostedt" <rostedt@goodmis.org>,
"Masami Hiramatsu" <mhiramat@kernel.org>,
"Mathieu Desnoyers" <mathieu.desnoyers@efficios.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"Shuai Xue" <xueshuai@linux.alibaba.com>,
"Bjorn Helgaas" <bhelgaas@google.com>,
"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
"Swaraj Gaikwad" <swarajgaikwad1925@gmail.com>,
"Stephen Rothwell" <sfr@canb.auug.org.au>
Subject: Re: [PATCH 2/2] Documentation: tracing: Wrap PCI tracepoint examples
Date: Wed, 7 Jan 2026 20:30:06 -0800 [thread overview]
Message-ID: <ce37d2b0-275a-4358-a0be-ffe3aa7ee12b@infradead.org> (raw)
In-Reply-To: <20260108013956.14351-3-bagasdotme@gmail.com>
On 1/7/26 5:39 PM, Bagas Sanjaya wrote:
> Sphinx reports htmldocs warnings:
>
> Documentation/trace/events-pci.rst:43: ERROR: Unexpected indentation. [docutils]
> Documentation/trace/events-pci.rst:74: ERROR: Unexpected indentation. [docutils]
>
> Fix them by wrapping example shell snippets in PCI tracepoint
> documentation in literal code blocks.
>
> Fixes: d0eb853678a21b ("Documentation: tracing: Add PCI tracepoint documentation")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20260105160000.0368ec8d@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> Documentation/trace/events-pci.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/trace/events-pci.rst b/Documentation/trace/events-pci.rst
> index c1ad0fc54777e0..03ff4ad30ddfa1 100644
> --- a/Documentation/trace/events-pci.rst
> +++ b/Documentation/trace/events-pci.rst
> @@ -33,7 +33,7 @@ state changes.
> * ``CARD_PRESENT`` - Card detected in slot
> * ``CARD_NOT_PRESENT`` - Card removed from slot
>
> -**Example Usage**:
> +**Example Usage**::
>
> # Enable the tracepoint
> echo 1 > /sys/kernel/debug/tracing/events/pci/pci_hp_event/enable
> @@ -64,7 +64,7 @@ Monitors PCIe link speed changes and provides detailed link status information.
> - ``4`` - Hotplug event
>
>
> -**Example Usage**:
> +**Example Usage**::
>
> # Enable the tracepoint
> echo 1 > /sys/kernel/debug/tracing/events/pci/pcie_link_event/enable
--
~Randy
next prev parent reply other threads:[~2026-01-08 4:30 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-08 1:39 [PATCH 0/2] PCI tracepoint documentation fixes Bagas Sanjaya
2026-01-08 1:39 ` [PATCH 1/2] Documentation: tracing: Add toctree entry for PCI tracepoint Bagas Sanjaya
2026-01-08 4:30 ` Randy Dunlap
2026-01-08 1:39 ` [PATCH 2/2] Documentation: tracing: Wrap PCI tracepoint examples Bagas Sanjaya
2026-01-08 4:30 ` Randy Dunlap [this message]
2026-01-08 16:06 ` [PATCH 0/2] PCI tracepoint documentation fixes Steven Rostedt
2026-01-08 16:09 ` Bjorn Helgaas
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=ce37d2b0-275a-4358-a0be-ffe3aa7ee12b@infradead.org \
--to=rdunlap@infradead.org \
--cc=bagasdotme@gmail.com \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mhiramat@kernel.org \
--cc=rostedt@goodmis.org \
--cc=sfr@canb.auug.org.au \
--cc=swarajgaikwad1925@gmail.com \
--cc=xueshuai@linux.alibaba.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox