| Message ID | 20231022185806.919434-1-vegard.nossum@oracle.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation: coresight: fix `make refcheckdocs` warning | expand |
On Sun, Oct 22, 2023 at 08:58:06PM +0200, Vegard Nossum wrote: > -See Documentation/devicetree/bindings/arm/arm,coresight-\*.yaml for details. > +See ``Documentation/devicetree/bindings/arm/arm,coresight-*.yaml`` for details. Oh, I should have inlined that path when I fixed the original warning. Anyway, Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
On Sun, 22 Oct 2023 20:58:06 +0200, Vegard Nossum wrote: > 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). > > [...] Applied, thanks! [1/1] Documentation: coresight: fix `make refcheckdocs` warning https://git.kernel.org/coresight/c/fa55e63584f2 Best regards,
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.
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> --- Documentation/trace/coresight/coresight.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)