Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: tps6594-pfsm: Fix macro cross-reference syntax

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>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251104041812.31402-4-bagasdotme@gmail.com>

authored by

Bagas Sanjaya and committed by
Jonathan Corbet
77cbf5fb 3ba679d4

+6 -6
+6 -6
Documentation/misc-devices/tps6594-pfsm.rst
··· 39 39 Driver IOCTLs 40 40 ============= 41 41 42 - :c:macro::`PMIC_GOTO_STANDBY` 42 + :c:macro:`PMIC_GOTO_STANDBY` 43 43 All device resources are powered down. The processor is off, and 44 44 no voltage domains are energized. 45 45 46 - :c:macro::`PMIC_GOTO_LP_STANDBY` 46 + :c:macro:`PMIC_GOTO_LP_STANDBY` 47 47 The digital and analog functions of the PMIC, which are not 48 48 required to be always-on, are turned off (low-power). 49 49 50 - :c:macro::`PMIC_UPDATE_PGM` 50 + :c:macro:`PMIC_UPDATE_PGM` 51 51 Triggers a firmware update. 52 52 53 - :c:macro::`PMIC_SET_ACTIVE_STATE` 53 + :c:macro:`PMIC_SET_ACTIVE_STATE` 54 54 One of the operational modes. 55 55 The PMICs are fully functional and supply power to all PDN loads. 56 56 All voltage domains are energized in both MCU and Main processor 57 57 sections. 58 58 59 - :c:macro::`PMIC_SET_MCU_ONLY_STATE` 59 + :c:macro:`PMIC_SET_MCU_ONLY_STATE` 60 60 One of the operational modes. 61 61 Only the power resources assigned to the MCU Safety Island are on. 62 62 63 - :c:macro::`PMIC_SET_RETENTION_STATE` 63 + :c:macro:`PMIC_SET_RETENTION_STATE` 64 64 One of the operational modes. 65 65 Depending on the triggers set, some DDR/GPIO voltage domains can 66 66 remain energized, while all other domains are off to minimize