Skip to content

Commit e49c0b1

Browse files
vegardSuzuki K Poulose
authored andcommitted
Documentation: coresight: fix make refcheckdocs warning
This reference uses a glob pattern to match multiple files, but the asterisk was escaped as \* in order to not be interpreted by sphinx as reStructuredText markup. refcheckdocs/documentation-file-ref-check doesn't know about rST syntax and tries to interpret the \* literally (instead of as a glob). We can work around the warning by putting the Documentation reference inside double backticks (``..``), which allows us to not escape the asterisk. Fixes: c064759 ("Documentation: coresight: Escape coresight bindings file wildcard") 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]> Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: [email protected] Cc: Stephen Rothwell <[email protected]> Cc: Bagas Sanjaya <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Reviewed-by: Bagas Sanjaya <[email protected]> Signed-off-by: Suzuki K Poulose <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent aff787f commit e49c0b1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/trace/coresight/coresight.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Misc:
130130
Device Tree Bindings
131131
--------------------
132132

133-
See Documentation/devicetree/bindings/arm/arm,coresight-\*.yaml for details.
133+
See ``Documentation/devicetree/bindings/arm/arm,coresight-*.yaml`` for details.
134134

135135
As of this writing drivers for ITM, STMs and CTIs are not provided but are
136136
expected to be added as the solution matures.

0 commit comments

Comments
 (0)