On 3/6/26 20:52, David Lechner wrote:
Fix 4 instances in buildman.rst where examples were missing :: for
proper formatting. Three cases just had a single : and in one case,
: didn't make grammatical sense, so it gets a stand-alone :: along
with fixing the indent.

Signed-off-by: David Lechner <[email protected]>
---
  tools/buildman/buildman.rst | 16 +++++++++-------
  1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/tools/buildman/buildman.rst b/tools/buildman/buildman.rst
index 9e850b26ec0..a2061715788 100644
--- a/tools/buildman/buildman.rst
+++ b/tools/buildman/buildman.rst
@@ -146,7 +146,7 @@ the '&' operator to limit the selection:
  - 'freescale & arm sandbox' - all Freescale boards with ARM architecture, plus
    sandbox
-You can also use -x to specifically exclude some boards. For example:
+You can also use -x to specifically exclude some boards. For example::
buildman arm -x nvidia,freescale,.*ball$ @@ -970,10 +970,12 @@ a set of (tag, value) pairs.
      settings file. They can also be useful when building U-Boot against other
      open source software.
- [make-flags]
-    at91-boards=ENABLE_AT91_TEST=1
-    snapper9260=${at91-boards} BUILD_TAG=442
-    snapper9g45=${at91-boards} BUILD_TAG=443
+    ::

Thank you for addressing the documentation issues.

In the documentation we tend to prefer syntax-highlighting.

.. code-block:: ini

+
+        [make-flags]
+        at91-boards=ENABLE_AT91_TEST=1
+        snapper9260=${at91-boards} BUILD_TAG=442
+        snapper9g45=${at91-boards} BUILD_TAG=443
This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
      and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
@@ -986,7 +988,7 @@ a set of (tag, value) pairs.
      config.mk file and documented in the README.
Note that you can pass ad-hoc options to the build using environment
-    variables, for example:
+    variables, for example::

.. code-block:: bash

Best regards

Heinrich

SOME_OPTION=1234 ./tools/buildman/buildman my_board @@ -1357,7 +1359,7 @@ directory.
  Build summary
  -------------
-When Buildman finishes, it displays a summary, similar to the following:
+When Buildman finishes, it displays a summary, similar to the following::
Completed: 5 total built, duration 0:00:21, rate 0.24
---
base-commit: c0ca147ac6228949a6d6497531c9f2f4a0dc6c67
change-id: 20260306-doc-buildman-fix-example-format-6f6cd937ee9b

Best regards,

Reply via email to