From e763c195074f880d31896a36888271bcf0f5758a Mon Sep 17 00:00:00 2001 From: Leonard Anderweit Date: Tue, 1 Apr 2025 14:28:10 +0200 Subject: doc: build: docker: Fix code highlighting syntax Remove double :: before .. code-block:: bash to correctly highlight the following commands. Signed-off-by: Leonard Anderweit Reviewed-by: Quentin Schulz --- doc/build/docker.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/build/docker.rst b/doc/build/docker.rst index 01ed3505090..fe087651d34 100644 --- a/doc/build/docker.rst +++ b/doc/build/docker.rst @@ -28,7 +28,7 @@ fast amd64 (i.e. 64-bit x86) and arm64 machines is:: And this will result in a builder named multiarch-multinode that will build each platform natively on each node. -To build the image yourself:: +To build the image yourself: .. code-block:: bash -- cgit v1.3.1 From 4738e306fd0d7d7fb3fac9e36717fb07af943965 Mon Sep 17 00:00:00 2001 From: Leonard Anderweit Date: Tue, 1 Apr 2025 14:28:11 +0200 Subject: doc: build: docker: Use code-block for syntax highlighting Use ..code-block:: syntax highlighting instead of :: so all bash commands use the same syntax highlighting. Signed-off-by: Leonard Anderweit Reviewed-by: Quentin Schulz --- doc/build/docker.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/build/docker.rst b/doc/build/docker.rst index fe087651d34..4974a98d4af 100644 --- a/doc/build/docker.rst +++ b/doc/build/docker.rst @@ -12,7 +12,9 @@ You will need a multi-platform container, otherwise this error is shown:: ERROR: Multi-platform build is not supported for the docker driver. Switch to a different driver, or turn on the containerd image store, and try again. -You can add a simple one with:: +You can add a simple one with: + +.. code-block:: bash sudo docker buildx create --name multiarch --driver docker-container --use @@ -20,7 +22,9 @@ This will result in a builder that will use QEMU for the non-native architectures request in a build. While both amd64 and arm64 happen in parallel, the non-native part will take considerably longer as it must use QEMU to emulate the foreign code. An alternative, if you have accesss to reasonably -fast amd64 (i.e. 64-bit x86) and arm64 machines is:: +fast amd64 (i.e. 64-bit x86) and arm64 machines is: + +.. code-block:: bash sudo docker buildx create --name multiarch-multinode --node localNode --bootstrap --use sudo docker buildx create --name multiarch-multinode --append --node remoteNode --bootstrap ssh://user@host -- cgit v1.3.1 From e66148060f90292dc02062bc4c18acb6fc1f6f85 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 26 Mar 2025 11:10:24 +0100 Subject: doc: correct references to overlay-fdt-boot.txt doc/uImage.FIT/overlay-fdt-boot.txt does not exist anymore. Reference the correct section of doc/usage/fit/overlay-fdt-boot.rst. Fixes: 6f6e8bb695a7 ("doc: Bring in the FIT overlay information") Signed-off-by: Heinrich Schuchardt --- doc/README.pxe | 2 +- doc/usage/fdt_overlays.rst | 4 ++-- doc/usage/fit/overlay-fdt-boot.rst | 2 ++ 3 files changed, 5 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/README.pxe b/doc/README.pxe index af2e64a5776..9fff2cd5ae9 100644 --- a/doc/README.pxe +++ b/doc/README.pxe @@ -160,7 +160,7 @@ kernel - if this label is chosen, use tftp to retrieve the kernel It will passed to bootm with that address. (see: doc/uImage.FIT/command_syntax_extensions.txt) It useful for overlay selection in pxe file - (see: doc/uImage.FIT/overlay-fdt-boot.txt) + (see: doc/usage/fit/overlay-fdt-boot.rst). fdtoverlays [...] - if this label is chosen, use tftp to retrieve the DT overlay(s) at . it will be temporarily stored at the diff --git a/doc/usage/fdt_overlays.rst b/doc/usage/fdt_overlays.rst index 81d0d37f3f1..15ebd17ccb1 100644 --- a/doc/usage/fdt_overlays.rst +++ b/doc/usage/fdt_overlays.rst @@ -76,8 +76,8 @@ There are two ways to apply overlays in U-Boot. * Manually load and apply overlays The remainder of this document will discuss using overlays via the manual -approach. For information on using overlays as part of a FIT image please see: -doc/uImage.FIT/overlay-fdt-boot.txt +approach. For information on using overlays as part of a FIT image please see +:ref:`fit_configuration_using_overlays`. Manually Loading and Applying Overlays -------------------------------------- diff --git a/doc/usage/fit/overlay-fdt-boot.rst b/doc/usage/fit/overlay-fdt-boot.rst index a7db1a37f7a..3d7296ad913 100644 --- a/doc/usage/fit/overlay-fdt-boot.rst +++ b/doc/usage/fit/overlay-fdt-boot.rst @@ -111,6 +111,8 @@ Where config is one of:: This selects the DTB to use when booting. +.. _fit_configuration_using_overlays: + Configuration using overlays ---------------------------- -- cgit v1.3.1 From 7871285a0a8fb6726ea7537c4f592e117f93768b Mon Sep 17 00:00:00 2001 From: Andrew Davis Date: Wed, 19 Mar 2025 10:17:42 -0500 Subject: doc: Fix typo bootfloe to bootflow Signed-off-by: Andrew Davis --- doc/usage/cmd/bootflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/usage/cmd/bootflow.rst b/doc/usage/cmd/bootflow.rst index 5d41fe37a7a..01e7eff300b 100644 --- a/doc/usage/cmd/bootflow.rst +++ b/doc/usage/cmd/bootflow.rst @@ -18,7 +18,7 @@ Synopsis bootflow read bootflow boot bootflow cmdline [set|get|clear|delete|auto] [] - bootfloe menu [-t] + bootflow menu [-t] Description ----------- -- cgit v1.3.1