Documentation: coresight: fix `make refcheckdocs` warning
authorVegard Nossum <vegard.nossum@oracle.com>
Sun, 22 Oct 2023 18:58:06 +0000 (20:58 +0200)
committerSuzuki K Poulose <suzuki.poulose@arm.com>
Thu, 16 Nov 2023 09:52:39 +0000 (09:52 +0000)
commite49c0b1401d0d0efc8aeeb9db5a9d54e980d9f69
tree4c94c5a20d38d5b543236a6834a16d8d6f141d78
parentaff787f64ad7cbb54614b51b82c682fe06411ef3
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: c06475910b52 ("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
Documentation/trace/coresight/coresight.rst