Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-19 03:15:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Move bootstd into its own directory

Browse source 
Before adding more files, move the bootstd docs into a new directory,
with an index.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
This commit is contained in:
Simon Glass 2024-07-17 09:30:52 +01:00 • committed by Heinrich Schuchardt
parent d5b6800374
commit c684db989e
10 changed files with 24 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
MAINTAINERS
View file

@ -927,7 +927,7 @@ F: boot/bootmeth*.c
F: boot/bootstd.c F: boot/bootstd.c
F: cmd/bootdev.c F: cmd/bootdev.c
F: cmd/bootflow.c F: cmd/bootflow.c
F: doc/develop/bootstd.rst F: doc/develop/bootstd/
F: doc/usage/bootdev.rst F: doc/usage/bootdev.rst
F: doc/usage/bootflow.rst F: doc/usage/bootflow.rst
F: doc/usage/bootmeth.rst F: doc/usage/bootmeth.rst

2
doc/board/starfive/milk-v_mars_cm.rst
View file

@ -89,7 +89,7 @@ provide a default value.
The variable *$fdtfile* is used in the boot process to automatically load The variable *$fdtfile* is used in the boot process to automatically load
a device-tree provided by the operating system. For details of the boot a device-tree provided by the operating system. For details of the boot
process refer to the :doc:`U-Boot Standard Boot <../../../develop/bootstd>` process refer to the :doc:`/develop/bootstd/index`
description. description.
Boot source selection Boot source selection

2
doc/develop/board_best_practices.rst
View file

@ -7,7 +7,7 @@ In addition to the regular best practices such as using :doc:`checkpatch` and
following the :doc:`docstyle` and the :doc:`codingstyle` there are some things following the :doc:`docstyle` and the :doc:`codingstyle` there are some things
which are specific to creating a new board port. which are specific to creating a new board port.
* Implement :doc:`bootstd` to ensure that most operating systems will be * Implement :doc:`bootstd/index` to ensure that most operating systems will be
supported by the platform. supported by the platform.
* The platform defconfig file must be generated via `make savedefconfig`. * The platform defconfig file must be generated via `make savedefconfig`.

9
doc/develop/bootstd/index.rst Normal file
View file

@ -0,0 +1,9 @@
.. SPDX-License-Identifier: GPL-2.0+:
Standard Boot
=============
.. toctree::
:maxdepth: 2
overview

14
doc/develop/bootstd.rst → doc/develop/bootstd/overview.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
U-Boot Standard Boot Standard Boot Overview
==================== ======================
Introduction Introduction
------------ ------------
@ -17,7 +17,7 @@ introduces the following concepts:
For Linux, the distro (Linux distribution, e.g. Debian, Fedora) is responsible For Linux, the distro (Linux distribution, e.g. Debian, Fedora) is responsible
for creating a bootflow for each kernel combination that it wants to offer. for creating a bootflow for each kernel combination that it wants to offer.
These bootflows are stored on media so they can be discovered by U-Boot. This These bootflows are stored on media so they can be discovered by U-Boot. This
feature is typically called `distro boot` (see :doc:`distro`) because it is feature is typically called `distro boot` (see :doc:`../distro`) because it is
a way for distributions to boot on any hardware. a way for distributions to boot on any hardware.
Traditionally U-Boot has relied on scripts to implement this feature. See Traditionally U-Boot has relied on scripts to implement this feature. See
@ -32,7 +32,7 @@ way to boot with U-Boot. The feature is extensible to different Operating
Systems (such as Chromium OS) and devices (beyond just block and network Systems (such as Chromium OS) and devices (beyond just block and network
devices). It supports EFI boot and EFI bootmgr too. devices). It supports EFI boot and EFI bootmgr too.
Finally, standard boot supports the operation of :doc:`vbe`. Finally, standard boot supports the operation of :doc:`../vbe`.
Bootflow Bootflow
-------- --------
@ -432,16 +432,16 @@ Three commands are available:
`bootdev` `bootdev`
Allows listing of available bootdevs, selecting a particular one and Allows listing of available bootdevs, selecting a particular one and
getting information about it. See :doc:`../usage/cmd/bootdev` getting information about it. See :doc:`/usage/cmd/bootdev`
`bootflow` `bootflow`
Allows scanning one or more bootdevs for bootflows, listing available Allows scanning one or more bootdevs for bootflows, listing available
bootflows, selecting one, obtaining information about it and booting it. bootflows, selecting one, obtaining information about it and booting it.
See :doc:`../usage/cmd/bootflow` See :doc:`/usage/cmd/bootflow`
`bootmeth` `bootmeth`
Allow listing of available bootmethds and setting the order in which they Allow listing of available bootmethds and setting the order in which they
are tried. See :doc:`../usage/cmd/bootmeth` are tried. See :doc:`/usage/cmd/bootmeth`
.. _BootflowStates: .. _BootflowStates:

2
doc/develop/index.rst
View file

@ -29,7 +29,7 @@ Implementation
directories directories
bloblist bloblist
bootstd bootstd/index
ci_testing ci_testing
commands commands
config_binding config_binding

2
doc/usage/cmd/bootdev.rst
View file

@ -22,7 +22,7 @@ Description
The `bootdev` command is used to manage bootdevs. It can list available The `bootdev` command is used to manage bootdevs. It can list available
bootdevs, select one and obtain information about it. bootdevs, select one and obtain information about it.
See :doc:`../../develop/bootstd` for more information about bootdevs in general. See :doc:`/develop/bootstd/index` for more information about bootdevs in general.
bootdev list bootdev list

2
doc/usage/cmd/bootflow.rst
View file

@ -26,7 +26,7 @@ Description
The `bootflow` command is used to manage bootflows. It can scan bootdevs to The `bootflow` command is used to manage bootflows. It can scan bootdevs to
locate bootflows, list them and boot them. locate bootflows, list them and boot them.
See :doc:`../../develop/bootstd` for more information. See :doc:`/develop/bootstd/index` for more information.
Note that `CONFIG_BOOTSTD_FULL` (which enables `CONFIG_CMD_BOOTFLOW_FULL) must Note that `CONFIG_BOOTSTD_FULL` (which enables `CONFIG_CMD_BOOTFLOW_FULL) must
be enabled to obtain full functionality with this command. Otherwise, it only be enabled to obtain full functionality with this command. Otherwise, it only

2
doc/usage/cmd/bootmeth.rst
View file

@ -21,7 +21,7 @@ Description
The `bootmeth` command is used to manage bootmeths. It can list them and change The `bootmeth` command is used to manage bootmeths. It can list them and change
the order in which they are used. the order in which they are used.
See :doc:`../../develop/bootstd` for more information. See :doc:`/develop/bootstd/index` for more information.
.. _bootmeth_order: .. _bootmeth_order:

2
doc/usage/environment.rst
View file

@ -100,7 +100,7 @@ to add environment variables.
Board maintainers are encouraged to migrate to the text-based environment as it Board maintainers are encouraged to migrate to the text-based environment as it
is easier to maintain. The distro-board script still requires the old-style is easier to maintain. The distro-board script still requires the old-style
environments, so use :doc:`../develop/bootstd` instead. environments, so use :doc:`/develop/bootstd/index` instead.
List of environment variables List of environment variables