mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Leo Yan <leo.yan@linaro.org>,
	Mathieu Poirier <mathieu.poirier@linaro.org>,
	Mike Leach <mike.leach@linaro.org>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	coresight@lists.linaro.org, linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH v3 21/21] Documentation: coresight: fix binding wildcards
Date: Sat,  9 Jul 2022 11:07:34 +0100	[thread overview]
Message-ID: <e8289cf7306a24c20d2f43251f6f7d0d74d7667b.1657360984.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1657360984.git.mchehab@kernel.org>

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 --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.
-- 
2.36.1


      parent reply	other threads:[~2022-07-09 10:08 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-09 10:07 [PATCH v3 00/21] Update Documentation/ cross references and fix issues Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 01/21] docs: networking: update netdevices.rst reference Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 02/21] docs: update vmalloced-kernel-stacks.rst reference Mauro Carvalho Chehab
2022-07-09 13:37   ` Wu XiangCheng
2022-07-11  2:32   ` YanTeng Si
2022-07-09 10:07 ` [PATCH v3 03/21] docs: update vmemmap_dedup.rst reference Mauro Carvalho Chehab
2022-07-11  6:05   ` Muchun Song
2022-07-09 10:07 ` [PATCH v3 04/21] docs: zh_CN: page_migration: fix reference to mm index.rst Mauro Carvalho Chehab
2022-07-09 10:41   ` Wu XiangCheng
2022-07-11  2:28   ` YanTeng Si
2022-07-09 10:07 ` [PATCH v3 05/21] dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 06/21] x86/sgx: fix kernel-doc markups Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 07/21] fscache: fix kernel-doc documentation Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 08/21] fs: namei: address some kernel-doc issues Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 09/21] drm/scheduler: fix a kernel-doc warning Mauro Carvalho Chehab
2022-08-11 16:32   ` Alex Deucher
2022-07-09 10:07 ` [PATCH v3 10/21] drm/scheduler: add a missing kernel-doc parameter Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 11/21] kfence: fix a " Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 12/21] genalloc: add a description for start_addr parameter Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 13/21] textsearch: document list inside struct ts_ops Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 14/21] dcache: fix a kernel-doc warning Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 15/21] docs: ext4: blockmap.rst: fix a broken table Mauro Carvalho Chehab
2022-07-09 15:37   ` Theodore Ts'o
2022-07-09 10:07 ` [PATCH v3 16/21] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 17/21] docs: PCI: pci-vntb-howto.rst: fix a title markup Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 18/21] docs: virt: kvm: fix a title markup at api.rst Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 19/21] docs: ABI: sysfs-bus-nvdimm Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 20/21] docs: leds: index.rst: add leds-qcom-lpg to it Mauro Carvalho Chehab
2022-07-09 10:07 ` Mauro Carvalho Chehab [this message]

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=e8289cf7306a24c20d2f43251f6f7d0d74d7667b.1657360984.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --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+huawei@kernel.org \
    --cc=mike.leach@linaro.org \
    --cc=suzuki.poulose@arm.com \
    /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: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®