[PATCH 0/3] docs: fix cross references

All of lore.kernel.org
 help / color / mirror / Atom feed

* [PATCH 0/3] docs: fix cross references
@ 2021-06-11  3:00 Kir Kolyshkin
  2021-06-11  3:00 ` [PATCH 1/3] docs: fix bad cross-links in motorola-cpcap Kir Kolyshkin
                   ` (2 more replies)
  0 siblings, 3 replies; 6+ messages in thread
From: Kir Kolyshkin @ 2021-06-11  3:00 UTC (permalink / raw)
  To: linux-doc; +Cc: Jonathan Corbet, Kir Kolyshkin

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(-)

-- 
2.31.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 1/3] docs: fix bad cross-links in motorola-cpcap
  2021-06-11  3:00 [PATCH 0/3] docs: fix cross references Kir Kolyshkin
@ 2021-06-11  3:00 ` Kir Kolyshkin
  2021-06-11  3:00 ` [PATCH 2/3] docs/devicetree: fix a cross-ref Kir Kolyshkin
  2021-06-11  3:00 ` [PATCH 3/3] docs: " Kir Kolyshkin
  2 siblings, 0 replies; 6+ messages in thread
From: Kir Kolyshkin @ 2021-06-11  3:00 UTC (permalink / raw)
  To: linux-doc; +Cc: Jonathan Corbet, Kir Kolyshkin, Sebastian Reichel

Commits 3c5be0454 and ce49e4282 renamed the files being referenced,
but forgot to modify the document that references them.

This fixes the following warnings:

> Warning: Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
> references a file that doesn't exist:
> Documentation/devicetree/bindings/power/supply/cpcap-battery.txt

> Warning: Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
> references a file that doesn't exist:
> Documentation/devicetree/bindings/power/supply/cpcap-charger.txt

Cc: Sebastian Reichel <sebastian.reichel@collabora.com>
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt b/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
index b52e7a33f0f9..190230216de8 100644
--- a/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
+++ b/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
@@ -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
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 2/3] docs/devicetree: fix a cross-ref
  2021-06-11  3:00 [PATCH 0/3] docs: fix cross references Kir Kolyshkin
  2021-06-11  3:00 ` [PATCH 1/3] docs: fix bad cross-links in motorola-cpcap Kir Kolyshkin
@ 2021-06-11  3:00 ` Kir Kolyshkin
  2021-06-11  6:57   ` Geert Uytterhoeven
  2021-06-11  3:00 ` [PATCH 3/3] docs: " Kir Kolyshkin
  2 siblings, 1 reply; 6+ messages in thread
From: Kir Kolyshkin @ 2021-06-11  3:00 UTC (permalink / raw)
  To: linux-doc; +Cc: Jonathan Corbet, Kir Kolyshkin, Geert Uytterhoeven

Commit 56b01acc1c79 renames the file being referred to.
Fix the references accordingly.

Cc: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 Documentation/devicetree/bindings/leds/leds-bcm6328.txt | 3 ++-
 Documentation/devicetree/bindings/leds/leds-bcm6358.txt | 4 ++--
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/leds/leds-bcm6328.txt b/Documentation/devicetree/bindings/leds/leds-bcm6328.txt
index ccebce597f37..c9e4077734f9 100644
--- a/Documentation/devicetree/bindings/leds/leds-bcm6328.txt
+++ b/Documentation/devicetree/bindings/leds/leds-bcm6328.txt
@@ -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
diff --git a/Documentation/devicetree/bindings/leds/leds-bcm6358.txt b/Documentation/devicetree/bindings/leds/leds-bcm6358.txt
index da5708e7b43b..183258ceb8bc 100644
--- a/Documentation/devicetree/bindings/leds/leds-bcm6358.txt
+++ b/Documentation/devicetree/bindings/leds/leds-bcm6358.txt
@@ -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:
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH 2/3] docs/devicetree: fix a cross-ref
  2021-06-11  3:00 ` [PATCH 2/3] docs/devicetree: fix a cross-ref Kir Kolyshkin
