[PATCH] Documentation: misc-devices: Fix C macro cross-reference syntax

[PATCH] Documentation: misc-devices: Fix C macro cross-reference syntax

[Bagas Sanjaya]

Macro references in Octeon CN10K and TI TPS6954 docs are erroneously
written using :c:macro:: (double colon) rather than :c:macro: (single
colon), making these rendered in htmldocs output as italics with
verbatim roles. Correct them.

Fixes: 5f67eef6dff394 ("misc: mrvl-cn10k-dpi: add Octeon CN10K DPI administrative driver")
Fixes: dce548889650c1 ("Documentation: Add TI TPS6594 PFSM")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/misc-devices/mrvl_cn10k_dpi.rst |  4 ++--
 Documentation/misc-devices/tps6594-pfsm.rst   | 12 ++++++------
 2 files changed, 8 insertions(+), 8 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.
 
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

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

Re: [PATCH] Documentation: misc-devices: Fix C macro cross-reference syntax

[Greg Kroah-Hartman]

On Tue, Nov 04, 2025 at 09:22:42AM +0700, Bagas Sanjaya wrote:
> Macro references in Octeon CN10K and TI TPS6954 docs are erroneously
> written using :c:macro:: (double colon) rather than :c:macro: (single
> colon), making these rendered in htmldocs output as italics with
> verbatim roles. Correct them.
> 
> Fixes: 5f67eef6dff394 ("misc: mrvl-cn10k-dpi: add Octeon CN10K DPI administrative driver")
> Fixes: dce548889650c1 ("Documentation: Add TI TPS6594 PFSM")

Please break this up into 2 different patches as you are doing 2
different things.

thanks,

greg k-h

Re: [PATCH] Documentation: misc-devices: Fix C macro cross-reference syntax

[Bagas Sanjaya]

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

On Tue, Nov 04, 2025 at 11:30:18AM +0900, Greg Kroah-Hartman wrote:
> On Tue, Nov 04, 2025 at 09:22:42AM +0700, Bagas Sanjaya wrote:
> > Macro references in Octeon CN10K and TI TPS6954 docs are erroneously
> > written using :c:macro:: (double colon) rather than :c:macro: (single
> > colon), making these rendered in htmldocs output as italics with
> > verbatim roles. Correct them.
> > 
> > Fixes: 5f67eef6dff394 ("misc: mrvl-cn10k-dpi: add Octeon CN10K DPI administrative driver")
> > Fixes: dce548889650c1 ("Documentation: Add TI TPS6594 PFSM")
> 
> Please break this up into 2 different patches as you are doing 2
> different things.

OK, thanks!

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

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