doc: Update mentions of README.fdt-control
PATCH v2 1/1 doc: Update mentions of README.fdt-control
Update documents 'README.fdt-control' reference to replacement 'control.rst':
doc/arch/nios2.rst
dts/Makefile
Also convert some adjacent pathname mentions to rST links where applicable
--- doc/arch/nios2.rst | 2 +- doc/develop/devicetree/control.rst | 3 ++- doc/develop/driver-model/design.rst | 1 + doc/develop/driver-model/ethernet.rst | 2 +- doc/develop/spl.rst | 2 +- doc/usage/fdt_overlays.rst | 1 + doc/usage/fit/overlay-fdt-boot.rst | 2 +- dts/Makefile | 2 +- 8 files changed, 9 insertions(+), 6 deletions(-)
doc/arch/nios2.rst +1 -1
@@ -13,7 +13,7 @@ Please refer to the link for Linux port and toolchains: http://rocketboards.org/foswiki/view/Documentation/NiosIILinuxUserManual The Nios II port of u-boot is controlled by device tree. Please check -out doc/README.fdt-control. +out :ref:`devicetree_control`. To add a new board/configuration (eg, mysystem) to u-boot, you will need three files.
doc/develop/devicetree/control.rst +2 -1
@@ -1,6 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0+ .. sectionauthor:: Copyright 2011 The Chromium OS Authors .. Copyright 2023-2024 Linaro Ltd. +.. _devicetree_control: Devicetree Control in U-Boot ============================
@@ -282,7 +283,7 @@ U-Boot can be divided into three phases: TPL, SPL and U-Boot proper. The full devicetree is available to U-Boot proper, but normally only a subset (or none at all) is available to TPL and SPL. See 'Pre-Relocation Support' and -'SPL Support' in doc/driver-model/design.rst for more details. +'SPL Support' in :ref:`driver-model_design` for more details. Using several DTBs in the SPL (SPL_MULTI_DTB_FIT Kconfig option)
doc/develop/driver-model/design.rst +1 -0
@@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ .. sectionauthor:: Simon Glass <[email protected]> +.. _driver-model_design: Design Details ==============
doc/develop/driver-model/ethernet.rst +1 -1
@@ -8,7 +8,7 @@ own ethernet device driver. Here we will describe a new pseudo 'APE' driver. Most existing drivers do already - and new network driver MUST - use the U-Boot core driver model. Generic information about this can be found in -doc/driver-model/design.rst, this document will thus focus on the network +:ref:`driver-model_design`, this document will thus focus on the network specific code parts. Some drivers are still using the old Ethernet interface, differences between the two and hints about porting will be handled at the end.
doc/develop/spl.rst +1 -1
@@ -145,7 +145,7 @@ fdtgrep is also used to remove: 'bootph-verify' (VPL)) All the nodes remaining in the SPL devicetree are bound -(see doc/driver-model/design.rst). +(see :ref:`driver-model_design`). NOTE: U-Boot migrated to a new schema for the u-boot,dm-* tags in 2023. Please update to use the new bootph-* tags as described in the
doc/usage/fdt_overlays.rst +1 -0
@@ -1,5 +1,6 @@ .. SPDX-License-Identifier: GPL-2.0+ .. Copyright (c) 2017, Pantelis Antoniou <[email protected]> +.. _fdt-overlays: Device Tree Overlays ====================
doc/usage/fit/overlay-fdt-boot.rst +1 -1
@@ -13,7 +13,7 @@ that matches the desired configuration. This document focuses on specifically using overlays as part of a FIT image. General information regarding overlays including its syntax and building it -can be found in doc/README.fdt-overlays +can be found in :ref:`fdt-overlays` Configuration without overlays ------------------------------
dts/Makefile +1 -1
@@ -3,7 +3,7 @@ # Copyright (c) 2011 The Chromium OS Authors. # This Makefile builds the internal U-Boot fdt if CONFIG_OF_CONTROL is -# enabled. See doc/README.fdt-control for more details. +# enabled. See doc/develop/devicetree/control.rst for more details. DEVICE_TREE ?= $(CONFIG_DEFAULT_DEVICE_TREE:"%"=%) ifeq ($(DEVICE_TREE),)
base-commit: b82fa9d752b025d3b5305b5b07debe6808a5d027
Signature · 1 line
2.50.0
Hi E,
Quoted 24 lines · E Shattow
Update documents 'README.fdt-control' reference to replacement '
control.rst':
doc/arch/nios2.rst
dts/MakefileAlso convert some adjacent pathname mentions to rST links where applicable
Fixes 3e9fddfc4f14 "doc: Move devicetree control doc to rST"Signed-off-by E Shattow <[email protected]>--- doc/arch/nios2.rst | 2 +- doc/develop/devicetree/control.rst | 3 ++- doc/develop/driver-model/design.rst | 1 + doc/develop/driver-model/ethernet.rst | 2 +- doc/develop/spl.rst | 2 +- doc/usage/fdt_overlays.rst | 1 + doc/usage/fit/overlay-fdt-boot.rst | 2 +- dts/Makefile | 2 +- 8 files changed, 9 insertions(+), 6 deletions(-)doc/arch/nios2.rst +0
-0
doc/arch/nios2.rst Please refer to the link for Linux port and toolchains: · line 16
Quoted 5 lines
doc/arch/nios2.rst +1
-1@@ -13,7 +13,7 @@ Please refer to the link for Linux port and toolchains: http://rocketboards.org/foswiki/view/Documentation/NiosIILinuxUserManual The Nios II port of u-boot is controlled by device tree. Please check -out doc/README.fdt-control. +out :ref:`devicetree_control`.
If you're not pointing at a specific section in the document, maybe use :doc:[1] instead of :ref:, in which case you wouldn't need to add labels at the top of each file?
What do you think?
[1] https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc
Cheers,
Quentin
Quoted 39 lines · Quentin Schulz
Hi E,
Quoted 29 lines · E Shattow
Update documents 'README.fdt-control' reference to replacement '
control.rst':
doc/arch/nios2.rst
dts/MakefileAlso convert some adjacent pathname mentions to rST links where applicable
Fixes 3e9fddfc4f14 "doc: Move devicetree control doc to rST"Signed-off-by E Shattow <[email protected]>---
doc/arch/nios2.rst | 2 +-
doc/develop/devicetree/control.rst | 3 ++-
doc/develop/driver-model/design.rst | 1 +
doc/develop/driver-model/ethernet.rst| 2 +-
doc/develop/spl.rst | 2 +-
doc/usage/fdt_overlays.rst | 1 +
doc/usage/fit/overlay-fdt-boot.rst | 2 +-
dts/Makefile | 2 +-8 files changed, 9 insertions(+), 6 deletions(-)doc/arch/nios2.rst +0
-0@@ -13,7 +13,7 @@ Please refer to the link for Linux port and toolchains:http://rocketboards.org/foswiki/view/Documentation/
NiosIILinuxUserManual
The Nios II port of u-boot is controlled by device tree. Please checkdoc/arch/nios2.rst Please refer to the link for Linux port and toolchains: · line 16
Quoted 2 lines
doc/arch/nios2.rst +1
-1-out doc/README.fdt-control. +out :ref:`devicetree_control`.If you're not pointing at a specific section in the document, maybe use :doc:[1] instead of :ref:, in which case you wouldn't need to add labels at the top of each file?
Quoted 6 lines
What do you think?
[1] https://www.sphinx-doc.org/en/master/usage/referencing.html#role-doc
Cheers,
Quentin
Yes, will use doc instead of ref. Thanks!
-E