Skip to content

Commit fa55e63

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 <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 Cc: Stephen Rothwell <sfr@canb.auug.org.au> Cc: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com> Link: https://lore.kernel.org/r/20231022185806.919434-1-vegard.nossum@oracle.com
1 parent 4708ead commit fa55e63

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)