Skip to contentSkip to conversation

doc: build: docker: Fix code highlighting syntax

PATCH In review Leonard Anderweit 2 participants 4 messages Apr 1, 2025

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 doc: build: docker: Fix code highlighting syntax

Remove double :: before .. code-block:: bash to correctly highlight the following commands.

---
v2: split in two patches

---
 doc/build/docker.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/build/docker.rst +1 -1
index 01ed35050908..fe087651d347 100644
@@ -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
 
Signature · 1 line
2.43.0
#1 lore raw

PATCH v2 2/2 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.

---
 doc/build/docker.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
doc/build/docker.rst +6 -2
index fe087651d347..4974a98d4af5 100644
@@ -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
Signature · 1 line
2.43.0