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

Bagas Sanjaya posted 2 patches 1 month ago
[PATCH 2/2] Documentation: tracing: Wrap PCI tracepoint examples
Posted by Bagas Sanjaya 1 month ago
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
Posted by Randy Dunlap 1 month ago

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