Skip to content

Commit fe99b81

Browse files
lucaceresoliwsakernel
authored andcommitted
docs: i2c: i2c-sysfs: fix hyperlinks
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: 31df719 ("Documentation: i2c: Add doc for I2C sysfs") Signed-off-by: Luca Ceresoli <[email protected]> Signed-off-by: Wolfram Sang <[email protected]>
1 parent 55bdfb8 commit fe99b81

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

Documentation/i2c/i2c-sysfs.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,7 @@ Caveat
9999
This may be a confusing part for people who only know about the physical I2C
100100
design of a board. It is actually possible to rename the I2C bus physical number
101101
to a different number in logical I2C bus level in Device Tree Source (DTS) under
102-
section ``aliases``. See
103-
`arch/arm/boot/dts/nuvoton-npcm730-gsj.dts
104-
<../../arch/arm/boot/dts/nuvoton-npcm730-gsj.dts>`_
102+
section ``aliases``. See ``arch/arm/boot/dts/nuvoton-npcm730-gsj.dts``
105103
for an example of DTS file.
106104

107105
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.
289287
The kernel software developer is able to pin the fanout MUX channels to a static
290288
logical I2C bus number in the DTS. This doc will not go through the details on
291289
how to implement this in DTS, but we can see an example in:
292-
`arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts
293-
<../../arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts>`_
290+
``arch/arm/boot/dts/aspeed-bmc-facebook-wedge400.dts``
294291

295292
In the above example, there is an 8-channel I2C MUX at address 0x70 on physical
296293
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::
382379

383380
For more info on the Hwmon Sysfs, refer to the doc:
384381

385-
`Naming and data format standards for sysfs files
386-
<../hwmon/sysfs-interface.rst>`_
382+
../hwmon/sysfs-interface.rst
387383

388384
Instantiate I2C Devices in I2C Sysfs
389385
------------------------------------
390386

391-
Refer to the doc:
392-
393-
`How to instantiate I2C devices, Method 4: Instantiate from user-space
394-
<instantiating-devices.rst#method-4-instantiate-from-user-space>`_
387+
Refer to section "Method 4: Instantiate from user-space" of instantiating-devices.rst

0 commit comments

Comments
 (0)