diff mbox series

[v3,21/27] doc: Move UEFI under develop/

Message ID 20210318072517.26894-22-sjg@chromium.org
State Accepted
Commit d1ceeeff6c2ee1e55b7140654c8d6de44b60dab6
Delegated to: Simon Glass
Headers show
Series binman: Support devicetree update in all entries | expand

Commit Message

Simon Glass March 18, 2021, 7:25 a.m. UTC
Much of the content here is useful only for development. Move it under
that section.

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

Changes in v3:
- Fix x86 docs which refer to this

Changes in v2:
- Move UEFI under develop/ instead

 doc/arch/x86.rst                         |  4 ++--
 doc/develop/index.rst                    |  1 +
 doc/{ => develop}/uefi/index.rst         |  4 ++++
 doc/{ => develop}/uefi/iscsi.rst         |  0
 doc/{ => develop}/uefi/u-boot_on_efi.rst |  0
 doc/{ => develop}/uefi/uefi.rst          |  0
 doc/index.rst                            | 12 ------------
 7 files changed, 7 insertions(+), 14 deletions(-)
 rename doc/{ => develop}/uefi/index.rst (51%)
 rename doc/{ => develop}/uefi/iscsi.rst (100%)
 rename doc/{ => develop}/uefi/u-boot_on_efi.rst (100%)
 rename doc/{ => develop}/uefi/uefi.rst (100%)

Comments

Heinrich Schuchardt March 18, 2021, 9:23 a.m. UTC | #1
On 18.03.21 08:25, Simon Glass wrote:
> Much of the content here is useful only for development. Move it under
> that section.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>

The patch cannot be applied independently of patch 20/27.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
>
> Changes in v3:
> - Fix x86 docs which refer to this
>
> Changes in v2:
> - Move UEFI under develop/ instead
>
>  doc/arch/x86.rst                         |  4 ++--
>  doc/develop/index.rst                    |  1 +
>  doc/{ => develop}/uefi/index.rst         |  4 ++++
>  doc/{ => develop}/uefi/iscsi.rst         |  0
>  doc/{ => develop}/uefi/u-boot_on_efi.rst |  0
>  doc/{ => develop}/uefi/uefi.rst          |  0
>  doc/index.rst                            | 12 ------------
>  7 files changed, 7 insertions(+), 14 deletions(-)
>  rename doc/{ => develop}/uefi/index.rst (51%)
>  rename doc/{ => develop}/uefi/iscsi.rst (100%)
>  rename doc/{ => develop}/uefi/u-boot_on_efi.rst (100%)
>  rename doc/{ => develop}/uefi/uefi.rst (100%)
>
> diff --git a/doc/arch/x86.rst b/doc/arch/x86.rst
> index cc307aa8d5e..2ebfed871bd 100644
> --- a/doc/arch/x86.rst
> +++ b/doc/arch/x86.rst
> @@ -709,8 +709,8 @@ to load a 'u-boot-payload.efi', see below test logs on QEMU.
>    No controllers found
>    Hit any key to stop autoboot:  0
>
> -See :doc:`../uefi/u-boot_on_efi` and :doc:`../uefi/uefi` for details of
> -EFI support in U-Boot.
> +See :doc:`../develop/uefi/u-boot_on_efi` and :doc:`../develop/uefi/uefi` for
> +details of EFI support in U-Boot.
>
>  Chain-loading
>  -------------
> diff --git a/doc/develop/index.rst b/doc/develop/index.rst
> index 41c0ba1ebd9..84914bb47bf 100644
> --- a/doc/develop/index.rst
> +++ b/doc/develop/index.rst
> @@ -13,6 +13,7 @@ Implementation
>     global_data
>     logging
>     menus
> +   uefi/index
>     version
>
>  Debugging
> diff --git a/doc/uefi/index.rst b/doc/develop/uefi/index.rst
> similarity index 51%
> rename from doc/uefi/index.rst
> rename to doc/develop/uefi/index.rst
> index b790a91f174..7e65dbc5d5e 100644
> --- a/doc/uefi/index.rst
> +++ b/doc/develop/uefi/index.rst
> @@ -3,6 +3,10 @@
>  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
>
> diff --git a/doc/uefi/iscsi.rst b/doc/develop/uefi/iscsi.rst
> similarity index 100%
> rename from doc/uefi/iscsi.rst
> rename to doc/develop/uefi/iscsi.rst
> diff --git a/doc/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst
> similarity index 100%
> rename from doc/uefi/u-boot_on_efi.rst
> rename to doc/develop/uefi/u-boot_on_efi.rst
> diff --git a/doc/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
> similarity index 100%
> rename from doc/uefi/uefi.rst
> rename to doc/develop/uefi/uefi.rst
> diff --git a/doc/index.rst b/doc/index.rst
> index 4c44955d67f..366963813ac 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
>  --------------------------
>
>
Simon Glass March 19, 2021, 11:52 p.m. UTC | #2
On 18.03.21 08:25, Simon Glass wrote:
> Much of the content here is useful only for development. Move it under
> that section.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>

