Skip to content

Commit

Permalink
Documentation: coresight: Escape coresight bindings file wildcard
Browse files Browse the repository at this point in the history
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.

Link: https://lore.kernel.org/linux-next/20220630173801.41bf22a2@canb.auug.org.au/
Fixes: 3c15fdd ("dt-bindings: arm: Convert CoreSight bindings to DT schema")
Cc: Mathieu Poirier <mathieu.poirier@linaro.org>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Mike Leach <mike.leach@linaro.org>
Cc: Leo Yan <leo.yan@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Rob Herring <robh@kernel.org>
Cc: coresight@lists.linaro.org
Cc: linux-arm-kernel@lists.infradead.org
Cc: linux-next@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20220630101317.102680-1-bagasdotme@gmail.com
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org>
  • Loading branch information
bagasme authored and mathieupoirier committed Jun 30, 2022
1 parent 66d0520 commit c064759
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/trace/coresight/coresight.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c064759

Please sign in to comment.