[PATCH 0/3] misc devices formatting devices

[PATCH 0/3] misc devices formatting devices

[Bagas Sanjaya]

Hi,

Here is a small docs formatting cleanup for assorted miscellaneous devices.
Patches [2-3/3] are split from my previous macro references fixup patch [1].

Enjoy!

[1]: https://lore.kernel.org/linux-doc/20251104022242.19224-1-bagasdotme@gmail.com/

Bagas Sanjaya (3):
  Documentation: amd-sbi: Wrap miscdevice listing snippet in literal
    code block
  Documentation: mrvl-cn10k-dpi: Fix macro cross-reference syntax
  Documentation: tps6594-pfsm: Fix macro cross-reference syntax

 Documentation/misc-devices/amd-sbi.rst        |  6 ++++--
 Documentation/misc-devices/mrvl_cn10k_dpi.rst |  4 ++--
 Documentation/misc-devices/tps6594-pfsm.rst   | 12 ++++++------
 3 files changed, 12 insertions(+), 10 deletions(-)


base-commit: 27600b51fbc8b9a4eba18c8d88d7edb146605f3f
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/3] Documentation: amd-sbi: Wrap miscdevice listing snippet in literal code block

[Bagas Sanjaya]

Device file listing (ls output) is shown as long-running paragraph
instead. Wrap it in literal code block.

Fixes: 4d95514d14e874 ("misc: amd-sbi: Add document for AMD SB IOCTL description")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/misc-devices/amd-sbi.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/misc-devices/amd-sbi.rst b/Documentation/misc-devices/amd-sbi.rst
index 5648fc6ec5726a..07ceb44fbe5e19 100644
--- a/Documentation/misc-devices/amd-sbi.rst
+++ b/Documentation/misc-devices/amd-sbi.rst
@@ -28,8 +28,10 @@ MCAMSR and register xfer commands.
 Register sets is common across APML protocols. IOCTL is providing synchronization
 among protocols as transactions may create race condition.
 
-$ ls -al /dev/sbrmi-3c
-crw-------    1 root     root       10,  53 Jul 10 11:13 /dev/sbrmi-3c
+.. code-block:: bash
+
+   $ ls -al /dev/sbrmi-3c
+   crw-------    1 root     root       10,  53 Jul 10 11:13 /dev/sbrmi-3c
 
 apml_sbrmi driver registers hwmon sensors for monitoring power_cap_max,
 current power consumption and managing power_cap.
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/3] Documentation: mrvl-cn10k-dpi: Fix macro cross-reference syntax

[Bagas Sanjaya]

C macro references are erroneously written using :c:macro:: (note the
double colon). This causes the references to be outputted as combination
of verbatim roles and italicized names instead.

Correct the syntax.

Fixes: 5f67eef6dff394 ("misc: mrvl-cn10k-dpi: add Octeon CN10K DPI administrative driver")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/misc-devices/mrvl_cn10k_dpi.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/misc-devices/mrvl_cn10k_dpi.rst b/Documentation/misc-devices/mrvl_cn10k_dpi.rst
index a75e372723d860..fa9b8cd6806f14 100644
--- a/Documentation/misc-devices/mrvl_cn10k_dpi.rst
+++ b/Documentation/misc-devices/mrvl_cn10k_dpi.rst
@@ -33,12 +33,12 @@ drivers/misc/mrvl_cn10k_dpi.c
 Driver IOCTLs
 =============
 
-:c:macro::`DPI_MPS_MRRS_CFG`
+:c:macro:`DPI_MPS_MRRS_CFG`
 ioctl that sets max payload size & max read request size parameters of
 a pem port to which DMA engines are wired.
 
 
-:c:macro::`DPI_ENGINE_CFG`
+:c:macro:`DPI_ENGINE_CFG`
 ioctl that sets DMA engine's fifo sizes & max outstanding load request
 thresholds.
 
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 3/3] Documentation: tps6594-pfsm: Fix macro cross-reference syntax

[Bagas Sanjaya]

C macro references are erroneously written using :c:macro:: (note the
double colon). This causes the references to be outputted as combination
of verbatim roles and italicized names instead.

Correct the syntax.

