Documentation: coresight: escape coresight bindings file wildcard
Subsystems (3)
PATCH 1/1 Documentation: coresight: escape coresight bindings file wildcard
Stephen Rothwell reported htmldocs warning:
Documentation/trace/coresight/coresight.rst:133: WARNING: Inline emphasis start-string without end-string.
The warning above is due to unescaped wildcard asterisk (*) on CoreSight devicetree binding filename, which confuses Sphinx as emphasis instead.
Escape the wildcard to fix the warning.
--- Documentation/trace/coresight/coresight.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/trace/coresight/coresight.rst +1 -1
@@ -130,7 +130,7 @@ Misc: Device Tree Bindings -------------------- -See Documentation/devicetree/bindings/arm/arm,coresight-*.yaml for details. +See Documentation/devicetree/bindings/arm/arm,coresight-\*.yaml for details. As of this writing drivers for ITM, STMs and CTIs are not provided but are expected to be added as the solution matures.
base-commit: 6cc11d2a1759275b856e464265823d94aabd5eaf
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Mathieu Poirier
AppliedQuoted 23 lines · Bagas Sanjaya
Stephen Rothwell reported htmldocs warning:
Documentation/trace/coresight/coresight.rst:133: WARNING: Inline emphasis start-string without end-string.The warning above is due to unescaped wildcard asterisk (*) on CoreSight devicetree binding filename, which confuses Sphinx as emphasis instead.
Escape the wildcard to fix the warning.
Fixes 3c15fddf312120 ("dt-bindings: arm: Convert CoreSight bindings to DT schema")Cc Mathieu Poirier <[email protected]>Cc Suzuki K Poulose <[email protected]>Cc Mike Leach <[email protected]>Cc Leo Yan <[email protected]>Cc Jonathan Corbet <[email protected]>Cc Rob Herring <[email protected]>Reported-by Stephen Rothwell <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>
Quoted 4 lines
--- Documentation/trace/coresight/coresight.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Applied.
Thanks,
Mathieu
Quoted 18 lines
Documentation/trace/coresight/coresight.rst +1
-1@@ -130,7 +130,7 @@ Misc: Device Tree Bindings -------------------- -See Documentation/devicetree/bindings/arm/arm,coresight-*.yaml for details. +See Documentation/devicetree/bindings/arm/arm,coresight-\*.yaml for details. As of this writing drivers for ITM, STMs and CTIs are not provided but are expected to be added as the solution matures.base-commit:
6cc11d2a1759275b856e464265823d94aabd5eafSignature · 1 line
An old man doll... just what I always wanted! - Clara