public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Shawn Lin <shawn.lin@rock-chips.com>,
	Manivannan Sadhasivam <mani@kernel.org>,
	Bjorn Helgaas <bhelgaas@google.com>
Cc: linux-rockchip@lists.infradead.org, linux-pci@vger.kernel.org,
	linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	Steven Rostedt <rostedt@goodmis.org>,
	Masami Hiramatsu <mhiramat@kernel.org>
Subject: Re: [PATCH v2 2/3] Documentation: tracing: Add PCI controller event documentation
Date: Fri, 9 Jan 2026 10:53:14 +0700	[thread overview]
Message-ID: <aWB7qtKhzbEoY8pJ@archie.me> (raw)
In-Reply-To: <1767929389-143957-3-git-send-email-shawn.lin@rock-chips.com>

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

On Fri, Jan 09, 2026 at 11:29:48AM +0800, Shawn Lin wrote:
>  Documentation/trace/events-pci-conotroller.rst | 41 ++++++++++++++++++++++++++

Missing toctree entry in Documentation/trace/index.rst.

> +Available Tracepoints
> +=====================
> +
> +pcie_ltssm_state_transition
> +-----------------------

Please match section underline length.

> +**Example Usage**:
> +
> +    # Enable the tracepoint
> +    echo 1 > /sys/kernel/debug/tracing/events/pci/pcie_ltssm_state_transition/enable
> +
> +    # Monitor events (the following output is generated when a device is linking)
> +    cat /sys/kernel/debug/tracing/trace_pipe
> +       kworker/0:0-9       [000] .....     5.600221: pcie_ltssm_state_transition: dev: a40000000.pcie state: RCVRY_EQ2 rate: 8.0 GT/s

Wrap above example snippets in literal code block (use double colon).

Thanks.

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2026-01-09  3:53 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-09  3:29 [PATCH v2 0/3] PCI Controller event and LTSSM tracepoint support Shawn Lin
2026-01-09  3:29 ` [PATCH v2 1/3] PCI: trace: Add PCI controller LTSSM transition tracepoint Shawn Lin
2026-01-09  3:42   ` Steven Rostedt
2026-01-09  3:29 ` [PATCH v2 2/3] Documentation: tracing: Add PCI controller event documentation Shawn Lin
2026-01-09  3:53   ` Bagas Sanjaya [this message]
2026-01-09  5:19   ` Manivannan Sadhasivam
2026-01-09 20:08   ` kernel test robot
2026-01-09 20:18   ` Bjorn Helgaas
2026-01-09  3:29 ` [PATCH v2 3/3] PCI: dw-rockchip: Add pcie_ltssm_state_transition trace support Shawn Lin
2026-01-09  5:55   ` Manivannan Sadhasivam
2026-01-09  6:22     ` Shawn Lin
2026-01-09  7:33       ` Manivannan Sadhasivam

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=aWB7qtKhzbEoY8pJ@archie.me \
    --to=bagasdotme@gmail.com \
    --cc=bhelgaas@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=linux-rockchip@lists.infradead.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=mani@kernel.org \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=shawn.lin@rock-chips.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