From: Suzuki K Poulose <suzuki.poulose@arm.com> To: Mauro Carvalho Chehab <mchehab@kernel.org>, Linux Doc Mailing List <linux-doc@vger.kernel.org>, corbet@lwn.net Cc: Bagas Sanjaya <bagasdotme@gmail.com>, Leo Yan <leo.yan@linaro.org>, Mathieu Poirier <mathieu.poirier@linaro.org>, Mike Leach <mike.leach@linaro.org>, coresight@lists.linaro.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH 06/13] Documentation: coresight: fix a documentation build warning Date: Mon, 12 Sep 2022 10:39:56 +0100 [thread overview] Message-ID: <1037211f-6c10-16de-4819-2a51d115f65b@arm.com> (raw) In-Reply-To: <ff5c57f03d106dc5cc14448ec0db224267fb1bfb.1660829433.git.mchehab@kernel.org> 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.
WARNING: multiple messages have this Message-ID (diff)
From: Suzuki K Poulose <suzuki.poulose@arm.com> To: Mauro Carvalho Chehab <mchehab@kernel.org>, Linux Doc Mailing List <linux-doc@vger.kernel.org>, corbet@lwn.net Cc: Bagas Sanjaya <bagasdotme@gmail.com>, Leo Yan <leo.yan@linaro.org>, Mathieu Poirier <mathieu.poirier@linaro.org>, Mike Leach <mike.leach@linaro.org>, coresight@lists.linaro.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH 06/13] Documentation: coresight: fix a documentation build warning Date: Mon, 12 Sep 2022 10:39:56 +0100 [thread overview] Message-ID: <1037211f-6c10-16de-4819-2a51d115f65b@arm.com> (raw) In-Reply-To: <ff5c57f03d106dc5cc14448ec0db224267fb1bfb.1660829433.git.mchehab@kernel.org> 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. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2022-09-12 9:40 UTC|newest] Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-08-18 13:38 [PATCH 00/13] Fix documentation build warnings against 6.0-rc1 Mauro Carvalho Chehab 2022-08-18 13:38 ` Mauro Carvalho Chehab 2022-08-18 13:38 ` Mauro Carvalho Chehab 2022-08-18 13:38 ` [PATCH 01/13] scripts: kernel-doc: add support for EXPORT_SYMBOL variants Mauro Carvalho Chehab 2022-08-18 13:38 ` [PATCH 02/13] docs: update vmemmap_dedup.rst reference Mauro Carvalho Chehab 2022-08-18 14:58 ` Wu XiangCheng 2022-08-19 2:49 ` Muchun Song 2022-08-18 13:38 ` [PATCH 03/13] docs: ja_JP: remove SubmittingPatches Mauro Carvalho Chehab 2022-08-18 14:27 ` Akira Yokosawa 2022-08-18 14:49 ` Akira Yokosawa 2022-08-18 13:38 ` [PATCH 04/13] docs: zh_CN: remove references to rust documentation Mauro Carvalho Chehab 2022-08-20 2:20 ` YanTeng Si 2022-08-18 13:38 ` [PATCH 05/13] dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference Mauro Carvalho Chehab 2022-08-18 13:38 ` Mauro Carvalho Chehab 2022-09-12 8:39 ` Suzuki K Poulose 2022-09-12 8:39 ` Suzuki K Poulose 2022-08-18 13:38 ` [PATCH 06/13] Documentation: coresight: fix a documentation build warning Mauro Carvalho Chehab 2022-08-18 13:38 ` Mauro Carvalho Chehab 2022-08-19 3:35 ` Bagas Sanjaya 2022-08-19 3:35 ` Bagas Sanjaya 2022-09-12 9:39 ` Suzuki K Poulose [this message] 2022-09-12 9:39 ` Suzuki K Poulose 2022-08-18 13:38 ` [PATCH 07/13] MAINTAINERS: fix wildcard for mfd da90* files Mauro Carvalho Chehab 2022-08-18 13:38 ` [PATCH 08/13] MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml Mauro Carvalho Chehab 2022-08-18 13:38 ` [PATCH 09/13] ABI: sysfs-bus-nvdimm: fix a doc build warning Mauro Carvalho Chehab 2022-08-18 13:38 ` [PATCH 10/13] docs: leds: add leds-qcom-lpg.rst to the index file Mauro Carvalho Chehab 2022-08-18 13:38 ` Mauro Carvalho Chehab 2022-08-19 3:49 ` Bagas Sanjaya 2022-08-19 3:49 ` Bagas Sanjaya 2022-08-18 13:38 ` [PATCH 11/13] fscache: fix kernel-doc markup on two functions Mauro Carvalho Chehab 2022-08-18 13:38 ` [PATCH 12/13] serial: document start_rx member at struct uart_ops Mauro Carvalho Chehab 2022-08-19 5:20 ` Jiri Slaby 2022-08-18 13:38 ` [PATCH 13/13] fs/dcache: fix a kernel-doc markup Mauro Carvalho Chehab
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1037211f-6c10-16de-4819-2a51d115f65b@arm.com \ --to=suzuki.poulose@arm.com \ --cc=bagasdotme@gmail.com \ --cc=corbet@lwn.net \ --cc=coresight@lists.linaro.org \ --cc=leo.yan@linaro.org \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mathieu.poirier@linaro.org \ --cc=mchehab@kernel.org \ --cc=mike.leach@linaro.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.