@ 2021-06-11  6:57   ` Geert Uytterhoeven
  0 siblings, 0 replies; 6+ messages in thread
From: Geert Uytterhoeven @ 2021-06-11  6:57 UTC (permalink / raw)
  To: Kir Kolyshkin
  Cc: open list:DOCUMENTATION, Jonathan Corbet, Geert Uytterhoeven

Hi Kir,

On Fri, Jun 11, 2021 at 5:01 AM Kir Kolyshkin <kolyshkin@gmail.com> wrote:
> Commit 56b01acc1c79 renames the file being referred to.
> Fix the references accordingly.
>
> Cc: Geert Uytterhoeven <geert+renesas@glider.be>
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>

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

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 3/3] docs: fix a cross-ref
  2021-06-11  3:00 [PATCH 0/3] docs: fix cross references Kir Kolyshkin
  2021-06-11  3:00 ` [PATCH 1/3] docs: fix bad cross-links in motorola-cpcap Kir Kolyshkin
  2021-06-11  3:00 ` [PATCH 2/3] docs/devicetree: fix a cross-ref Kir Kolyshkin
@ 2021-06-11  3:00 ` Kir Kolyshkin
  2021-06-13 23:03   ` Jonathan Corbet
  2 siblings, 1 reply; 6+ messages in thread
From: Kir Kolyshkin @ 2021-06-11  3:00 UTC (permalink / raw)
  To: linux-doc; +Cc: Jonathan Corbet, Kir Kolyshkin, Igor Matheus Andrade Torrente

Commit acda97acb2e98c9 changes dax.txt to dax.rst.
Fix the references accordingly.

Cc: Igor Matheus Andrade Torrente <igormtorrente@gmail.com>
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 Documentation/admin-guide/ext4.rst | 2 +-
 Documentation/filesystems/ext2.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/ext4.rst b/Documentation/admin-guide/ext4.rst
index d2795ca6821e..4c559e08d11e 100644
--- a/Documentation/admin-guide/ext4.rst
+++ b/Documentation/admin-guide/ext4.rst
@@ -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
diff --git a/Documentation/filesystems/ext2.rst b/Documentation/filesystems/ext2.rst
index c2fce22cfd03..154101cf0e4f 100644
--- a/Documentation/filesystems/ext2.rst
+++ b/Documentation/filesystems/ext2.rst
@@ -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.
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH 3/3] docs: fix a cross-ref
  2021-06-11  3:00 ` [PATCH 3/3] docs: " Kir Kolyshkin
@ 2021-06-13 23:03   ` Jonathan Corbet
  0 siblings, 0 replies; 6+ messages in thread
From: Jonathan Corbet @ 2021-06-13 23:03 UTC (permalink / raw)
  To: Kir Kolyshkin, linux-doc; +Cc: Kir Kolyshkin, Igor Matheus Andrade Torrente

Kir Kolyshkin <kolyshkin@gmail.com> writes:

> Commit acda97acb2e98c9 changes dax.txt to dax.rst.
> Fix the references accordingly.
>
> Cc: Igor Matheus Andrade Torrente <igormtorrente@gmail.com>
> Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
> ---
>  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

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-06-13 23:03 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-11  3:00 [PATCH 0/3] docs: fix cross references Kir Kolyshkin
2021-06-11  3:00 ` [PATCH 1/3] docs: fix bad cross-links in motorola-cpcap Kir Kolyshkin
2021-06-11  3:00 ` [PATCH 2/3] docs/devicetree: fix a cross-ref Kir Kolyshkin
2021-06-11  6:57   ` Geert Uytterhoeven
2021-06-11  3:00 ` [PATCH 3/3] docs: " Kir Kolyshkin
2021-06-13 23:03   ` Jonathan Corbet

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.