diff mbox series

[15/20] doc: Move UEFI down a bit

Message ID 20210307193148.1513733-16-sjg@chromium.org
State Changes Requested, archived
Headers show
Series binman: Support devicetree update in all entries | expand

Commit Message

Simon Glass March 7, 2021, 7:31 p.m. UTC
This features a little too prominently in the contents at present. It
seems more important to talk about driver model and the API (which
includes some UEFI notes).

Reposition it below those.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 doc/index.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

Comments

Heinrich Schuchardt March 7, 2021, 7:51 p.m. UTC | #1
On 3/7/21 8:31 PM, Simon Glass wrote:
> This features a little too prominently in the contents at present. It
> seems more important to talk about driver model and the API (which
> includes some UEFI notes).

The driver model is only relevant for developers. So it should be moved
to "Develop U-Boot".

The UEFI part should be split up into a development related part under
/doc/develop/ and a usage related part under /doc/usage. But as a first
step simply move it to /doc/develop together with the driver model, please.

Best regards

Heinrich

>
> Reposition it below those.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
>   doc/index.rst | 24 ++++++++++++------------
>   1 file changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/doc/index.rst b/doc/index.rst
> index 4c44955d67f..cdcc0a9e60a 100644
> --- a/doc/index.rst
> +++ b/doc/index.rst
> @@ -38,18 +38,6 @@ want to contribute to U-Boot.
>
>      develop/index
>
> -Unified Extensible Firmware (UEFI)
> -----------------------------------
> -
> -U-Boot provides an implementation of the UEFI API allowing to run UEFI
> -compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
> -can be run an UEFI payload.
> -
> -.. toctree::
> -   :maxdepth: 2
> -
> -   uefi/index
> -
>   Driver-Model documentation
>   --------------------------
>
> @@ -76,6 +64,18 @@ needed).
>
>      api/index
>
> +Unified Extensible Firmware (UEFI)
> +----------------------------------
> +
> +U-Boot provides an implementation of the UEFI API allowing to run UEFI
> +compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
> +can be run an UEFI payload.
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   uefi/index
> +
>   Architecture-specific doc
>   -------------------------
>
>
diff mbox series

Patch

diff --git a/doc/index.rst b/doc/index.rst
index 4c44955d67f..cdcc0a9e60a 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -38,18 +38,6 @@  want to contribute to U-Boot.
 
    develop/index
 
-Unified Extensible Firmware (UEFI)
-----------------------------------
-
-U-Boot provides an implementation of the UEFI API allowing to run UEFI
-compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
-can be run an UEFI payload.
-
-.. toctree::
-   :maxdepth: 2
-
-   uefi/index
-
 Driver-Model documentation
 --------------------------
 
@@ -76,6 +64,18 @@  needed).
 
    api/index
 
+Unified Extensible Firmware (UEFI)
+----------------------------------
+
+U-Boot provides an implementation of the UEFI API allowing to run UEFI
+compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
+can be run an UEFI payload.
+
+.. toctree::
+   :maxdepth: 2
+
+   uefi/index
+
 Architecture-specific doc
 -------------------------