Skip to contentSkip to conversation

doc: fix references to distro documentation

PATCH In review Dario Binacchi 3 participants 3 messages Jan 9, 2023 – Jan 11, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 doc: fix references to distro documentation

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

---

Changes in v2:
- Change 'distro.rst' to 'doc/develop/distro.rst' also for doc/board/emulation/qemu-x86.rst and doc/board/tbs/tbs2910.rst files.
- Add 'Reviewed-by' tag of Patrice Chotard.

 doc/README.gpt                   | 2 +-
 doc/README.uniphier              | 2 +-
 doc/board/emulation/qemu-x86.rst | 3 ++-
 doc/board/st/stm32mp1.rst        | 2 +-
 doc/board/tbs/tbs2910.rst        | 2 +-
 5 files changed, 6 insertions(+), 5 deletions(-)
doc/README.gpt +1 -1
index 91e397d06f88..394cea0aa875 100644
@@ -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'
 
doc/README.uniphier +1 -1
index badfacd66aa5..af746f6c316e 100644
@@ -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.).
doc/board/emulation/qemu-x86.rst +2 -1
index db842f2ece6e..e7dd4e994d38 100644
@@ -57,7 +57,8 @@ 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.
+'doc/develop/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::
 
doc/board/st/stm32mp1.rst +1 -1
index 3759df353ee5..0dcc6b783b89 100644
@@ -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.
doc/board/tbs/tbs2910.rst +1 -1
index e97f2b6e6135..9d4be61783ed 100644
@@ -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 'doc/develop/distro.rst'.
 
 Links:
 ------
Signature · 1 line
2.32.0
Reviewed-by on v2 1/1
#1 lore raw
Quoted 5 lines · Dario Binacchi

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

Quoted 5 lines

---

Changes in v2:
- Change 'distro.rst' to 'doc/develop/distro.rst' also for doc/board/emulation/qemu-x86.rst and doc/board/tbs/tbs2910.rst files.

Thanks a lot,
Soeren

Quoted 75 lines

- Add 'Reviewed-by' tag of Patrice Chotard.

  doc/README.gpt                   | 2 +-
  doc/README.uniphier              | 2 +-
  doc/board/emulation/qemu-x86.rst | 3 ++-
  doc/board/st/stm32mp1.rst        | 2 +-
  doc/board/tbs/tbs2910.rst        | 2 +-
  5 files changed, 6 insertions(+), 5 deletions(-)
doc/README.gpt +1 -1
index 91e397d06f88..394cea0aa875 100644
@@ -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'
 
doc/README.uniphier +1 -1
index badfacd66aa5..af746f6c316e 100644
@@ -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.).
doc/board/emulation/qemu-x86.rst +2 -1
index db842f2ece6e..e7dd4e994d38 100644
@@ -57,7 +57,8 @@ 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.
+'doc/develop/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::
 
doc/board/st/stm32mp1.rst +1 -1
index 3759df353ee5..0dcc6b783b89 100644
@@ -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.
doc/board/tbs/tbs2910.rst +1 -1
index e97f2b6e6135..9d4be61783ed 100644
@@ -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 'doc/develop/distro.rst'.
 
  Links:
  ------
Reviewed-by on v2 1/1
#2 lore raw
In reply to Dario Binacchi

Hi,

Quoted 78 lines · Dario Binacchi

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

---

Changes in v2:
- Change 'distro.rst' to 'doc/develop/distro.rst' also for doc/board/emulation/qemu-x86.rst and doc/board/tbs/tbs2910.rst files.
- Add 'Reviewed-by' tag of Patrice Chotard.

  doc/README.gpt                   | 2 +-
  doc/README.uniphier              | 2 +-
  doc/board/emulation/qemu-x86.rst | 3 ++-
  doc/board/st/stm32mp1.rst        | 2 +-
  doc/board/tbs/tbs2910.rst        | 2 +-
  5 files changed, 6 insertions(+), 5 deletions(-)
doc/README.gpt +1 -1
index 91e397d06f88..394cea0aa875 100644
@@ -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'
doc/README.uniphier +1 -1
index badfacd66aa5..af746f6c316e 100644
@@ -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.).
doc/board/emulation/qemu-x86.rst +2 -1
index db842f2ece6e..e7dd4e994d38 100644
@@ -57,7 +57,8 @@ 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.
+'doc/develop/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::
 
doc/board/st/stm32mp1.rst +1 -1
index 3759df353ee5..0dcc6b783b89 100644
@@ -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.
doc/board/tbs/tbs2910.rst +0 -0
index e97f2b6e6135..9d4be61783ed 100644

doc/board/tbs/tbs2910.rst If that fails it will then try to boot from several interfaces using · line 187

Quoted 8 lines
doc/board/tbs/tbs2910.rst +1 -1
@@ -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 'doc/develop/distro.rst'.
 
  Links:
  ------

NITS

'doc/develop/distro.rst' can be replaced by reference to the rst file for the 3 rst files

:ref:../../develop/distro

just to allow clickable link in generated file

Thanks
Patrick

regards

Patrick