The patch cannot be applied independently of patch 20/27.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
>
> Changes in v3:
> - Fix x86 docs which refer to this
>
> Changes in v2:
> - Move UEFI under develop/ instead
>
>  doc/arch/x86.rst                         |  4 ++--
>  doc/develop/index.rst                    |  1 +
>  doc/{ => develop}/uefi/index.rst         |  4 ++++
>  doc/{ => develop}/uefi/iscsi.rst         |  0
>  doc/{ => develop}/uefi/u-boot_on_efi.rst |  0
>  doc/{ => develop}/uefi/uefi.rst          |  0
>  doc/index.rst                            | 12 ------------
>  7 files changed, 7 insertions(+), 14 deletions(-)
>  rename doc/{ => develop}/uefi/index.rst (51%)
>  rename doc/{ => develop}/uefi/iscsi.rst (100%)
>  rename doc/{ => develop}/uefi/u-boot_on_efi.rst (100%)
>  rename doc/{ => develop}/uefi/uefi.rst (100%)
>
Applied to u-boot-dm/next, thanks!
diff mbox series

Patch

diff --git a/doc/arch/x86.rst b/doc/arch/x86.rst
index cc307aa8d5e..2ebfed871bd 100644
--- a/doc/arch/x86.rst
+++ b/doc/arch/x86.rst
@@ -709,8 +709,8 @@  to load a 'u-boot-payload.efi', see below test logs on QEMU.
   No controllers found
   Hit any key to stop autoboot:  0
 
-See :doc:`../uefi/u-boot_on_efi` and :doc:`../uefi/uefi` for details of
-EFI support in U-Boot.
+See :doc:`../develop/uefi/u-boot_on_efi` and :doc:`../develop/uefi/uefi` for
+details of EFI support in U-Boot.
 
 Chain-loading
 -------------
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 41c0ba1ebd9..84914bb47bf 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -13,6 +13,7 @@  Implementation
    global_data
    logging
    menus
+   uefi/index
    version
 
 Debugging
diff --git a/doc/uefi/index.rst b/doc/develop/uefi/index.rst
similarity index 51%
rename from doc/uefi/index.rst
rename to doc/develop/uefi/index.rst
index b790a91f174..7e65dbc5d5e 100644
--- a/doc/uefi/index.rst
+++ b/doc/develop/uefi/index.rst
@@ -3,6 +3,10 @@ 
 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
 
diff --git a/doc/uefi/iscsi.rst b/doc/develop/uefi/iscsi.rst
similarity index 100%
rename from doc/uefi/iscsi.rst
rename to doc/develop/uefi/iscsi.rst
diff --git a/doc/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst
similarity index 100%
rename from doc/uefi/u-boot_on_efi.rst
rename to doc/develop/uefi/u-boot_on_efi.rst
diff --git a/doc/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
similarity index 100%
rename from doc/uefi/uefi.rst
rename to doc/develop/uefi/uefi.rst
diff --git a/doc/index.rst b/doc/index.rst
index 4c44955d67f..366963813ac 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
 --------------------------