From: E Shattow <e@freeshell.de>
To: Quentin Schulz <quentin.schulz@cherry.de>,
Tom Rini <trini@konsulko.com>, Simon Glass <sjg@chromium.org>,
Heinrich Schuchart <xypron.glpk@gmx.de>
Cc: u-boot@lists.denx.de
Subject: Re: [PATCH v2] doc: Update mentions of README.fdt-control
Date: Tue, 23 Sep 2025 15:21:14 -0700 [thread overview]
Message-ID: <5c574f7e-1765-4cc1-9580-a9cdc890c764@freeshell.de> (raw)
In-Reply-To: <f1694902-6b69-48e9-aae6-1f0801c72a21@cherry.de>
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
prev parent reply other threads:[~2025-09-23 22:21 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-17 1:17 [PATCH v2] doc: Update mentions of README.fdt-control E Shattow
2025-09-23 12:14 ` Quentin Schulz
2025-09-23 22:21 ` E Shattow [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5c574f7e-1765-4cc1-9580-a9cdc890c764@freeshell.de \
--to=e@freeshell.de \
--cc=quentin.schulz@cherry.de \
--cc=sjg@chromium.org \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=xypron.glpk@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox