Skip to contentSkip to conversation

PCI tracepoint documentation fixes

PATCH In review Bagas Sanjaya 4 participants 7 messages Jan 8

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

cover PCI tracepoint documentation fixes

Hi,

Here are two fixes for htmldocs warnings on PCI tracepoint docs as reported in linux-next [1]. The shortlog below should be self-explanatory.

Enjoy!

[1]: https://lore.kernel.org/linux-next/[email protected]/

Bagas Sanjaya (2):
Documentation: tracing: Add toctree entry for PCI tracepoint
Documentation: tracing: Wrap PCI tracepoint examples

 Documentation/trace/events-pci.rst | 4 ++--
 Documentation/trace/index.rst      | 1 +
 2 files changed, 3 insertions(+), 2 deletions(-)

base-commit: 29a77b4897f1a0f40209bee929129d4c3f9c7a4b

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/2 Documentation: tracing: Add toctree entry for PCI tracepoint

Sphinx reports missing toctree entry htmldocs warning:

Documentation/trace/events-pci.rst: WARNING: document isn't included in any toctree [toc.not_included]

Fix it by adding the entry for PCI tracepoint documentation.

Fixes d0eb853678a21b ("Documentation: tracing: Add PCI tracepoint documentation")
---
 Documentation/trace/index.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/trace/index.rst +1 -0
index b4a429dc4f7ad6..0a40bfabcf19bf 100644
@@ -54,6 +54,7 @@ applications.
    events-power
    events-nmi
    events-msr
+   events-pci
    boottime-trace
    histogram
    histogram-design
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Acked-by Tested-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] Documentation: tracing: Add toctree entry for PCI tracepoint

Quoted 10 lines · Bagas Sanjaya

Sphinx reports missing toctree entry htmldocs warning:

Documentation/trace/events-pci.rst: WARNING: document isn't included in any toctree [toc.not_included]

Fix it by adding the entry for PCI tracepoint documentation.

Fixes d0eb853678a21b ("Documentation: tracing: Add PCI tracepoint documentation")

Thanks.

Quoted 16 lines
---
 Documentation/trace/index.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/trace/index.rst +1 -0
index b4a429dc4f7ad6..0a40bfabcf19bf 100644
@@ -54,6 +54,7 @@ applications.
    events-power
    events-nmi
    events-msr
+   events-pci
    boottime-trace
    histogram
    histogram-design
Signature · 1 line
~Randy
#3 lore raw

PATCH 2/2 Documentation: tracing: Wrap PCI tracepoint examples

In reply to Bagas Sanjaya

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")
---
 Documentation/trace/events-pci.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/trace/events-pci.rst +2 -2
index c1ad0fc54777e0..03ff4ad30ddfa1 100644
@@ -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
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Acked-by Tested-by on v1 2/2
#4 lore raw

Re: [PATCH 2/2] Documentation: tracing: Wrap PCI tracepoint examples

Quoted 5 lines · Bagas Sanjaya

Sphinx reports htmldocs warnings:

Documentation/trace/events-pci.rst:43: ERROR: Unexpected indentation. [docutils] Documentation/trace/events-pci.rst:74: ERROR: Unexpected indentation. [docutils]

Quoted 7 lines

Fix them by wrapping example shell snippets in PCI tracepoint documentation in literal code blocks.

Fixes d0eb853678a21b ("Documentation: tracing: Add PCI tracepoint documentation")

Thanks.

Quoted 26 lines
---
 Documentation/trace/events-pci.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/trace/events-pci.rst +2 -2
index c1ad0fc54777e0..03ff4ad30ddfa1 100644
@@ -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
Signature · 1 line
~Randy
maintainer Acked-by on the v1 series
#5 lore raw
In reply to Bagas Sanjaya
Quoted 13 lines · On Thu, 8 Jan 2026 08:39:54 +0700 Bagas Sanjaya <[email protected]> wrote:

Hi,

Here are two fixes for htmldocs warnings on PCI tracepoint docs as reported in linux-next [1]. The shortlog below should be self-explanatory.

Enjoy!

[1]: https://lore.kernel.org/linux-next/[email protected]/

Bagas Sanjaya (2):
Documentation: tracing: Add toctree entry for PCI tracepoint
Documentation: tracing: Wrap PCI tracepoint examples

Quoted 6 lines
 Documentation/trace/events-pci.rst | 4 ++--
 Documentation/trace/index.rst      | 1 +
 2 files changed, 3 insertions(+), 2 deletions(-)

base-commit: 29a77b4897f1a0f40209bee929129d4c3f9c7a4b

Fine with me. Jon feel free to take these patches.

-- Steve

#6 lore raw
In reply to Bagas Sanjaya
Quoted 9 lines · Bagas Sanjaya

Hi,

Here are two fixes for htmldocs warnings on PCI tracepoint docs as reported in linux-next [1]. The shortlog below should be self-explanatory.

Enjoy!

[1]: https://lore.kernel.org/linux-next/[email protected]/

Quoted 7 lines

Bagas Sanjaya (2):
Documentation: tracing: Add toctree entry for PCI tracepoint
Documentation: tracing: Wrap PCI tracepoint examples

 Documentation/trace/events-pci.rst | 4 ++--
 Documentation/trace/index.rst      | 1 +
 2 files changed, 3 insertions(+), 2 deletions(-)

These are for the pci/trace branch, which has not been merged into mainline yet, so I squashed these fixes into the "Documentation:
tracing: Add PCI tracepoint documentation" patch on that branch.

Thanks!

Bjorn