Message ID | 1611051980-3834-1-git-send-email-milan.lakhani@codethink.co.uk (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | docs: Change reference that was to removed file | expand |
Milan Lakhani <milan.lakhani@codethink.co.uk> 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@codethink.co.uk> > --- > 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? Thanks, jon -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#234): https://lists.elisa.tech/g/linux-safety/message/234 Mute This Topic: https://lists.elisa.tech/mt/79948363/5278000 Group Owner: linux-safety+owner@lists.elisa.tech Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org] -=-=-=-=-=-=-=-=-=-=-=-
On Tue, Jan 19, 2021 at 6:01 PM Jonathan Corbet <corbet@lwn.net> wrote: > > Milan Lakhani <milan.lakhani@codethink.co.uk> 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@codethink.co.uk> > > --- > > 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/5278000 Group Owner: linux-safety+owner@lists.elisa.tech Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org] -=-=-=-=-=-=-=-=-=-=-=-
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@lwn.net> wrote: >> Milan Lakhani <milan.lakhani@codethink.co.uk> 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@codethink.co.uk> >>> --- >>> 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 (#237): https://lists.elisa.tech/g/linux-safety/message/237 Mute This Topic: https://lists.elisa.tech/mt/79948363/5278000 Group Owner: linux-safety+owner@lists.elisa.tech Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org] -=-=-=-=-=-=-=-=-=-=-=-
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. The kernel will look for the dtb magic value of 0xd00dfeed at the dtb physical address to determine if a dtb has been passed instead of a tagged list. diff --git a/Documentation/translations/zh_CN/arm/Booting b/Documentation/translations/zh_CN/arm/Booting index c3d26ce..d2939c7 100644 --- a/Documentation/translations/zh_CN/arm/Booting +++ b/Documentation/translations/zh_CN/arm/Booting @@ -124,7 +124,7 @@ bootloader 必须传递一个系统内存的位置和最小值,以及根文件 bootloader 必须以 64bit 地址对齐的形式加载一个设备树映像(dtb)到系统 RAM 中,并用启动数据初始化它。dtb 格式在文档 -Documentation/devicetree/booting-without-of.rst 中。内核将会在 +Documentation/devicetree/usage-model.rst 中。内核将会在 dtb 物理地址处查找 dtb 魔数值(0xd00dfeed),以确定 dtb 是否已经代替 标签列表被传递进来。
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@codethink.co.uk> --- Documentation/arm/booting.rst | 2 +- Documentation/translations/zh_CN/arm/Booting | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)