[PATCH] doc: fix references to distro documentation

[PATCH] doc: fix references to distro documentation

[Dario Binacchi]

Commit 37c5195dfcd157 ("doc: Move distro boot doc to rST") renamed
doc/README.distro to doc/develop/distro.rst.

Signed-off-by: Dario Binacchi <dario.binacchi@amarulasolutions.com>
---

 doc/README.gpt                   | 2 +-
 doc/README.uniphier              | 2 +-
 doc/board/emulation/qemu-x86.rst | 2 +-
 doc/board/st/stm32mp1.rst        | 2 +-
 doc/board/tbs/tbs2910.rst        | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/README.gpt b/doc/README.gpt
index 91e397d06f88..394cea0aa875 100644
--- a/doc/README.gpt
+++ b/doc/README.gpt
@@ -177,7 +177,7 @@ To restore GUID partition table one needs to:
      "name=u-boot,size=60MiB;name=boot,size=60Mib,bootable;name=rootfs,size=0"
    It can be used to locate bootable disks with command
    "part list <interface> <dev> -bootable <varname>",
-   please check out doc/README.distro for use.
+   please check out doc/develop/distro.rst for use.
 
 2. Define 'CONFIG_EFI_PARTITION' and 'CONFIG_CMD_GPT'
 
diff --git a/doc/README.uniphier b/doc/README.uniphier
index badfacd66aa5..af746f6c316e 100644
--- a/doc/README.uniphier
+++ b/doc/README.uniphier
@@ -336,7 +336,7 @@ Deployment for Distro Boot
 --------------------------
 
 UniPhier SoC family boot the kernel in a generic manner as described in
-doc/README.distro .
+doc/develop/distro.rst.
 
 To boot the kernel, you need to deploy necesssary components to a file
 system on one of your block devices (eMMC, NAND, USB drive, etc.).
diff --git a/doc/board/emulation/qemu-x86.rst b/doc/board/emulation/qemu-x86.rst
index db842f2ece6e..e605ae3ab32e 100644
--- a/doc/board/emulation/qemu-x86.rst
+++ b/doc/board/emulation/qemu-x86.rst
@@ -57,7 +57,7 @@ to instantiate. Note, the maximum supported CPU number in QEMU is 255.
 U-Boot uses 'distro_bootcmd' by default when booting on x86 QEMU. This tries to
 load a boot script, kernel, and ramdisk from several different interfaces. For
 the default boot order, see 'qemu-x86.h'. For more information, see
-'README.distro'. Most Linux distros can be booted by writing a uboot script.
+'distro.rst'. Most Linux distros can be booted by writing a uboot script.
 For example, Debian (stretch) can be booted by creating a script file named
 'boot.txt' with the contents::
 
diff --git a/doc/board/st/stm32mp1.rst b/doc/board/st/stm32mp1.rst
index 3759df353ee5..0dcc6b783b89 100644
--- a/doc/board/st/stm32mp1.rst
+++ b/doc/board/st/stm32mp1.rst
@@ -478,7 +478,7 @@ or:
   +-------+--------+---------+------------------------+------------------------+
 
 And the 4th partition (Rootfs) is marked bootable with a file extlinux.conf
-following the Generic Distribution feature (doc/README.distro for use).
+following the Generic Distribution feature (doc/develop/distro.rst for use).
 
 The size of fip or ssbl partition must be enough for the associated binary file,
 4MB and 2MB are default values.
diff --git a/doc/board/tbs/tbs2910.rst b/doc/board/tbs/tbs2910.rst
index e97f2b6e6135..4760922a93e6 100644
--- a/doc/board/tbs/tbs2910.rst
+++ b/doc/board/tbs/tbs2910.rst
@@ -181,7 +181,7 @@ If that fails it will then try to boot from several interfaces using
 'distro_bootcmd': It will first try to boot from the microSD slot, then the
 SD slot, then the internal eMMC, then the SATA interface and finally the USB
 interface. For more information on how to configure your distribution to boot,
-see 'README.distro'.
+see 'distro.rst'.
 
 Links:
 ------
-- 
2.32.0

Re: [PATCH] doc: fix references to distro documentation

[Patrice CHOTARD]

Hi Dario

