doc: Move bootstd into its own directory

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

View File

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

View File

@ -89,7 +89,7 @@ provide a default value.
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
process refer to the :doc:`U-Boot Standard Boot <../../../develop/bootstd>`
process refer to the :doc:`/develop/bootstd/index`
description.
Boot source selection

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
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.
* The platform defconfig file must be generated via `make savedefconfig`.

View File

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

View File

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+:
U-Boot Standard Boot
====================
Standard Boot Overview
======================
Introduction
------------
@ -17,7 +17,7 @@ introduces the following concepts:
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.
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.
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
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
--------
@ -432,16 +432,16 @@ Three commands are available:
`bootdev`
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`
Allows scanning one or more bootdevs for bootflows, listing available
bootflows, selecting one, obtaining information about it and booting it.
See :doc:`../usage/cmd/bootflow`
See :doc:`/usage/cmd/bootflow`
`bootmeth`
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:

View File

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

View File

@ -22,7 +22,7 @@ Description
The `bootdev` command is used to manage bootdevs. It can list available
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

View File

@ -26,7 +26,7 @@ Description
The `bootflow` command is used to manage bootflows. It can scan bootdevs to
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
be enabled to obtain full functionality with this command. Otherwise, it only

View File

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

View File

@ -100,7 +100,7 @@ to add environment variables.
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
environments, so use :doc:`../develop/bootstd` instead.
environments, so use :doc:`/develop/bootstd/index` instead.
List of environment variables