diff mbox series

[v3,21/21] Documentation: coresight: fix binding wildcards

Message ID e8289cf7306a24c20d2f43251f6f7d0d74d7667b.1657360984.git.mchehab@kernel.org (mailing list archive)
State New, archived
Headers show
Series None | expand

Commit Message

Mauro Carvalho Chehab July 9, 2022, 10:07 a.m. UTC
The changeset c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard")
fixed a Sphinx warning but introduced a new warning while building
the docs:
	Documentation/trace/coresight/coresight.rst: Documentation/devicetree/bindings/arm/arm,coresight-

As it basically broke the cross-reference breakage detector that
runs during the Kernel build. Address it the proper way by marking
the references to such documents as a code block. This should make
Sphinx automarkup.py extension happy while allowing the script
to check if the doc reference is pointing to the right place.

Fixes: c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard")
Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v3 00/21] at: https://lore.kernel.org/all/cover.1657360984.git.mchehab@kernel.org/

 Documentation/trace/coresight/coresight.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/trace/coresight/coresight.rst b/Documentation/trace/coresight/coresight.rst
index 4a71ea6cb390..826e59a698da 100644
--- a/Documentation/trace/coresight/coresight.rst
+++ b/Documentation/trace/coresight/coresight.rst
@@ -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.