On 1/8/23 11:07, Dario Binacchi wrote:
> Commit 37c5195dfcd157 ("doc: Move distro boot doc to rST") renamed
> doc/README.distro to doc/develop/distro.rst.
> 
> Signed-off-by: Dario Binacchi <dario.binacchi@amarulasolutions.com>
> ---
> 
>  doc/README.gpt                   | 2 +-
>  doc/README.uniphier              | 2 +-
>  doc/board/emulation/qemu-x86.rst | 2 +-
>  doc/board/st/stm32mp1.rst        | 2 +-
>  doc/board/tbs/tbs2910.rst        | 2 +-
>  5 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/README.gpt b/doc/README.gpt
> index 91e397d06f88..394cea0aa875 100644
> --- a/doc/README.gpt
> +++ b/doc/README.gpt
> @@ -177,7 +177,7 @@ To restore GUID partition table one needs to:
>       "name=u-boot,size=60MiB;name=boot,size=60Mib,bootable;name=rootfs,size=0"
>     It can be used to locate bootable disks with command
>     "part list <interface> <dev> -bootable <varname>",
> -   please check out doc/README.distro for use.
> +   please check out doc/develop/distro.rst for use.
>  
>  2. Define 'CONFIG_EFI_PARTITION' and 'CONFIG_CMD_GPT'
>  
> diff --git a/doc/README.uniphier b/doc/README.uniphier
> index badfacd66aa5..af746f6c316e 100644
> --- a/doc/README.uniphier
> +++ b/doc/README.uniphier
> @@ -336,7 +336,7 @@ Deployment for Distro Boot
>  --------------------------
>  
>  UniPhier SoC family boot the kernel in a generic manner as described in
> -doc/README.distro .
> +doc/develop/distro.rst.
>  
>  To boot the kernel, you need to deploy necesssary components to a file
>  system on one of your block devices (eMMC, NAND, USB drive, etc.).
> diff --git a/doc/board/emulation/qemu-x86.rst b/doc/board/emulation/qemu-x86.rst
> index db842f2ece6e..e605ae3ab32e 100644
> --- a/doc/board/emulation/qemu-x86.rst
> +++ b/doc/board/emulation/qemu-x86.rst
> @@ -57,7 +57,7 @@ to instantiate. Note, the maximum supported CPU number in QEMU is 255.
>  U-Boot uses 'distro_bootcmd' by default when booting on x86 QEMU. This tries to
>  load a boot script, kernel, and ramdisk from several different interfaces. For
>  the default boot order, see 'qemu-x86.h'. For more information, see
> -'README.distro'. Most Linux distros can be booted by writing a uboot script.
> +'distro.rst'. Most Linux distros can be booted by writing a uboot script.
>  For example, Debian (stretch) can be booted by creating a script file named
>  'boot.txt' with the contents::
>  
> diff --git a/doc/board/st/stm32mp1.rst b/doc/board/st/stm32mp1.rst
> index 3759df353ee5..0dcc6b783b89 100644
> --- a/doc/board/st/stm32mp1.rst
> +++ b/doc/board/st/stm32mp1.rst
> @@ -478,7 +478,7 @@ or:
>    +-------+--------+---------+------------------------+------------------------+
>  
>  And the 4th partition (Rootfs) is marked bootable with a file extlinux.conf
> -following the Generic Distribution feature (doc/README.distro for use).
> +following the Generic Distribution feature (doc/develop/distro.rst for use).
>  
>  The size of fip or ssbl partition must be enough for the associated binary file,
>  4MB and 2MB are default values.
> diff --git a/doc/board/tbs/tbs2910.rst b/doc/board/tbs/tbs2910.rst
> index e97f2b6e6135..4760922a93e6 100644
> --- a/doc/board/tbs/tbs2910.rst
> +++ b/doc/board/tbs/tbs2910.rst
> @@ -181,7 +181,7 @@ If that fails it will then try to boot from several interfaces using
>  'distro_bootcmd': It will first try to boot from the microSD slot, then the
>  SD slot, then the internal eMMC, then the SATA interface and finally the USB
>  interface. For more information on how to configure your distribution to boot,
> -see 'README.distro'.
> +see 'distro.rst'.
>  
>  Links:
>  ------
Reviewed-by: Patrice Chotard <patrice.chotard@foss.st.com>

Thanks
Patrice

Re: [PATCH] doc: fix references to distro documentation

[Soeren Moch]

Hi Dario,

