[PATCH 0/2] PCI tracepoint documentation fixes

[PATCH 0/2] PCI tracepoint documentation fixes

[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/20260105160000.0368ec8d@canb.auug.org.au/

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
-- 
An old man doll... just what I always wanted! - Clara

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

[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")
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>
---
 Documentation/trace/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index b4a429dc4f7ad6..0a40bfabcf19bf 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -54,6 +54,7 @@ applications.
    events-power
    events-nmi
    events-msr
+   events-pci
    boottime-trace
    histogram
    histogram-design
-- 
An old man doll... just what I always wanted! - Clara

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

[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")
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>
---
 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
-- 
An old man doll... just what I always wanted! - Clara

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

[Randy Dunlap]

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

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

[Randy Dunlap]

On 1/7/26 5:39 PM, Bagas Sanjaya wrote:
> 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")
> 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/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
> index b4a429dc4f7ad6..0a40bfabcf19bf 100644
> --- a/Documentation/trace/index.rst
> +++ b/Documentation/trace/index.rst
> @@ -54,6 +54,7 @@ applications.
>     events-power
>     events-nmi
>     events-msr
> +   events-pci
>     boottime-trace
>     histogram
>     histogram-design

-- 
~Randy

Re: [PATCH 0/2] PCI tracepoint documentation fixes

[Steven Rostedt]

On Thu,  8 Jan 2026 08:39:54 +0700
Bagas Sanjaya <bagasdotme@gmail.com> 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/20260105160000.0368ec8d@canb.auug.org.au/
> 
> 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

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

Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

-- Steve

Re: [PATCH 0/2] PCI tracepoint documentation fixes

[Bjorn Helgaas]

On Thu, Jan 08, 2026 at 08:39:54AM +0700, Bagas Sanjaya 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/20260105160000.0368ec8d@canb.auug.org.au/
> 
> 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