[PATCH v2] doc: Update mentions of README.fdt-control

[PATCH v2] doc: Update mentions of README.fdt-control

[E Shattow]

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

Fixes: 3e9fddfc4f14 "doc: Move devicetree control doc to rST"
Signed-off-by: E Shattow <e@freeshell.de>
---
 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(-)

diff --git a/doc/arch/nios2.rst b/doc/arch/nios2.rst
index 34a75e7fb00..58f63c996b6 100644
--- a/doc/arch/nios2.rst
+++ b/doc/arch/nios2.rst
@@ -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.
diff --git a/doc/develop/devicetree/control.rst b/doc/develop/devicetree/control.rst
index 0233945f8b6..aa33b4b781f 100644
--- a/doc/develop/devicetree/control.rst
+++ b/doc/develop/devicetree/control.rst
@@ -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)
diff --git a/doc/develop/driver-model/design.rst b/doc/develop/driver-model/design.rst
index 633545944d1..005e0a00a26 100644
--- a/doc/develop/driver-model/design.rst
+++ b/doc/develop/driver-model/design.rst
@@ -1,5 +1,6 @@
 .. SPDX-License-Identifier: GPL-2.0+
 .. sectionauthor:: Simon Glass <sjg@chromium.org>
+.. _driver-model_design:
 
 Design Details
 ==============
diff --git a/doc/develop/driver-model/ethernet.rst b/doc/develop/driver-model/ethernet.rst
index 73c3a728dbf..ca3e50af6ed 100644
--- a/doc/develop/driver-model/ethernet.rst
+++ b/doc/develop/driver-model/ethernet.rst
@@ -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.
diff --git a/doc/develop/spl.rst b/doc/develop/spl.rst
index 7f2eac50806..f76c40437b2 100644
--- a/doc/develop/spl.rst
+++ b/doc/develop/spl.rst
@@ -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
diff --git a/doc/usage/fdt_overlays.rst b/doc/usage/fdt_overlays.rst
index 15ebd17ccb1..7078e3dbd4d 100644
--- a/doc/usage/fdt_overlays.rst
+++ b/doc/usage/fdt_overlays.rst
@@ -1,5 +1,6 @@
 .. SPDX-License-Identifier: GPL-2.0+
 .. Copyright (c) 2017, Pantelis Antoniou <pantelis.antoniou@konsulko.com>
+.. _fdt-overlays:
 
 Device Tree Overlays
 ====================
diff --git a/doc/usage/fit/overlay-fdt-boot.rst b/doc/usage/fit/overlay-fdt-boot.rst
index 3d7296ad913..f0e283f5448 100644
--- a/doc/usage/fit/overlay-fdt-boot.rst
+++ b/doc/usage/fit/overlay-fdt-boot.rst
@@ -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
 ------------------------------
diff --git a/dts/Makefile b/dts/Makefile
index 86bf8dc2156..fd4ae31a533 100644
--- a/dts/Makefile
+++ b/dts/Makefile
@@ -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
-- 
2.50.0

Re: [PATCH v2] doc: Update mentions of README.fdt-control

[Quentin Schulz]

Hi E,

On 9/17/25 3:17 AM, E Shattow wrote:
> 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
> 
> Fixes: 3e9fddfc4f14 "doc: Move devicetree control doc to rST"
> Signed-off-by: E Shattow <e@freeshell.de>
> ---
>   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(-)
> 
> diff --git a/doc/arch/nios2.rst b/doc/arch/nios2.rst
> index 34a75e7fb00..58f63c996b6 100644
> --- a/doc/arch/nios2.rst
> +++ b/doc/arch/nios2.rst
> @@ -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

Re: [PATCH v2] doc: Update mentions of README.fdt-control

[E Shattow]

On 9/23/25 05:14, Quentin Schulz wrote:
> Hi E,
> 
> On 9/17/25 3:17 AM, E Shattow wrote:
>> 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
>>
>> Fixes: 3e9fddfc4f14 "doc: Move devicetree control doc to rST"
>> Signed-off-by: E Shattow <e@freeshell.de>
>> ---
>>   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(-)
>>
>> diff --git a/doc/arch/nios2.rst b/doc/arch/nios2.rst
>> index 34a75e7fb00..58f63c996b6 100644
>> --- a/doc/arch/nios2.rst
>> +++ b/doc/arch/nios2.rst
>> @@ -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

Yes, will use doc instead of ref. Thanks!

-E