Re: [linux-safety] [PATCH] docs: Change reference that was to removed file

From: Milan Lakhani
Date: Wed Jan 20 2021 - 10:06:38 EST


Thanks Rob, Jon, I've submitted a new patch pointing the two broken links and also usage-model.rst all to https://www.devicetree.org.specifications/.

Milan

On 20/01/2021 01:07, Rob Herring wrote:
On Tue, Jan 19, 2021 at 6:01 PM Jonathan Corbet <corbet@xxxxxxx> wrote:
Milan Lakhani <milan.lakhani@xxxxxxxxxxxxxxx> writes:

[CC += Rob]

There were two references to
Documentation/devicetree/booting-without-of.rst for dtb format
information. This file has been removed, so I have changed the links to
Documentation/devicetree/usage-model.rst for this information, which
itself points to https://elinux.org/Device_Tree_Usage for an overview of
the device tree data format.

Signed-off-by: Milan Lakhani <milan.lakhani@xxxxxxxxxxxxxxx>
---
Documentation/arm/booting.rst | 2 +-
Documentation/translations/zh_CN/arm/Booting | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/arm/booting.rst b/Documentation/arm/booting.rst
index a226345..5392d01 100644
--- a/Documentation/arm/booting.rst
+++ b/Documentation/arm/booting.rst
@@ -128,7 +128,7 @@ it. The recommended placement is in the first 16KiB of RAM.

The boot loader must load a device tree image (dtb) into system ram
at a 64bit aligned address and initialize it with the boot data. The
-dtb format is documented in Documentation/devicetree/booting-without-of.rst.
+dtb format is documented in Documentation/devicetree/usage-model.rst.
Except that ... usage-model.rst doesn't actually document the DTB
format. Perhaps we should instead substitute a link that does what's
promised here?
Yes, it's in the DT spec. I'd point to
'https://www.devicetree.org/specifications/' so it's always going to
show the latest. And that's the link we have elsewhere in the kernel.

usage-model.rst is also something needing updating...

Rob


-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#235): https://lists.elisa.tech/g/linux-safety/message/235
Mute This Topic: https://lists.elisa.tech/mt/79948363/4617862
Group Owner: linux-safety+owner@xxxxxxxxxxxxxxxx
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [milan.lakhani@xxxxxxxxxxxxxxx]
-=-=-=-=-=-=-=-=-=-=-=-