From: luca.ceresoli@bootlin.com
To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org
Cc: Luca Ceresoli <luca.ceresoli@bootlin.com>,
Wolfram Sang <wsa@kernel.org>, Peter Rosin <peda@axentia.se>,
linux-kernel@vger.kernel.org
Subject: [PATCH 9/9] docs: i2c: i2c-sysfs: fix hyperlinks
Date: Mon, 8 Aug 2022 16:17:08 +0200 [thread overview]
Message-ID: <20220808141708.1021103-10-luca.ceresoli@bootlin.com> (raw)
In-Reply-To: <20220808141708.1021103-1-luca.ceresoli@bootlin.com>
From: Luca Ceresoli <luca.ceresoli@bootlin.com>
dts files cannot be linked conveniently, thus replace them with literal
formatting.
The links to other rst pages are broken, fix them using the proper syntax.
Fixes: 31df7195b100 ("Documentation: i2c: Add doc for I2C sysfs")
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
Documentation/i2c/i2c-sysfs.rst | 15 ++++-----------
1 file changed, 4 insertions(+), 11 deletions(-)
diff --git a/Documentation/i2c/i2c-sysfs.rst b/Documentation/i2c/i2c-sysfs.rst
index d816a23b80f2..b6d31290fc4b 100644
--- a/Documentation/i2c/i2c-sysfs.rst
+++ b/Documentation/i2c/i2c-sysfs.rst
@@ -99,9 +99,7 @@ Caveat
This may be a confusing part for people who only know about the physical I2C
design of a board. It is actually possible to rename the I2C bus physical number
to a different number in logical I2C bus level in Device Tree Source (DTS) under
-section ``aliases``. See
-`arch/arm/boot/dts/nuvoton-npcm730-gsj.dts
-<../../arch/arm/boot/dts/nuvoton-npcm730-gsj.dts>`_
+section ``aliases``. See ``arch/arm/boot/dts/nuvoton-npcm730-gsj.dts``
for an example of DTS file.
Best Practice: **(To kernel software developers)** It is better to keep the I2C
@@ -289,8 +287,7 @@ MUX channel 0, and all the way to ``i2c-19`` for the MUX channel 3.
The kernel software developer is able to pin the fanout MUX channels to a static
logical I2C bus number in the DTS. This doc will not go through the details on
how to implement this in DTS, but we can see an example in:
-`arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts
-<../../arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts>`_
+``arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts``
In the above example, there is an 8-channel I2C MUX at address 0x70 on physical
I2C bus 2. The channel 2 of the MUX is defined as ``imux18`` in DTS,
@@ -382,13 +379,9 @@ Sysfs for the I2C sensor device::
For more info on the Hwmon Sysfs, refer to the doc:
-`Naming and data format standards for sysfs files
-<../hwmon/sysfs-interface.rst>`_
+../hwmon/sysfs-interface.rst
Instantiate I2C Devices in I2C Sysfs
------------------------------------
-Refer to the doc:
-
-`How to instantiate I2C devices, Method 4: Instantiate from user-space
-<instantiating-devices.rst#method-4-instantiate-from-user-space>`_
+Refer to section "Method 4: Instantiate from user-space" of instantiating-devices.rst
--
2.34.1
next prev parent reply other threads:[~2022-08-08 14:18 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-08 14:16 [PATCH 0/9] docs: i2c: rework I2C documentation, part II luca.ceresoli
2022-08-08 14:17 ` [PATCH 1/9] docs: i2c: i2c-protocol: update introductory paragraph luca.ceresoli
2022-08-11 21:03 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 2/9] docs: i2c: i2c-protocol,smbus-protocol: remove nonsense words luca.ceresoli
2022-08-11 21:03 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 3/9] docs: i2c: i2c-protocol: remove unused legend items luca.ceresoli
2022-08-11 21:05 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 4/9] docs: i2c: smbus-protocol: improve DataLow/DataHigh definition luca.ceresoli
2022-08-09 1:55 ` Bagas Sanjaya
2022-08-11 21:05 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 5/9] docs: i2c: instantiating-devices: add syntax coloring to dts and C blocks luca.ceresoli
2022-08-11 21:07 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 6/9] docs: i2c: i2c-topology: fix incorrect heading luca.ceresoli
2022-08-11 21:09 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 7/9] docs: i2c: i2c-topology: reorder sections more logically luca.ceresoli
2022-08-09 2:08 ` Bagas Sanjaya
2022-08-09 7:06 ` Luca Ceresoli
2022-08-11 21:09 ` Wolfram Sang
2022-08-08 14:17 ` [PATCH 8/9] docs: i2c: i2c-sysfs: improve wording luca.ceresoli
2022-08-11 21:13 ` Wolfram Sang
2022-08-11 21:23 ` Wolfram Sang
2022-08-12 7:13 ` Luca Ceresoli
2022-08-08 14:17 ` luca.ceresoli [this message]
2022-08-11 21:21 ` [PATCH 9/9] docs: i2c: i2c-sysfs: fix hyperlinks Wolfram Sang
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=20220808141708.1021103-10-luca.ceresoli@bootlin.com \
--to=luca.ceresoli@bootlin.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peda@axentia.se \
--cc=wsa@kernel.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: 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®