Skip to contentSkip to conversation

Fix typo, add markup, fix URL in i2c-piix4 docs

PATCH In review Bruce Duncan 3 participants 4 messages Dec 15, 2021 – Aug 25, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Fix typo, add markup, fix URL in i2c-piix4 docs

http://lm-sensors.org no longer exists,
https://github.com/lm-sensors/lm-sensors/issues/3 suggests using
https://hwmon.wiki.kernel.org/

---
 Documentation/i2c/busses/i2c-piix4.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
Documentation/i2c/busses/i2c-piix4.rst +6 -6
index cc9000259223..abe6358ffade 100644
@@ -64,7 +64,7 @@ correct address for this module, you could get in big trouble (read:
 crashes, data corruption, etc.). Try this only as a last resort (try BIOS
 updates first, for example), and backup first! An even more dangerous
 option is 'force_addr=<IOPORT>'. This will not only enable the PIIX4 like
-'force' foes, but it will also set a new base I/O port address. The SMBus
+'force' does, but it will also set a new base I/O port address. The SMBus
 parts of the PIIX4 needs a range of 8 of these addresses to function
 correctly. If these addresses are already reserved by some other device,
 you will get into big trouble! DON'T USE THIS IF YOU ARE NOT VERY SURE
@@ -86,15 +86,15 @@ If you own Force CPCI735 motherboard or other OSB4 based systems you may need
 to change the SMBus Interrupt Select register so the SMBus controller uses
 the SMI mode.
 
-1) Use lspci command and locate the PCI device with the SMBus controller:
+1) Use ``lspci`` command and locate the PCI device with the SMBus controller:
    00:0f.0 ISA bridge: ServerWorks OSB4 South Bridge (rev 4f)
    The line may vary for different chipsets. Please consult the driver source
-   for all possible PCI ids (and lspci -n to match them). Lets assume the
+   for all possible PCI ids (and ``lspci -n`` to match them). Lets assume the
    device is located at 00:0f.0.
 2) Now you just need to change the value in 0xD2 register. Get it first with
-   command: lspci -xxx -s 00:0f.0
+   command: ``lspci -xxx -s 00:0f.0``
    If the value is 0x3 then you need to change it to 0x1:
-   setpci  -s 00:0f.0 d2.b=1
+   ``setpci  -s 00:0f.0 d2.b=1``
 
 Please note that you don't need to do that in all cases, just when the SMBus is
 not working properly.
@@ -111,4 +111,4 @@ of all affected systems, so the only safe solution was to prevent access to
 the SMBus on all IBM systems (detected using DMI data.)
 
 For additional information, read:
-http://www.lm-sensors.org/browser/lm-sensors/trunk/README
+https://hwmon.wiki.kernel.org
Signature · 1 line
2.32.0
#1 lore raw

Documentation/i2c/busses/i2c-piix4.rst of all affected systems, so the only safe solution was to prevent access to · line 114

Quoted 3 lines

For additional information, read:

Documentation/i2c/busses/i2c-piix4.rst +1 -1
-http://www.lm-sensors.org/browser/lm-sensors/trunk/README
+https://hwmon.wiki.kernel.org

I think the proper replacement is:

https://github.com/lm-sensors/lm-sensors/blob/master/README

?

#2 lore raw

Hi Wolfram,

Quoted 9 lines · Wolfram Sang

Documentation/i2c/busses/i2c-piix4.rst of all affected systems, so the only safe solution was to prevent access to · line 114

Quoted 3 lines

For additional information, read:

Documentation/i2c/busses/i2c-piix4.rst +1 -1
-http://www.lm-sensors.org/browser/lm-sensors/trunk/README
+https://hwmon.wiki.kernel.org  

I think the proper replacement is:

https://github.com/lm-sensors/lm-sensors/blob/master/README

?

Yes, but I'd rather remove the pointer completely than update it. There's nothing specific to the i2c-piix4 driver in that file, so I can't see any value in mentioning it here.

As Bruce appears to have vanished meanwhile, I'll post an updated version of the patch shortly myself, including another typo fix.

Signature · 2 lines
Jean Delvare
SUSE L3 Support
#3 lore raw

Hi,

I wasn't sure what the correct replacement should be either so I'm happy for you to post a new patch. Let me know if there's anything you need from me.

Bruce

Quoted 18 lines · Jean Delvare

Hi Wolfram,

Quoted 8 lines · Wolfram Sang

Documentation/i2c/busses/i2c-piix4.rst of all affected systems, so the only safe solution was to prevent access to · line 114

Quoted 3 lines

For additional information, read:

Documentation/i2c/busses/i2c-piix4.rst +1 -1
-http://www.lm-sensors.org/browser/lm-sensors/trunk/README
+https://hwmon.wiki.kernel.org

I think the proper replacement is:

https://github.com/lm-sensors/lm-sensors/blob/master/README

?

Yes, but I'd rather remove the pointer completely than update it. There's nothing specific to the i2c-piix4 driver in that file, so I can't see any value in mentioning it here.

As Bruce appears to have vanished meanwhile, I'll post an updated version of the patch shortly myself, including another typo fix.