docs: fix cross references
Subsystems (5)
cover docs: fix cross references
A few trivial issues found while building docs.
Kir Kolyshkin (3):
docs: fix bad cross-links in motorola-cpcap
docs/devicetree: fix a cross-ref
docs: fix a cross-ref
Documentation/admin-guide/ext4.rst | 2 +- Documentation/devicetree/bindings/leds/leds-bcm6328.txt | 3 ++- Documentation/devicetree/bindings/leds/leds-bcm6358.txt | 4 ++-- Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 4 ++-- Documentation/filesystems/ext2.rst | 2 +- 5 files changed, 8 insertions(+), 7 deletions(-)
Signature · 1 line
2.31.1
PATCH 1/3 docs: fix bad cross-links in motorola-cpcap
Commits 3c5be0454 and ce49e4282 renamed the files being referenced, but forgot to modify the document that references them.
This fixes the following warnings:
Quoted 7 lines
Warning:
Documentation/devicetree/bindings/mfd/motorola-cpcap.txtreferences a file that doesn't exist:Documentation/devicetree/bindings/power/supply/cpcap-battery.txtWarning:
Documentation/devicetree/bindings/mfd/motorola-cpcap.txtreferences a file that doesn't exist:Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
--- Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/devicetree/bindings/mfd/motorola-cpcap.txt +2 -2
@@ -16,8 +16,8 @@ Optional subnodes: The sub-functions of CPCAP get their own node with their own compatible values, which are described in the following files: -- Documentation/devicetree/bindings/power/supply/cpcap-battery.txt -- Documentation/devicetree/bindings/power/supply/cpcap-charger.txt +- Documentation/devicetree/bindings/power/supply/cpcap-battery.yaml +- Documentation/devicetree/bindings/power/supply/cpcap-charger.yaml - Documentation/devicetree/bindings/regulator/cpcap-regulator.txt - Documentation/devicetree/bindings/phy/phy-cpcap-usb.txt - Documentation/devicetree/bindings/input/cpcap-pwrbutton.txt
Signature · 1 line
2.31.1
PATCH 2/3 docs/devicetree: fix a cross-ref
In reply to Kir KolyshkinCommit 56b01acc1c79 renames the file being referred to. Fix the references accordingly.
--- Documentation/devicetree/bindings/leds/leds-bcm6328.txt | 3 ++- Documentation/devicetree/bindings/leds/leds-bcm6358.txt | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-)
Documentation/devicetree/bindings/leds/leds-bcm6328.txt +2 -1
@@ -4,7 +4,8 @@ This controller is present on BCM6318, BCM6328, BCM6362 and BCM63268. In these SoCs it's possible to control LEDs both as GPIOs or by hardware. However, on some devices there are Serial LEDs (LEDs connected to a 74x164 controller), which can either be controlled by software (exporting the 74x164 -as spi-gpio. See Documentation/devicetree/bindings/gpio/gpio-74x164.txt), or +as spi-gpio; see +Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml), or by hardware using this driver. Some of these Serial LEDs are hardware controlled (e.g. ethernet LEDs) and exporting the 74x164 as spi-gpio prevents those LEDs to be hardware
Documentation/devicetree/bindings/leds/leds-bcm6358.txt +2 -2
@@ -2,8 +2,8 @@ LEDs connected to Broadcom BCM6358 controller This controller is present on BCM6358 and BCM6368. In these SoCs there are Serial LEDs (LEDs connected to a 74x164 controller), -which can either be controlled by software (exporting the 74x164 as spi-gpio. -See Documentation/devicetree/bindings/gpio/gpio-74x164.txt), or +which can either be controlled by software (exporting the 74x164 as spi-gpio; +see Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml), or by hardware using this driver. Required properties:
Signature · 1 line
2.31.1
Re: [PATCH 2/3] docs/devicetree: fix a cross-ref
Hi Kir,
Quoted 5 lines · Kir Kolyshkin
Commit
56b01acc1c79renames the file being referred to. Fix the references accordingly.Cc Geert Uytterhoeven <[email protected]>Signed-off-by Kir Kolyshkin <[email protected]>
Thanks for your patch, but this was already fixed in v5.13-rc3 in commit 0bd50826a40e012a ("leds: Fix reference file name of documentation").
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
PATCH 3/3 docs: fix a cross-ref
In reply to Kir KolyshkinCommit acda97acb2e98c9 changes dax.txt to dax.rst. Fix the references accordingly.
--- Documentation/admin-guide/ext4.rst | 2 +- Documentation/filesystems/ext2.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/admin-guide/ext4.rst +1 -1
@@ -392,7 +392,7 @@ When mounting an ext4 filesystem, the following option are accepted: dax Use direct access (no page cache). See - Documentation/filesystems/dax.txt. Note that this option is + Documentation/filesystems/dax.rst. Note that this option is incompatible with data=journal. inlinecrypt
Documentation/filesystems/ext2.rst +1 -1
@@ -25,7 +25,7 @@ check=none, nocheck (*) Don't do extra checking of bitmaps on mount (check=normal and check=strict options removed) dax Use direct access (no page cache). See - Documentation/filesystems/dax.txt. + Documentation/filesystems/dax.rst. debug Extra debugging information is sent to the kernel syslog. Useful for developers.
Signature · 1 line
2.31.1
Re: [PATCH 3/3] docs: fix a cross-ref
Quoted 9 lines · Kir Kolyshkin
Commit
acda97acb2e98c9changes dax.txt todax.rst. Fix the references accordingly.Cc Igor Matheus Andrade Torrente <[email protected]>Signed-off-by Kir Kolyshkin <[email protected]>--- Documentation/admin-guide/ext4.rst | 2 +- Documentation/filesystems/ext2.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
I've applied this one, thanks. The devicetree ones should go to the devicetree maintainers, though.
jon