Messages in this thread | | | Date | Mon, 12 Sep 2022 10:39:56 +0100 | Subject | Re: [PATCH 06/13] Documentation: coresight: fix a documentation build warning | From | Suzuki K Poulose <> |
| |
On 18/08/2022 14:38, Mauro Carvalho Chehab wrote: > Using wildcards for cross-reference doesn't work, as the Sphinx > automarkup plugin is not smart enough. So, changeset > c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard") > tried to fix it, but at the wrong way, as it the building system > will keep producing warnings about that: > > Warning: Documentation/trace/coresight/coresight.rst references a file that doesn't exist: Documentation/devicetree/bindings/arm/arm,coresight- > > As automarkup will still try (and fail) to create a cross reference. > So, instead, change the markup to ensure that the warning won't be > reported. > > Fixes: c06475910b52 ("Documentation: coresight: Escape coresight bindings file wildcard") > Cc: Bagas Sanjaya <bagasdotme@gmail.com> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com>
> --- > > See [PATCH 00/13] at: https://lore.kernel.org/all/cover.1660829433.git.mchehab@kernel.org/ > > Documentation/trace/coresight/coresight.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > 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.
| |