On 08.01.23 11:07, Dario Binacchi wrote:
> Commit 37c5195dfcd157 ("doc: Move distro boot doc to rST") renamed
> doc/README.distro to doc/develop/distro.rst.
>
> Signed-off-by: Dario Binacchi <dario.binacchi@amarulasolutions.com>
> ---
>
>   doc/README.gpt                   | 2 +-
>   doc/README.uniphier              | 2 +-
>   doc/board/emulation/qemu-x86.rst | 2 +-
>   doc/board/st/stm32mp1.rst        | 2 +-
>   doc/board/tbs/tbs2910.rst        | 2 +-
>   5 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/doc/README.gpt b/doc/README.gpt
> index 91e397d06f88..394cea0aa875 100644
> --- a/doc/README.gpt
> +++ b/doc/README.gpt
> @@ -177,7 +177,7 @@ To restore GUID partition table one needs to:
>        "name=u-boot,size=60MiB;name=boot,size=60Mib,bootable;name=rootfs,size=0"
>      It can be used to locate bootable disks with command
>      "part list <interface> <dev> -bootable <varname>",
> -   please check out doc/README.distro for use.
> +   please check out doc/develop/distro.rst for use.
>
>   2. Define 'CONFIG_EFI_PARTITION' and 'CONFIG_CMD_GPT'
>
> diff --git a/doc/README.uniphier b/doc/README.uniphier
> index badfacd66aa5..af746f6c316e 100644
> --- a/doc/README.uniphier
> +++ b/doc/README.uniphier
> @@ -336,7 +336,7 @@ Deployment for Distro Boot
>   --------------------------
>
>   UniPhier SoC family boot the kernel in a generic manner as described in
> -doc/README.distro .
> +doc/develop/distro.rst.
>
>   To boot the kernel, you need to deploy necesssary components to a file
>   system on one of your block devices (eMMC, NAND, USB drive, etc.).
> diff --git a/doc/board/emulation/qemu-x86.rst b/doc/board/emulation/qemu-x86.rst
> index db842f2ece6e..e605ae3ab32e 100644
> --- a/doc/board/emulation/qemu-x86.rst
> +++ b/doc/board/emulation/qemu-x86.rst
> @@ -57,7 +57,7 @@ to instantiate. Note, the maximum supported CPU number in QEMU is 255.
>   U-Boot uses 'distro_bootcmd' by default when booting on x86 QEMU. This tries to
>   load a boot script, kernel, and ramdisk from several different interfaces. For
>   the default boot order, see 'qemu-x86.h'. For more information, see
> -'README.distro'. Most Linux distros can be booted by writing a uboot script.
> +'distro.rst'. Most Linux distros can be booted by writing a uboot script.
>   For example, Debian (stretch) can be booted by creating a script file named
>   'boot.txt' with the contents::
>
> diff --git a/doc/board/st/stm32mp1.rst b/doc/board/st/stm32mp1.rst
> index 3759df353ee5..0dcc6b783b89 100644
> --- a/doc/board/st/stm32mp1.rst
> +++ b/doc/board/st/stm32mp1.rst
> @@ -478,7 +478,7 @@ or:
>     +-------+--------+---------+------------------------+------------------------+
>
>   And the 4th partition (Rootfs) is marked bootable with a file extlinux.conf
> -following the Generic Distribution feature (doc/README.distro for use).
> +following the Generic Distribution feature (doc/develop/distro.rst for use).
>
>   The size of fip or ssbl partition must be enough for the associated binary file,
>   4MB and 2MB are default values.
> diff --git a/doc/board/tbs/tbs2910.rst b/doc/board/tbs/tbs2910.rst
> index e97f2b6e6135..4760922a93e6 100644
> --- a/doc/board/tbs/tbs2910.rst
> +++ b/doc/board/tbs/tbs2910.rst
> @@ -181,7 +181,7 @@ If that fails it will then try to boot from several interfaces using
>   'distro_bootcmd': It will first try to boot from the microSD slot, then the
>   SD slot, then the internal eMMC, then the SATA interface and finally the USB
>   interface. For more information on how to configure your distribution to boot,
> -see 'README.distro'.
> +see 'distro.rst'.
Please change 'distro.rst' to 'doc/develop/distro.rst' here.
Yes, the 'doc' was missing before, but with the additional 'develop'
directory it becomes even more difficult to find.

Thanks,
Soeren
>
>   Links:
>   ------