doc: Fix obvious typos and minor improvements
PATCH v2 1/10 doc: Fix obvious typos and minor improvements
These are fixes to what looks like obvious typos. Some minor improvments are also included, such as:
- Write "symbolic link" instead of symlink
- Correct capitalization for LLVM (all caps)
- Remove dead link and surrounding sentence
--- doc/build/clang.rst | 8 +++--- doc/build/gen_compile_commands.rst | 2 +- doc/build/tools.rst | 9 +++---- tools/buildman/buildman.rst | 41 +++++++++++++++--------------- 4 files changed, 29 insertions(+), 31 deletions(-)
doc/build/clang.rst +4 -4
@@ -46,9 +46,9 @@ It can also be used to compile sandbox: FreeBSD 11 ---------- -Since llvm 3.4 is currently in the base system, the integrated assembler as -is incapable of building U-Boot. Therefore gas from devel/arm-gnueabi-binutils -is used instead. It needs a symlink to be picked up correctly though: +Since LLVM 3.4 is currently in the base system, the integrated assembler is +incapable of building U-Boot. Therefore gas from devel/arm-gnueabi-binutils is +used instead. It needs a symbolic link to be picked up correctly though: .. code-block:: bash
@@ -64,7 +64,7 @@ The following commands compile U-Boot using the Clang xdev toolchain. gmake rpi_2_defconfig gmake CC="clang -target arm-freebsd-eabi --sysroot /usr/arm-freebsd" -j8 -Given that U-Boot will default to gcc, above commands can be +Given that U-Boot will default to gcc, the commands above can be simplified with a simple wrapper script - saved as /usr/local/bin/arm-gnueabi-freebsd-gcc - listed below:
doc/build/gen_compile_commands.rst +1 -1
@@ -39,7 +39,7 @@ course) to have an up-to-date database. The database will be in the root of the repository. No further modifications are needed for it to be usable by the LSP, unless you set a name for the database -other than it's default one (compile_commands.json). +other than the default one (compile_commands.json). Compatible IDEs ---------------
doc/build/tools.rst +4 -5
@@ -8,7 +8,7 @@ Building tools for Linux ------------------------ To allow distributions to distribute all possible tools in a generic way, -avoiding the need of specific tools building for each machine, a tools only +avoiding the need of specific building tools for each machine, a tools-only defconfig file is provided. Using this, we can build the tools by doing::
@@ -30,9 +30,8 @@ installed all required packages below in order to build these host tools:: * diffutils (3.7) * openssl-devel (1.1.1.d) -Note the version numbers in these parentheses above are the package versions -at the time being when writing this document. The MSYS2 installer tested is -http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.exe. +Note that the version numbers in parentheses above are the package versions at +the time of writing this document. There are 3 MSYS subsystems installed: MSYS2, MinGW32 and MinGW64. Each subsystem provides an environment to build Windows applications. The MSYS2
@@ -50,7 +49,7 @@ Launch the MSYS2 shell of the MSYS2 environment, and do the following:: Building without Python ----------------------- -The tools-only builds bytes pylibfdt by default. To disable this, use the +The tools-only builds pylibfdt by default. To disable this, use the NO_PYTHON variable:: NO_PYTHON=1 make tools-only_defconfig tools-only
tools/buildman/buildman.rst +20 -21
125 lines not on this page · raw message
Signature · 1 line
2.48.1
PATCH v2 2/10 doc: Quote all long form options using double backticks/grave accents
Otherwise, the two dashes are rendered as just one.
--- tools/buildman/buildman.rst | 50 ++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 25 deletions(-)
tools/buildman/buildman.rst +25 -25
@@ -100,8 +100,8 @@ threads do not affect the state of your git repository. Any checkouts done by the thread affect only the working directory for that thread. Buildman automatically selects the correct tool chain for each board. You -must supply suitable tool chains (see --fetch-arch), but buildman takes care -of selecting the right one. +must supply suitable tool chains (see ``--fetch-arch``), but buildman takes +care of selecting the right one. Buildman generally builds a branch (with the -b flag), and in this case builds the upstream commit as well, for comparison. So even if you have one
@@ -153,9 +153,9 @@ You can also use -x to specifically exclude some boards. For example: means to build all arm boards except nvidia, freescale and anything ending with 'ball'. -For building specific boards you can use the --boards (or --bo) option, which -takes a comma-separated list of board target names and can be used multiple times -on the command line: +For building specific boards you can use the ``--boards`` (or ``--bo``) option, +which takes a comma-separated list of board target names and can be used +multiple times on the command line: .. code-block:: bash
@@ -492,7 +492,7 @@ branch with a valid upstream): ./tools/buildman/buildman -b <branch> -n If it can't detect the upstream branch, try checking out the branch, and -doing something like 'git branch --set-upstream-to upstream/master' +doing something like ``git branch --set-upstream-to upstream/master`` or something similar. Buildman will try to guess a suitable upstream branch if it can't find one (you will see a message like "Guessing upstream as ..."). You can also use the -c option to manually specify the number of commits to
@@ -731,17 +731,17 @@ Note that the 'text' region and 'rodata' are split out. You should add the two together to get the total read-only size (reported as the first column in the output from binutil's 'size' utility). -A useful option is --step which lets you skip some commits. For example ---step 2 will show the image sizes for only every 2nd commit (so it will +A useful option is ``--step`` which lets you skip some commits. For example +``--step 2`` will show the image sizes for only every 2nd commit (so it will compare the image sizes of the 1st, 3rd, 5th... commits). You can also use ---step 0 which will compare only the first and last commits. This is useful +``--step 0`` which will compare only the first and last commits. This is useful for an overview of how your entire series affects code size. It will build only the upstream commit and your final branch commit. You can also use -d to see a detailed size breakdown for each board. This list is sorted in order from largest growth to largest reduction. -It is even possible to go a little further with the -B option (--bloat). This +It is even possible to go a little further with the -B option (``--bloat``). This shows where U-Boot has bloated, breaking the size change down to the function level. Example output is below::
@@ -924,7 +924,7 @@ a set of (tag, value) pairs. This lists the available toolchains. The tag here doesn't matter, but make sure it is unique. The value is the path to the toolchain. Buildman will look in that path for a file ending in 'gcc'. It will then execute - it to check that it is a C compiler, passing only the --version flag to + it to check that it is a C compiler, passing only the ``--version`` flag to it. If the return code is 0, buildman assumes that it is a valid C compiler. It uses the first part of the name as the architecture and strips off the last part when setting the CROSS_COMPILE environment
@@ -1005,7 +1005,7 @@ By default, buildman doesn't execute 'make mrproper' prior to building the first commit for each board. This reduces the amount of work 'make' does, and hence speeds up the build. To force use of 'make mrproper', use -the -m flag. This flag will slow down any buildman invocation, since it increases the amount -of work done on any build. An alternative is to use the --fallback-mrproper +of work done on any build. An alternative is to use the ``--fallback-mrproper`` flag, which retries the build with 'make mrproper' only after a build failure. One possible application of buildman is as part of a continual edit, build,
@@ -1040,7 +1040,7 @@ of the source tree, thus allowing rapid tested evolution of the code:: ./tools/buildman/buildman -Pr tegra -Note also the `--dtc-skip` option which uses the system device-tree compiler to +Note also the ``--dtc-skip`` option which uses the system device-tree compiler to avoid needing to build it for each board. This can save 10-20% of build time. An alternative is to set DTC=/path/to/dtc when running buildman.
@@ -1076,7 +1076,7 @@ same as 'am335x_evm_usbspl'. The -K option uses the u-boot.cfg, spl/u-boot-spl.cfg and tpl/u-boot-tpl.cfg files which are produced by a build. If all you want is to check the -configuration you can in fact avoid doing a full build, using --config-only. +configuration you can in fact avoid doing a full build, using ``--config-only``. This tells buildman to configure U-Boot and create the .cfg files, but not actually build the source. This is 5-10 times faster than doing a full build.
@@ -1090,7 +1090,7 @@ equivalent:: The former would appear in a header filer and the latter in a defconfig file. To achieve this, buildman considers 'y' to be '1' in configuration variables. This avoids lots of useless output when converting a CONFIG -option to Kconfig. To disable this behaviour, use --squash-config-y. +option to Kconfig. To disable this behaviour, use ``--squash-config-y``. Checking the environment
@@ -1165,7 +1165,7 @@ Link-time optimisation (LTO) is designed to reduce code size by globally optimising the U-Boot build. Unfortunately this can dramatically slow down builds. This is particularly noticeable when running a lot of builds. -Use the -L (--no-lto) flag to disable LTO. +Use the -L (``--no-lto``) flag to disable LTO. .. code-block:: bash
@@ -1195,7 +1195,7 @@ each error line. Also, buildman prints information about what it is about to do, along with a summary at the end. When using buildman from an IDE, it is helpful to drop this behaviour. Use the --I/--ide option for that. You might find -W helpful also so that warnings do +``-I/--ide`` option for that. You might also find -W helpful so that warnings do not cause the build to fail: .. code-block:: bash
@@ -1287,7 +1287,7 @@ rebuild. You can use -f to work around that. Other options ------------- -Buildman has various other command-line options. Try --help to see them. +Buildman has various other command-line options. Try ``--help`` to see them. To find out what toolchain prefix buildman will use for a build, use the -A option.
@@ -1325,11 +1325,11 @@ figure out the root cause of the build failure. For situations where buildman is invoked from multiple running processes, it is sometimes useful to have buildman wait until the others have finished. Use the ---process-limit option for this: --process-limit 1 will allow only one buildman -to process jobs at a time. +``--process-limit`` option for this: ``--process-limit 1`` will allow only one +buildman to process jobs at a time. To build a particular target, rather than the default U-Boot target, use the -`--target` option. This is unlikely to be useful unless you are building a +``--target`` option. This is unlikely to be useful unless you are building a single board. Buildman normally builds out-of-tree, meaning that the source directory is not
@@ -1358,7 +1358,7 @@ Using boards.cfg This file is no-longer needed by buildman but it is still generated in the working directory. This helps avoid a delay on every build, since scanning all -the Kconfig files takes a few seconds. Use the `-R <filename>` flag to force +the Kconfig files takes a few seconds. Use the ``-R <filename>`` flag to force regeneration of the file - in that case buildman exits after writing the file with exit code 2 if there was an error in the maintainer files. To use the default filename, use a hyphen, i.e. `-R -`.
@@ -1371,7 +1371,7 @@ Checking maintainers -------------------- Sometimes a board is added without a corresponding entry in a MAINTAINERS file. -Use the `--maintainer-check` option to check this:: +Use the ``--maintainer-check`` option to check this:: $ buildman --maintainer-check WARNING: board/mikrotik/crs3xx-98dx3236/MAINTAINERS: missing defconfig ending at line 7
@@ -1379,8 +1379,8 @@ Use the `--maintainer-check` option to check this:: Buildman returns with an exit code of 2 if there are any warnings. -An experimental `--full-check option` also checks for boards which don't have a -CONFIG_TARGET_xxx where xxx corresponds to their defconfig filename. This is +An experimental ``--full-check option`` also checks for boards which don't have +a CONFIG_TARGET_xxx where xxx corresponds to their defconfig filename. This is not strictly necessary, but may be useful information.
Signature · 1 line
2.48.1
PATCH v2 3/10 doc: Use "supports" instead of "has"
In reply to Adriano CarvalhoStrictly speaking, "has" doesn't make sense.
"supports" seems like a better word and it probably was what the original author meant.
--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/buildman/buildman.rst +1 -1
@@ -476,7 +476,7 @@ Setting up Buildman should now be set up to use your new toolchain. - At the time of writing, U-Boot has these architectures: + At the time of writing, U-Boot supports these architectures: arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa
Signature · 1 line
2.48.1
PATCH v2 4/10 doc: Add riscv and unfold the list with the architecture/code name
In reply to Adriano Carvalhoriscv was missing from the list.
To some, the architecture's name may not be obvious from the code name.
--- tools/buildman/buildman.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-)
tools/buildman/buildman.rst +14 -1
@@ -478,7 +478,20 @@ Setting up At the time of writing, U-Boot supports these architectures: - arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa + - ARC (arc) + - ARM (arm) + - Motorola 68k (m68k) + - MicroBlaze (microblaze) + - MIPS (mips) + - Nios II (nios2) + - PowerPC (powerpc) + - RISC-V (riscv) + - Sandbox (sandbox) + - SuperH (sh) + - x86 (x86) + - Xtensa (xtensa) + + Each entry list the architecture's name, followed by its code name in U-Boot. How to run it
Signature · 1 line
2.48.1
PATCH v2 5/10 doc: Rephrase in a simpler way
In reply to Adriano CarvalhoIt reads a bit nicer.
--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/buildman/buildman.rst +1 -1
@@ -1188,7 +1188,7 @@ Use the -L (``--no-lto``) flag to disable LTO. Doing a simple build -------------------- -In some cases you just want to build a single board and get the full output, use +In case you want to build a single board and get the full output, use the -w option, for example: .. code-block:: bash
Signature · 1 line
2.48.1
PATCH v2 6/10 doc: Rephrase to be more clear
In reply to Adriano CarvalhoIt might not be clear what is meant with "to make sure the shell leaves it alone".
--- tools/buildman/buildman.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
tools/buildman/buildman.rst +3 -2
@@ -1273,8 +1273,9 @@ Some options have values, in which case you can change them: buildman -a 'BOOTCOMMAND="echo hello"' CONFIG_SYS_LOAD_ADDR=0x1000 -Note that you must put quotes around string options and the whole thing must be -in single quotes, to make sure the shell leave it alone. +Note that you must put quotes around string options and the whole argument must +be in single quotes to ensure that the shell recognizes it as a single +argument. If you try to set an option that does not exist, or that cannot be changed for some other reason (e.g. it is 'selected' by another option), then buildman
Signature · 1 line
2.48.1
PATCH v2 7/10 doc: Rephrase to read a bit nicer
In reply to Adriano CarvalhoReads better.
--- tools/buildman/buildman.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
tools/buildman/buildman.rst +3 -3
@@ -1294,8 +1294,8 @@ shows an error:: One major caveat with this feature with branches (-b) is that buildman does not name the output directories differently when you change the configuration, so -doing the same build again with different configuration will not trigger a -rebuild. You can use -f to work around that. +doing the same build with a different configuration will not trigger a rebuild. +You can use -f to work around that. Other options
@@ -1357,7 +1357,7 @@ directory. Build summary ------------- -When buildman finishes it shows a summary, something like this:: +When Buildman finishes, it displays a summary, similar to the following: Completed: 5 total built, duration 0:00:21, rate 0.24
Signature · 1 line
2.48.1
PATCH v2 8/10 doc: Rephrase to be more precise and less confusing (build)
In reply to Adriano CarvalhoIt was "... doing the same build ... will not trigger a rebuild".
--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/buildman/buildman.rst +1 -1
@@ -1294,7 +1294,7 @@ shows an error:: One major caveat with this feature with branches (-b) is that buildman does not name the output directories differently when you change the configuration, so -doing the same build with a different configuration will not trigger a rebuild. +re-launching Buildman with an updated configuration will not trigger a rebuild. You can use -f to work around that.
Signature · 1 line
2.48.1
PATCH v2 9/10 doc: Capitalize the word Buildman whenever it's used as a proper noun
In reply to Adriano CarvalhoThis consistency reads a bit nicer.
--- doc/build/reproducible.rst | 2 +- tools/buildman/buildman.rst | 108 ++++++++++++++++++------------------ 2 files changed, 55 insertions(+), 55 deletions(-)
doc/build/reproducible.rst +1 -1
@@ -24,4 +24,4 @@ This date is shown when we launch U-Boot: ./u-boot -T U-Boot 2023.01 (Jan 01 2023 - 00:00:00 +0000) -The same effect can be obtained with buildman using the `-r` flag. +The same effect can be obtained with Buildman using the `-r` flag.
tools/buildman/buildman.rst +54 -54
339 lines not on this page · raw message
Signature · 1 line
2.48.1
PATCH v2 10/10 doc: Use a em-dash instead
In reply to Adriano CarvalhoIn the browser, a single dash looks sloppy.
--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/buildman/buildman.rst +1 -1
@@ -1373,7 +1373,7 @@ Using boards.cfg This file is no-longer needed by Buildman but it is still generated in the working directory. This helps avoid a delay on every build, since scanning all the Kconfig files takes a few seconds. Use the ``-R <filename>`` flag to force -regeneration of the file - in that case Buildman exits after writing the file +regeneration of the file — in that case Buildman exits after writing the file with exit code 2 if there was an error in the maintainer files. To use the default filename, use a hyphen, i.e. `-R -`.
Signature · 1 line
2.48.1
Re: [PATCH v2 10/10] doc: Use a em-dash instead
Quoted 12 lines · Adriano Carvalho
In the browser, a single dash looks sloppy.
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)tools/buildman/buildman.rst +0
-0
tools/buildman/buildman.rst Using boards.cfg · line 1379
Quoted 8 lines
tools/buildman/buildman.rst +1
-1@@ -1373,7 +1373,7 @@ Using boards.cfg This file is no-longer needed by Buildman but it is still generated in the working directory. This helps avoid a delay on every build, since scanning all the Kconfig files takes a few seconds. Use the ``-R <filename>`` flag to force -regeneration of the file - in that case Buildman exits after writing the file +regeneration of the file — in that case Buildman exits after writing the file with exit code 2 if there was an error in the maintainer files. To use the default filename, use a hyphen, i.e. `-R -`.
This file is also used as output of buildman -H on the command line. Unicode does not work if the console is using an 8-bit codepage.
With the patch an error in the CI occurs:
testtools.testresult.real._StringException: AssertionError: 67348 != 67350
For details see:
https://source.denx.de/u-boot/custodians/u-boot-efi/-/jobs/1234573
Dropping the patch.
Best regards
Heinrich
Re: [PATCH v2 10/10] doc: Use a em-dash instead
Quoted 7 lines · Heinrich Schuchardt
[...]
This file is also used as output of buildman -H on the command line. Unicode does not work if the console is using an 8-bit codepage.With the patch an error in the CI occurs:
testtools.testresult.real._StringException: AssertionError: 67348 != 67350
Quoted 8 lines
For details see:
https://source.denx.de/u-boot/custodians/u-boot-efi/-/jobs/1234573Dropping the patch.
Best regards
Heinrich
Should I use "--" instead?
After using "--" or dropping this commit altogether I should resubmit the complete patch series (not only this commit,) right?
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
Re: [PATCH v2 10/10] doc: Use a em-dash instead
Am 31. August 2025 14:20:19 MESZ schrieb Adriano Carvalho <[email protected]>:
Quoted 17 lines · Heinrich Schuchardt
Quoted 7 lines
[...]
This file is also used as output of buildman -H on the command line. Unicode does not work if the console is using an 8-bit codepage.With the patch an error in the CI occurs:
testtools.testresult.real._StringException: AssertionError: 67348 != 67350Quoted 8 lines
For details see:
https://source.denx.de/u-boot/custodians/u-boot-efi/-/jobs/1234573Dropping the patch.
Best regards
Heinrich
Quoted 7 lines
Should I use "--" instead?
After using "--" or dropping this commit altogether I should resubmit the complete patch series (not only this commit,) right?
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
All the other patches are in yesterday's pull request. '--' would look odd in the buildman -H output.
Best regards
Heinrich