Fixes: dce548889650c1 ("Documentation: Add TI TPS6594 PFSM")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/misc-devices/tps6594-pfsm.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/misc-devices/tps6594-pfsm.rst b/Documentation/misc-devices/tps6594-pfsm.rst
index 4ada37ccdcbae8..5f17a4fd9579ea 100644
--- a/Documentation/misc-devices/tps6594-pfsm.rst
+++ b/Documentation/misc-devices/tps6594-pfsm.rst
@@ -39,28 +39,28 @@ include/uapi/linux/tps6594_pfsm.h
 Driver IOCTLs
 =============
 
-:c:macro::`PMIC_GOTO_STANDBY`
+:c:macro:`PMIC_GOTO_STANDBY`
 All device resources are powered down. The processor is off, and
 no voltage domains are energized.
 
-:c:macro::`PMIC_GOTO_LP_STANDBY`
+:c:macro:`PMIC_GOTO_LP_STANDBY`
 The digital and analog functions of the PMIC, which are not
 required to be always-on, are turned off (low-power).
 
-:c:macro::`PMIC_UPDATE_PGM`
+:c:macro:`PMIC_UPDATE_PGM`
 Triggers a firmware update.
 
-:c:macro::`PMIC_SET_ACTIVE_STATE`
+:c:macro:`PMIC_SET_ACTIVE_STATE`
 One of the operational modes.
 The PMICs are fully functional and supply power to all PDN loads.
 All voltage domains are energized in both MCU and Main processor
 sections.
 
-:c:macro::`PMIC_SET_MCU_ONLY_STATE`
+:c:macro:`PMIC_SET_MCU_ONLY_STATE`
 One of the operational modes.
 Only the power resources assigned to the MCU Safety Island are on.
 
-:c:macro::`PMIC_SET_RETENTION_STATE`
+:c:macro:`PMIC_SET_RETENTION_STATE`
 One of the operational modes.
 Depending on the triggers set, some DDR/GPIO voltage domains can
 remain energized, while all other domains are off to minimize
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/3] misc devices formatting devices

[Randy Dunlap]

On 11/3/25 8:18 PM, Bagas Sanjaya wrote:
> Hi,
> 
> Here is a small docs formatting cleanup for assorted miscellaneous devices.
> Patches [2-3/3] are split from my previous macro references fixup patch [1].
> 
> Enjoy!
> 
> [1]: https://lore.kernel.org/linux-doc/20251104022242.19224-1-bagasdotme@gmail.com/
> 
> Bagas Sanjaya (3):
>   Documentation: amd-sbi: Wrap miscdevice listing snippet in literal
>     code block
>   Documentation: mrvl-cn10k-dpi: Fix macro cross-reference syntax
>   Documentation: tps6594-pfsm: Fix macro cross-reference syntax

for all 3 patches:

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

>  Documentation/misc-devices/amd-sbi.rst        |  6 ++++--
>  Documentation/misc-devices/mrvl_cn10k_dpi.rst |  4 ++--
>  Documentation/misc-devices/tps6594-pfsm.rst   | 12 ++++++------
>  3 files changed, 12 insertions(+), 10 deletions(-)
> 
> 
> base-commit: 27600b51fbc8b9a4eba18c8d88d7edb146605f3f

-- 
~Randy

Re: [PATCH 0/3] misc devices formatting devices

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Hi,
>
> Here is a small docs formatting cleanup for assorted miscellaneous devices.
> Patches [2-3/3] are split from my previous macro references fixup patch [1].
>
> Enjoy!
>
> [1]: https://lore.kernel.org/linux-doc/20251104022242.19224-1-bagasdotme@gmail.com/
>
> Bagas Sanjaya (3):
>   Documentation: amd-sbi: Wrap miscdevice listing snippet in literal
>     code block
>   Documentation: mrvl-cn10k-dpi: Fix macro cross-reference syntax
>   Documentation: tps6594-pfsm: Fix macro cross-reference syntax
>
>  Documentation/misc-devices/amd-sbi.rst        |  6 ++++--
>  Documentation/misc-devices/mrvl_cn10k_dpi.rst |  4 ++--
>  Documentation/misc-devices/tps6594-pfsm.rst   | 12 ++++++------
>  3 files changed, 12 insertions(+), 10 deletions(-)

I've applied these.

In truth, though, it's not at all clear that using c:macro brings
anything useful even when done correctly.

jon