doc: minor fixes and improvements
cover doc: minor fixes and improvements
This patch series includes several minor fixes and what I think are improvements to the documentation.
I have recently started reading the documentation and plan to contribute to U-Boot proper in the future. For now, I’'ll focus on improving the docs.
Please let me know if I should approach this differently or if there are specific topics you’d like me to focus on.
Adriano Carvalho (10):
doc: Fix typo in doc/build/clang.rst
doc: Fix typos and improve wording in doc/build/tools.rst
doc: Fix typos and improve wording in tools/buildman/buildman.rst
doc: Quote all long form options using double ticks in
tools/buildman/buildman.rst
doc: Ensure consistency of "buildman" (in the middle of a sentence)
and "Buildman" (at the beggining of a sentence) in tools/buildman/buildman.rst
doc: Add riscv to the list of architectures in
tools/buildman/buildman.rst
doc: Fix typo in doc/build/documentation.rst
doc: Fix typo in doc/build/gen_compile_commands.rst
doc: Use a long dash instead in tools/buildman/buildman.rst
doc: Fix typo in tools/buildman/buildman.rst
doc/build/clang.rst | 8 +- doc/build/documentation.rst | 2 +- doc/build/gen_compile_commands.rst | 2 +- doc/build/tools.rst | 8 +- tools/buildman/buildman.rst | 116 ++++++++++++++--------------- 5 files changed, 68 insertions(+), 68 deletions(-)
Signature · 1 line
2.48.1
PATCH 1/10 doc: Fix typo in doc/build/clang.rst
--- doc/build/clang.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 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 symlink 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:
Signature · 1 line
2.48.1
Re: [PATCH 01/10] doc: Fix typo in doc/build/clang.rst
doc/build/clang.rst It can also be used to compile sandbox: · line 46
Quoted 11 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- doc/build/clang.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)doc/build/clang.rst +0
-0@@ -46,9 +46,9 @@ It can also be used to compile sandbox: FreeBSD 11
Thank you for reviewing the documentation.
FreeBSD 11 reached end of live 30 Nov 2017. The content of this section needs updating.
doc/build/clang.rst It can also be used to compile sandbox: · line 49
Quoted 6 lines
doc/build/clang.rst +1
-3---------- -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
The proper name is LLVM.
Does the issue occur with current FreeBSD?
doc/build/clang.rst It can also be used to compile sandbox: · line 51
Quoted 2 lines
doc/build/clang.rst +2
-0+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:
%s/symlink/symbolic link/
Best regards
Heinrich
Quoted 12 lines
doc/build/clang.rst +1
-1.. 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:
Re: [PATCH 01/10] doc: Fix typo in doc/build/clang.rst
(Resending because I forgot to reply to all. Sorry about that.)
Quoted 3 lines · Heinrich Schuchardt
[...]
FreeBSD 11 reached end of live 30 Nov 2017. The content of this section needs updating.
I'll check this but it seems right to leave it to a different patch. Do you agree?
Quoted 2 lines
[...]
The proper name is LLVM.
I'll include this in the next revision.
Quoted 3 lines
Does the issue occur with current FreeBSD?
[...]
I'll check this but, as above, if you agree, I'll leave it to a different patch.
Quoted 3 lines
%s/symlink/symbolic link/
I'll include this in the next revision.
Quoted 1 line
[...]
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
PATCH 2/10 doc: Fix typos and improve wording in doc/build/tools.rst
In reply to Adriano Carvalho--- doc/build/tools.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
doc/build/tools.rst +4 -4
@@ -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,8 +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 +Note that the version numbers in parentheses above are the package versions at +the time of writing this document. The MSYS2 installer tested is http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.exe. There are 3 MSYS subsystems installed: MSYS2, MinGW32 and MinGW64. Each
@@ -50,7 +50,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
Signature · 1 line
2.48.1
Re: [PATCH 02/10] doc: Fix typos and improve wording in doc/build/tools.rst
Quoted 19 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- doc/build/tools.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)doc/build/tools.rst +1
-1@@ -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::
doc/build/tools.rst installed all required packages below in order to build these host tools:: · line 35
Quoted 8 lines
doc/build/tools.rst +2
-2@@ -30,8 +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 +Note that the version numbers in parentheses above are the package versions at +the time of writing this document. The MSYS2 installer tested is http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.exe.
The URL is not valid anymore. Please, remove the sentence.
Best regards
Heinrich
Quoted 11 lines
doc/build/tools.rst +1
-1There are 3 MSYS subsystems installed: MSYS2, MinGW32 and MinGW64. Each@@ -50,7 +50,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
PATCH 3/10 doc: Fix typos and improve wording in tools/buildman/buildman.rst
In reply to Adriano Carvalho--- tools/buildman/buildman.rst | 49 ++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 25 deletions(-)
tools/buildman/buildman.rst +24 -25
@@ -22,10 +22,10 @@ example Raspberry Pi 2): What is this? ------------- -This tool handles building U-Boot to check that you have not broken it -with your patch series. It can build each individual commit and report -which boards fail on which commits, and which errors come up. It aims -to make full use of multi-processor machines. +This tool builds U-Boot to check that you have not broken it with your +patch series. It can build each individual commit and report which boards +fail on which commits, and which errors come up. It aims to make full use +of multi-processor machines. A key feature of buildman is its output summary, which allows warnings, errors or image size increases in a particular commit or board to be
@@ -83,7 +83,7 @@ incremental build (i.e. not using 'make xxx_defconfig' unless you use -C). Eventually the thread reaches the last commit and stops. If a commit causes an error or warning, buildman will try it again after reconfiguring (but see -Q). Thus some commits may be built twice, with the first result silently -discarded. Lots of errors and warnings will causes lots of reconfigures and your +discarded. Lots of errors and warnings will cause lots of reconfigures and your build will be very slow. This is because a file that produces just a warning would not normally be rebuilt in an incremental build. Once a thread finishes building all the commits for a board, it starts on the commits for another
@@ -154,7 +154,7 @@ 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 be used multiple times +takes a comma-separated list of board target names and can be used multiple times on the command line: .. code-block:: bash
@@ -212,7 +212,7 @@ Setting up The toolchain-alias section indicates that the i386 toolchain should be used to build x86 commits. - Note that you can also specific exactly toolchain prefixes if you like:: + Note that you can also specify toolchain prefixes if you like:: [toolchain-prefix] arm: /opt/arm-eabi-4.6/bin/arm-eabi-
@@ -243,9 +243,9 @@ Setting up This tells buildman to use a compiler wrapper in front of CROSS_COMPILE. In this example, ccache. It doesn't affect the toolchain scan. The wrapper is - added when CROSS_COMPILE environtal variable is set. The name in this - section is ignored. If more than one line is provided, only the last one - is taken. + added when the CROSS_COMPILE environment variable is set. The tag name in + this section is not important. If more than one line is provided, only the + last one is used. #. Make sure you have the required Python pre-requisites
@@ -484,7 +484,7 @@ Setting up How to run it ------------- -First do a dry run using the -n flag: (replace <branch> with a real, local +First do a dry run using the -n flag (replace <branch> with a real, local branch with a valid upstream): .. code-block:: bash
@@ -898,7 +898,7 @@ The .buildman settings file The .buildman file provides information about the available toolchains and also allows build flags to be passed to 'make'. It consists of several -sections, with the section name in square brackets. Within each section are +sections, with the section name in square brackets. Within each section there are a set of (tag, value) pairs. '[global]' section
@@ -939,8 +939,7 @@ a set of (tag, value) pairs. '[toolchain-prefix]' section This can be used to provide the full toolchain-prefix for one or more architectures. The full CROSS_COMPILE prefix must be provided. These - typically have a higher priority than matches in the '[toolchain]', due to - this prefix. + typically have a higher priority than matches in the '[toolchain]'. The tilde character ``~`` is supported in paths, to represent the home directory.
@@ -1062,7 +1061,7 @@ For example:: + u-boot.cfg: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_NET=1 + u-boot-spl.cfg: CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 + all: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 CONFIG_SPL_NET=1 - am335x_evm_usbspl : + am335x_evm_usbspl: + u-boot.cfg: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_NET=1 + u-boot-spl.cfg: CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 + all: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 CONFIG_SPL_NET=1
@@ -1073,15 +1072,15 @@ This shows that commit 44 enabled three new options for the board am335x_evm_usbspl which were not enabled in commit 43. There is also a summary for 'arm' showing all the changes detected for that architecture. In this case there is only one board with changes, so 'arm' output is the -same as 'am335x_evm_usbspl'/ +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. -This tells buildman to configuration U-Boot and create the .cfg files, but not +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. -By default buildman considers the follow two configuration methods +By default buildman considers the following two configuration methods equivalent:: #define CONFIG_SOME_OPTION
@@ -1089,7 +1088,7 @@ equivalent:: CONFIG_SOME_OPTION=y The former would appear in a header filer and the latter in a defconfig -file. The achieve this, buildman considers 'y' to be '1' in configuration +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.
@@ -1176,7 +1175,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 some cases you just want to build a single board and get the full output. Use the -w option, for example: .. code-block:: bash
@@ -1262,7 +1261,7 @@ 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. +in single quotes, to make sure the shell leaves it alone. 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
@@ -1281,8 +1280,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
@@ -1344,7 +1343,7 @@ directory. Build summary ------------- -When buildman finishes it shows a summary, something like this:: +When buildman finishes it shows a summary. Something like this:: Completed: 5 total built, duration 0:00:21, rate 0.24
@@ -1378,7 +1377,7 @@ Use the `--maintainer-check` option to check this:: WARNING: board/mikrotik/crs3xx-98dx3236/MAINTAINERS: missing defconfig ending at line 7 WARNING: no maintainers for 'clearfog_spi' -Buildman returns with an exit code of 2 if there area any warnings. +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
Signature · 1 line
2.48.1
Re: [PATCH 03/10] doc: Fix typos and improve wording in tools/buildman/buildman.rst
Quoted 130 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 49 ++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 25 deletions(-)tools/buildman/buildman.rst +18
-19@@ -22,10 +22,10 @@ example Raspberry Pi 2): What is this? ------------- -This tool handles building U-Boot to check that you have not broken it -with your patch series. It can build each individual commit and report -which boards fail on which commits, and which errors come up. It aims -to make full use of multi-processor machines. +This tool builds U-Boot to check that you have not broken it with your +patch series. It can build each individual commit and report which boards +fail on which commits, and which errors come up. It aims to make full use +of multi-processor machines. A key feature of buildman is its output summary, which allows warnings, errors or image size increases in a particular commit or board to be@@ -83,7 +83,7 @@ incremental build (i.e. not using 'make xxx_defconfig' unless you use -C). Eventually the thread reaches the last commit and stops. If a commit causes an error or warning, buildman will try it again after reconfiguring (but see -Q). Thus some commits may be built twice, with the first result silently -discarded. Lots of errors and warnings will causes lots of reconfigures and your +discarded. Lots of errors and warnings will cause lots of reconfigures and your build will be very slow. This is because a file that produces just a warning would not normally be rebuilt in an incremental build. Once a thread finishes building all the commits for a board, it starts on the commits for another@@ -154,7 +154,7 @@ 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 be used multiple times +takes a comma-separated list of board target names and can be used multiple times on the command line: .. code-block:: bash@@ -212,7 +212,7 @@ Setting up The toolchain-alias section indicates that the i386 toolchain should be used to build x86 commits. - Note that you can also specific exactly toolchain prefixes if you like:: + Note that you can also specify toolchain prefixes if you like:: [toolchain-prefix] arm: /opt/arm-eabi-4.6/bin/arm-eabi-@@ -243,9 +243,9 @@ Setting up This tells buildman to use a compiler wrapper in front of CROSS_COMPILE. In this example, ccache. It doesn't affect the toolchain scan. The wrapper is - added when CROSS_COMPILE environtal variable is set. The name in this - section is ignored. If more than one line is provided, only the last one - is taken. + added when the CROSS_COMPILE environment variable is set. The tag name in + this section is not important. If more than one line is provided, only the + last one is used. #. Make sure you have the required Python pre-requisites@@ -484,7 +484,7 @@ Setting up How to run it ------------- -First do a dry run using the -n flag: (replace <branch> with a real, local +First do a dry run using the -n flag (replace <branch> with a real, local branch with a valid upstream): .. code-block:: bash@@ -898,7 +898,7 @@ The .buildman settings file The .buildman file provides information about the available toolchains and also allows build flags to be passed to 'make'. It consists of several -sections, with the section name in square brackets. Within each section are +sections, with the section name in square brackets. Within each section there are a set of (tag, value) pairs. '[global]' section@@ -939,8 +939,7 @@ a set of (tag, value) pairs. '[toolchain-prefix]' section This can be used to provide the full toolchain-prefix for one or more architectures. The full CROSS_COMPILE prefix must be provided. These - typically have a higher priority than matches in the '[toolchain]', due to - this prefix. + typically have a higher priority than matches in the '[toolchain]'. The tilde character ``~`` is supported in paths, to represent the home directory.@@ -1062,7 +1061,7 @@ For example:: + u-boot.cfg: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_NET=1 + u-boot-spl.cfg: CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 + all: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 CONFIG_SPL_NET=1 - am335x_evm_usbspl : + am335x_evm_usbspl: + u-boot.cfg: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_NET=1 + u-boot-spl.cfg: CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 + all: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_MMC=1 CONFIG_SPL_NAND_SUPPORT=1 CONFIG_SPL_NET=1@@ -1073,15 +1072,15 @@ This shows that commit 44 enabled three new options for the board am335x_evm_usbspl which were not enabled in commit 43. There is also a summary for 'arm' showing all the changes detected for that architecture. In this case there is only one board with changes, so 'arm' output is the -same as 'am335x_evm_usbspl'/ +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. -This tells buildman to configuration U-Boot and create the .cfg files, but not +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. -By default buildman considers the follow two configuration methods +By default buildman considers the following two configuration methods equivalent:: #define CONFIG_SOME_OPTION@@ -1089,7 +1088,7 @@ equivalent:: CONFIG_SOME_OPTION=y The former would appear in a header filer and the latter in a defconfig -file. The achieve this, buildman considers 'y' to be '1' in configuration +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.
tools/buildman/buildman.rst Use the -L (--no-lto) flag to disable LTO. · line 1179
Quoted 6 lines
tools/buildman/buildman.rst +1
-1@@ -1176,7 +1175,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 some cases you just want to build a single board and get the full output. Use the -w option, for example:
Keep it simple:
In case you want to build as single board and get the full output, use the -w option, for example:
tools/buildman/buildman.rst Some options have values, in which case you can change them: · line 1263
Quoted 6 lines
tools/buildman/buildman.rst +0
-0.. code-block:: bash@@ -1262,7 +1261,7 @@ 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
%s/thing/argument/
tools/buildman/buildman.rst Some options have values, in which case you can change them: · line 1264
Quoted 2 lines
tools/buildman/buildman.rst +1
-1-in single quotes, to make sure the shell leave it alone. +in single quotes, to make sure the shell leaves it alone.
%s/, to make sure the shell leaves it alone./to ensure that the shell recognizes it as a single argument./
tools/buildman/buildman.rst shows an error:: · line 1284
Quoted 11 lines
tools/buildman/buildman.rst +2
-2If 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@@ -1281,8 +1280,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.
"Doing a build does not trigger a rebuild." - This sentence is not comprehensible.
Do you mean
"Re-launching buildman with an updated configuration will not trigger a rebuild."
tools/buildman/buildman.rst directory. · line 1346
Quoted 9 lines
tools/buildman/buildman.rst +1
-1Other options@@ -1344,7 +1343,7 @@ directory. Build summary ------------- -When buildman finishes it shows a summary, something like this:: +When buildman finishes it shows a summary. Something like this::
When Buildman finishes, it displays a summary, similar to the following::
tools/buildman/buildman.rst Use the `--maintainer-check` option to check this:: · line 1382
Quoted 11 lines
tools/buildman/buildman.rst +1
-1Completed: 5 total built, duration 0:00:21, rate 0.24@@ -1378,7 +1377,7 @@ Use the `--maintainer-check` option to check this:: WARNING: board/mikrotik/crs3xx-98dx3236/MAINTAINERS: missing defconfig ending at line 7 WARNING: no maintainers for 'clearfog_spi' -Buildman returns with an exit code of 2 if there area any warnings. +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
These should be double backticks.
Best regards
Heinrich
Quoted 1 line
tools/buildman/buildman.rst +0
-0CONFIG_TARGET_xxx where xxx corresponds to their defconfig filename. This is
PATCH 4/10 doc: Quote all long form options using double ticks in tools/buildman/buildman.rst
In reply to Adriano CarvalhoOtherwise, 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 @@ 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
Re: [PATCH 04/10] doc: Quote all long form options using double ticks in tools/buildman/buildman.rst
The Unicode character commonly referred to as a "tick" or "check mark" is U+2713 (✓).
Unicode calls the character U+0060 grave accent. Sphinx documentation refers to it as backtick.
Otherwise the change looks ok.
Best regards
Heinrich
Quoted 182 lines · Adriano Carvalho
Otherwise, the two dashes are rendered as just one.
Signed-off-by Adriano Carvalho <[email protected]>--- 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 @@ 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.
PATCH 5/10 doc: Ensure consistency of "buildman" (in the middle of a sentence) and "Buildman" (at the beggining of a sentence) in tools/buildman/buildman.rst
In reply to Adriano CarvalhoThis pattern was prevalent (although not intirely) in the existing text.
--- tools/buildman/buildman.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
tools/buildman/buildman.rst +6 -6
@@ -119,7 +119,7 @@ them later using -se. Note that buildman will assume that the source has changed, and will build all specified boards in this case. Buildman is optimised for building many commits at once, for many boards. -On multi-core machines, Buildman is fast because it uses most of the +On multi-core machines, buildman is fast because it uses most of the available CPU power. When it gets to the end, or if you are building just a few commits or boards, it will be pretty slow. As a tip, if you don't plan to use your machine for anything else, you can use -T to increase the
@@ -1021,7 +1021,7 @@ cycle through various different configurations, one per board built by the thread. Variations in the configuration will force a rebuild of affected source files when a thread switches between boards. Ideally, such buildman-induced rebuilds would not happen, thus allowing the build to operate as efficiently as -the build system and source changes allow. buildman's -P flag may be used to +the build system and source changes allow. Buildman's -P flag may be used to enable this; -P causes each board to be built in a separate (board-specific) directory, thus avoiding any buildman-induced configuration changes in any build directory.
@@ -1130,10 +1130,10 @@ these when present in defconfig files and handle the resuiting Kconfig correctly. Thus it is possible to build a board which has a ``#include`` in the defconfig file. -For now, Buildman simply includes the files to produce a single output file, +For now, buildman simply includes the files to produce a single output file, using the C preprocessor. It does not call the ``merge_config.sh`` script. The redefined/redundant logic in that script could fairly easily be repeated in -Buildman, to detect potential problems. For now it is not clear that this is +buildman, to detect potential problems. For now it is not clear that this is useful. To specify the C preprocessor to use, set the ``CPP`` environment variable. The
@@ -1144,7 +1144,7 @@ like:: make qemu_riscv64_defconfig acpi.config -This is partly because there is no way for Buildman to know which fragments are +This is partly because there is no way for buildman to know which fragments are valid on which boards. Building with clang
@@ -1301,7 +1301,7 @@ with -E, e.g. the migration warnings:: ... ==================================================== -When doing builds, Buildman's return code will reflect the overall result:: +When doing builds, buildman's return code will reflect the overall result:: 0 (success) No errors or warnings found 100 Errors found
Signature · 1 line
2.48.1
Re: [PATCH 05/10] doc: Ensure consistency of "buildman" (in the middle of a sentence) and "Buildman" (at the beggining of a sentence) in tools/buildman/buildman.rst
Quoted 3 lines · Adriano Carvalho
This pattern was prevalent (although not intirely) in the existing text.
Signed-off-by Adriano Carvalho <[email protected]>
I agree that we should use the same capitalization everywhere. But isn't Buildman a proper noun?
Best regards
Heinrich
Quoted 57 lines
--- tools/buildman/buildman.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)tools/buildman/buildman.rst +6
-6@@ -119,7 +119,7 @@ them later using -se. Note that buildman will assume that the source has changed, and will build all specified boards in this case. Buildman is optimised for building many commits at once, for many boards. -On multi-core machines, Buildman is fast because it uses most of the +On multi-core machines, buildman is fast because it uses most of the available CPU power. When it gets to the end, or if you are building just a few commits or boards, it will be pretty slow. As a tip, if you don't plan to use your machine for anything else, you can use -T to increase the@@ -1021,7 +1021,7 @@ cycle through various different configurations, one per board built by the thread. Variations in the configuration will force a rebuild of affected source files when a thread switches between boards. Ideally, such buildman-induced rebuilds would not happen, thus allowing the build to operate as efficiently as -the build system and source changes allow. buildman's -P flag may be used to +the build system and source changes allow. Buildman's -P flag may be used to enable this; -P causes each board to be built in a separate (board-specific) directory, thus avoiding any buildman-induced configuration changes in any build directory.@@ -1130,10 +1130,10 @@ these when present in defconfig files and handle the resuiting Kconfig correctly. Thus it is possible to build a board which has a ``#include`` in the defconfig file. -For now, Buildman simply includes the files to produce a single output file, +For now, buildman simply includes the files to produce a single output file, using the C preprocessor. It does not call the ``merge_config.sh`` script. The redefined/redundant logic in that script could fairly easily be repeated in -Buildman, to detect potential problems. For now it is not clear that this is +buildman, to detect potential problems. For now it is not clear that this is useful. To specify the C preprocessor to use, set the ``CPP`` environment variable. The@@ -1144,7 +1144,7 @@ like:: make qemu_riscv64_defconfig acpi.config -This is partly because there is no way for Buildman to know which fragments are +This is partly because there is no way for buildman to know which fragments are valid on which boards. Building with clang@@ -1301,7 +1301,7 @@ with -E, e.g. the migration warnings:: ==================================================== -When doing builds, Buildman's return code will reflect the overall result:: +When doing builds, buildman's return code will reflect the overall result:: 0 (success) No errors or warnings found 100 Errors found
Re: [PATCH 05/10] doc: Ensure consistency of "buildman" (in the middle of a sentence) and "Buildman" (at the beggining of a sentence) in tools/buildman/buildman.rst
Quoted 2 lines · Heinrich Schuchardt
[...]
But isn't Buildman a proper noun?
I'll assume it is -- it looks like one -- and use "Buildman" instead of "buildman" whenever it is used as a proper noun.
Quoted 1 line
[...]
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
PATCH 6/10 doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
In reply to Adriano Carvalho--- tools/buildman/buildman.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
tools/buildman/buildman.rst +2 -1
@@ -478,7 +478,8 @@ Setting up At the time of writing, U-Boot has these architectures: - arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa + arc, arm, m68k, microblaze, mips, nios2, powerpc, riscv, sandbox, sh, x86, + xtensa How to run it
Signature · 1 line
2.48.1
Re: [PATCH 06/10] doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
Quoted 10 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)tools/buildman/buildman.rst +0
-0
tools/buildman/buildman.rst Setting up · line 482
Quoted 6 lines
tools/buildman/buildman.rst +2
-1@@ -478,7 +478,8 @@ Setting up At the time of writing, U-Boot has these architectures: - arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa + arc, arm, m68k, microblaze, mips, nios2, powerpc, riscv, sandbox, sh, x86, + xtensa
The output examples above this line should also be updated to show RISC-V.
Shouldn't we provide human readable names, e.g.
* RISC-V (riscv)
* SuperH (sh)
Best regards
Heinrich
Quoted 3 lines
tools/buildman/buildman.rst +0
-0How to run it
Re: [PATCH 06/10] doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
Quoted 13 lines · Heinrich Schuchardt
Quoted 11 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)tools/buildman/buildman.rst +0
-0@@ -478,7 +478,8 @@ Setting up
Quoted 7 lines
tools/buildman/buildman.rst Setting up · line 482
Quoted 5 lines
tools/buildman/buildman.rst +2
-1At the time of writing, U-Boot has these architectures: - arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa + arc, arm, m68k, microblaze, mips, nios2, powerpc, riscv, sandbox, sh, x86, + xtensaThe output examples above this line should also be updated to show RISC-V.
Do you mean what's under "Check the available toolchains"?
To reproduce, I would need to install quite a few toolchains. If anyone already has all those toolchains they could just send me the output. Do you know someone who can do that? Can you do that? Or should I just install all those toolchains and reproduce?
Quoted 4 lines
Shouldn't we provide human readable names, e.g.
* RISC-V (riscv)
* SuperH (sh)
That seems right. I'll include that in the next revision.
How do you call the "actual" name v. the "code" name? I am thinking of adding something like this after the list: Each item above includes the architecture's "actual" name and in parenthesis the architecture "code" name in U-Boot.
[...]
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
Re: [PATCH 06/10] doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
Quoted 23 lines · Adriano Carvalho
Quoted 13 lines · Heinrich Schuchardt
Quoted 11 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)tools/buildman/buildman.rst +0
-0@@ -478,7 +478,8 @@ Setting upQuoted 7 lines
tools/buildman/buildman.rst Setting up · line 482
Quoted 5 lines
tools/buildman/buildman.rst +2
-1At the time of writing, U-Boot has these architectures: - arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa + arc, arm, m68k, microblaze, mips, nios2, powerpc, riscv, sandbox, sh, x86, + xtensaThe output examples above this line should also be updated to show RISC-V.
Quoted 7 lines
Do you mean what's under "Check the available toolchains"?
To reproduce, I would need to install quite a few toolchains. If anyone already has all those toolchains they could just send me the output. Do you know someone who can do that? Can you do that? Or should I just install all those toolchains and reproduce? [...]
With docker.io/trini/u-boot-gitlab-ci-runner:jammy-20250714-25Jul2025, I got the following:
$ ./tools/buildman/buildman --list-tool-chains List of available toolchains (17): aarch64 : /opt/gcc-14.2.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc arc : /opt/gcc-14.2.0-nolibc/arc-linux/bin/arc-linux-gcc arm : /opt/gcc-14.2.0-nolibc/arm-linux-gnueabi/bin/arm-linux-gnueabi-gcc c89 : /usr/bin/c89-gcc c99 : /usr/bin/c99-gcc i386 : /opt/gcc-14.2.0-nolibc/i386-linux/bin/i386-linux-gcc m68k : /opt/gcc-14.2.0-nolibc/m68k-linux/bin/m68k-linux-gcc microblaze: /opt/gcc-14.2.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc mips : /opt/gcc-14.2.0-nolibc/mips-linux/bin/mips-linux-gcc nios2 : /opt/gcc-14.2.0-nolibc/nios2-linux/bin/nios2-linux-gcc powerpc : /opt/gcc-14.2.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc riscv32 : /opt/gcc-14.2.0-nolibc/riscv32-linux/bin/riscv32-linux-gcc riscv64 : /opt/gcc-14.2.0-nolibc/riscv64-linux/bin/riscv64-linux-gcc sandbox : /usr/bin/gcc sh2 : /opt/gcc-14.2.0-nolibc/sh2-linux/bin/sh2-linux-gcc x86_64 : /opt/gcc-14.2.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc xtensa : /opt/2020.07/xtensa-dc233c-elf/bin/xtensa-dc233c-elf-gcc
Compare to the original:
- a few architectures are missing (e.g., alpha, am33_2.0, bfin, frv, h8300)
- No "Scanning for tool chains" at the beginning
- No "Tool chain test"
Have the missing architectures been removed since? All those in the arch folder and some more are listed.
Has the output for Buildman changed to not include those lines?
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
Re: [PATCH 06/10] doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
Quoted 61 lines · Adriano Carvalho
Quoted 23 lines · Adriano Carvalho
Quoted 13 lines · Heinrich Schuchardt
Quoted 11 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)tools/buildman/buildman.rst +0
-0@@ -478,7 +478,8 @@ Setting upQuoted 7 lines
tools/buildman/buildman.rst Setting up · line 482
Quoted 5 lines
tools/buildman/buildman.rst +2
-1At the time of writing, U-Boot has these architectures: - arc, arm, m68k, microblaze, mips, nios2, powerpc, sandbox, sh, x86, xtensa + arc, arm, m68k, microblaze, mips, nios2, powerpc, riscv, sandbox, sh, x86, + xtensaThe output examples above this line should also be updated to show RISC-V.
Quoted 7 lines
Do you mean what's under "Check the available toolchains"?
To reproduce, I would need to install quite a few toolchains. If anyone already has all those toolchains they could just send me the output. Do you know someone who can do that? Can you do that? Or should I just install all those toolchains and reproduce? [...]
With docker.io/trini/u-boot-gitlab-ci-runner:jammy-20250714-25Jul2025, I got the following:
$ ./tools/buildman/buildman --list-tool-chains List of available toolchains (17): aarch64 : /opt/gcc-14.2.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc arc : /opt/gcc-14.2.0-nolibc/arc-linux/bin/arc-linux-gcc arm : /opt/gcc-14.2.0-nolibc/arm-linux-gnueabi/bin/arm-linux-gnueabi-gcc c89 : /usr/bin/c89-gcc c99 : /usr/bin/c99-gcc i386 : /opt/gcc-14.2.0-nolibc/i386-linux/bin/i386-linux-gcc m68k : /opt/gcc-14.2.0-nolibc/m68k-linux/bin/m68k-linux-gcc microblaze: /opt/gcc-14.2.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc mips : /opt/gcc-14.2.0-nolibc/mips-linux/bin/mips-linux-gcc nios2 : /opt/gcc-14.2.0-nolibc/nios2-linux/bin/nios2-linux-gcc powerpc : /opt/gcc-14.2.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc riscv32 : /opt/gcc-14.2.0-nolibc/riscv32-linux/bin/riscv32-linux-gcc riscv64 : /opt/gcc-14.2.0-nolibc/riscv64-linux/bin/riscv64-linux-gcc sandbox : /usr/bin/gcc sh2 : /opt/gcc-14.2.0-nolibc/sh2-linux/bin/sh2-linux-gcc x86_64 : /opt/gcc-14.2.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc xtensa : /opt/2020.07/xtensa-dc233c-elf/bin/xtensa-dc233c-elf-gccCompare to the original:
- a few architectures are missing (e.g., alpha, am33_2.0, bfin, frv, h8300)
- No "Scanning for tool chains" at the beginning
- No "Tool chain test"
Quoted 4 lines
Have the missing architectures been removed since? All those in the arch folder and some more are listed.
Has the output for Buildman changed to not include those lines?
There's a few things well out date at this point:
- The output from '--fetch-arch list' shows what can be downloaded from kernel.org. Keep in mind these are public toolchains, for the Linux kernel and are also fine for us. That's why it lists so many more.
- The section "Check the available toolchains" should be replaced with modern output, and you need to pass -v to get such verbose details now rather than simply a list of what would be used.
- The section "Install new toolchains if needed" should be replaced with output from using an architecture U-Boot still supports such as arm64 or riscv.
- The "toolchain-alias" parts don't list what aliases one needs and since 'riscv = riscv64' is needed, rephrasing that earlier part of the document should be done too.
Thanks for working on this area!
Signature · 1 line
Tom
Re: [PATCH 06/10] doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
Quoted 15 lines · Tom Rini
[...]
There's a few things well out date at this point:
- The output from '--fetch-arch list' shows what can be downloaded from kernel.org. Keep in mind these are public toolchains, for the Linux kernel and are also fine for us. That's why it lists so many more.
- The section "Check the available toolchains" should be replaced with modern output, and you need to pass -v to get such verbose details now rather than simply a list of what would be used.
- The section "Install new toolchains if needed" should be replaced with output from using an architecture U-Boot still supports such as arm64 or riscv.
- The "toolchain-alias" parts don't list what aliases one needs and since 'riscv = riscv64' is needed, rephrasing that earlier part of the document should be done too.
Quoted 4 lines
Thanks for working on this area!
--
Tom
I hope you don't mind that I'll leave that to a different patch series.
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
Re: [PATCH 06/10] doc: Add riscv to the list of architectures in tools/buildman/buildman.rst
Quoted 16 lines · Adriano Carvalho
Quoted 15 lines · Tom Rini
[...]
There's a few things well out date at this point:
- The output from '--fetch-arch list' shows what can be downloaded from kernel.org. Keep in mind these are public toolchains, for the Linux kernel and are also fine for us. That's why it lists so many more.
- The section "Check the available toolchains" should be replaced with modern output, and you need to pass -v to get such verbose details now rather than simply a list of what would be used.
- The section "Install new toolchains if needed" should be replaced with output from using an architecture U-Boot still supports such as arm64 or riscv.
- The "toolchain-alias" parts don't list what aliases one needs and since 'riscv = riscv64' is needed, rephrasing that earlier part of the document should be done too.
Quoted 6 lines
Quoted 4 lines
Thanks for working on this area!
--
TomI hope you don't mind that I'll leave that to a different patch series.
Yes, that's fine. I don't know if Heinrich would prefer to just take a small patch here like you started with, or defer until reworking the whole area to be correct again.
Signature · 1 line
Tom
PATCH 7/10 doc: Fix typo in doc/build/documentation.rst
In reply to Adriano Carvalho--- doc/build/documentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
doc/build/documentation.rst +1 -1
@@ -64,7 +64,7 @@ PDF documentation ----------------- The *pdfdocs* target is meant to be used to build PDF documenation. -As v2023.01 it fails with 'LaTeX Error: Too deeply nested'. +As of v2023.01 it fails with 'LaTeX Error: Too deeply nested'. We can use texi2pdf instead:
Signature · 1 line
2.48.1
Re: [PATCH 07/10] doc: Fix typo in doc/build/documentation.rst
Quoted 1 line · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>
Thanks for looking into all these typos.
In future, please, use scripts/get_maintainer.pl to identify the recipients of your patches.
doc/build/documentation.rst PDF documentation · line 66
Quoted 12 lines
--- doc/build/documentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)doc/build/documentation.rst +0
-0@@ -64,7 +64,7 @@ PDF documentation ----------------- The *pdfdocs* target is meant to be used to build PDF documenation.
Please, also fix the "documenation" typo.
doc/build/documentation.rst PDF documentation · line 67
Quoted 2 lines
doc/build/documentation.rst +1
-1-As v2023.01 it fails with 'LaTeX Error: Too deeply nested'. +As of v2023.01 it fails with 'LaTeX Error: Too deeply nested'.
Building target pdfdocs for origin/master on Ubuntu 25.10 fails with a different error:
Cannot determine size of graphic in boot_diagram_am62.svg
Please, improve the description: How about
"Multiple failures have been reported for this build target."
Maybe we should simply drop the build target.
Best regards
Heinrich
Quoted 3 lines
doc/build/documentation.rst +0
-0We can use texi2pdf instead:
Re: [PATCH 07/10] doc: Fix typo in doc/build/documentation.rst
Quoted 11 lines · Heinrich Schuchardt
[...]
Quoted 1 line
The *pdfdocs* target is meant to be used to build PDF documenation.
Please, also fix the "documenation" typo.
doc/build/documentation.rst PDF documentation · line 67
Quoted 2 lines
doc/build/documentation.rst +1
-1-As v2023.01 it fails with 'LaTeX Error: Too deeply nested'. +As of v2023.01 it fails with 'LaTeX Error: Too deeply nested'.Building target pdfdocs for origin/master on Ubuntu 25.10 fails with a different error:
Quoted 8 lines
Cannot determine size of graphic in boot_diagram_am62.svg
Please, improve the description: How about
"Multiple failures have been reported for this build target."
Maybe we should simply drop the build target.
[...]
I'll see what I can do to fix these failures. Unless you tell me it's not worth it.
When I say this what comes to my mind is: What distributions must/should be supported? If I provide a fix for Ubuntu, that doesn't mean it'll work in other distributions.
ATM, and for this patch series, it seems the best is:
-The *pdfdocs* target is meant to be used to build PDF documenation. -As of v2023.01 it fails with 'LaTeX Error: Too deeply nested'. +The *pdfdocs* target is meant to be used to build PDF documentation. +However, multiple failures have been reported for this build target.
(In the first sentence: documenation -> documentation.)
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
PATCH 8/10 doc: Fix typo in doc/build/gen_compile_commands.rst
In reply to Adriano Carvalho--- doc/build/gen_compile_commands.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
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 ---------------
Signature · 1 line
2.48.1
Re: [PATCH 08/10] doc: Fix typo in doc/build/gen_compile_commands.rst
Quoted 1 line · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>
Quoted 17 lines
--- doc/build/gen_compile_commands.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)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 ---------------
PATCH 9/10 doc: Use a long dash instead in tools/buildman/buildman.rst
In reply to Adriano Carvalho--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/buildman/buildman.rst +1 -1
@@ -1360,7 +1360,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 09/10] doc: Use a long dash instead in tools/buildman/buildman.rst
Quoted 10 lines · Adriano Carvalho
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 1363
Quoted 5 lines
tools/buildman/buildman.rst +1
-1@@ -1360,7 +1360,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
Please, use the Unicode character, that you want to display, e.g. U+2014 (em dash), or U+2013 (en dash). This way readers of the raw rst file will not be irritated and the rendering in HTML will not depend on the smartquotes_action setting.
But to be honest I don't see great value in this typography change.
Best regards
Heinrich
Quoted 3 lines
tools/buildman/buildman.rst +0
-0with exit code 2 if there was an error in the maintainer files. To use the default filename, use a hyphen, i.e. `-R -`.
Re: [PATCH 09/10] doc: Use a long dash instead in tools/buildman/buildman.rst
Quoted 23 lines · Heinrich Schuchardt
Quoted 10 lines · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)tools/buildman/buildman.rst +0
-0tools/buildman/buildman.rst Using boards.cfg · line 1363
Quoted 5 lines
tools/buildman/buildman.rst +1
-1@@ -1360,7 +1360,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 filePlease, use the Unicode character, that you want to display, e.g. U+2014 (em dash), or U+2013 (en dash). This way readers of the raw rst file will not be irritated and the rendering in HTML will not depend on the
smartquotes_actionsetting.
Quoted 10 lines
But to be honest I don't see great value in this typography change.
Best regards
Heinrich
Quoted 3 lines
tools/buildman/buildman.rst +0
-0with exit code 2 if there was an error in the maintainer files. To use the default filename, use a hyphen, i.e. `-R -`.
In the build directory (+ tools/buildman/buildman.rst), this style of writing is used only once (here). With a dash, it looks sloppy on the browser.
What about replacing the dash with a period?
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 -.
I understand this is probably worthless and I could just be wasting everyone's time. Please let me know if I should just ignore these very minor "typos".
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho
PATCH 10/10 doc: Fix typo in tools/buildman/buildman.rst
In reply to Adriano Carvalho--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/buildman/buildman.rst +1 -1
@@ -1364,7 +1364,7 @@ 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 -`. -You should use 'buildman -nv <criteria>' instead of greoing the boards.cfg file, +You should use 'buildman -nv <criteria>' instead of greping the boards.cfg file, since it may be dropped altogether in future.
Signature · 1 line
2.48.1
Re: [PATCH 10/10] doc: Fix typo in tools/buildman/buildman.rst
Quoted 1 line · Adriano Carvalho
Signed-off-by Adriano Carvalho <[email protected]>
Quoted 17 lines
--- tools/buildman/buildman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)tools/buildman/buildman.rst +1
-1@@ -1364,7 +1364,7 @@ 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 -`. -You should use 'buildman -nv <criteria>' instead of greoing the boards.cfg file, +You should use 'buildman -nv <criteria>' instead of greping the boards.cfg file, since it may be dropped altogether in future.
Quoted 5 lines · Adriano Carvalho
This patch series includes several minor fixes and what I think are improvements to the documentation.
I have recently started reading the documentation and plan to contribute to U-Boot proper in the future. For now, I’'ll focus on improving the docs.
Please let me know if I should approach this differently or if there are specific topics you’d like me to focus on.
Thank you for taking the time to review the project documentation. Helping hands are needed. Welcome to our developer community.
Fixing obvious misspells makes our documentation better readable. Thanks for that.
U-Boot provides scripts/get_maintainer.pl to find all people that should be CCed when sending patches.
We typically expect a commit message besides the title.
When reviewing I found some issues also in neighboring lines. Maybe you want to pick these up, too.
Best regards
Heinrich
Quoted 26 lines
Signed-off-by Adriano Carvalho <[email protected]>Adriano Carvalho (10):
doc: Fix typo indoc/build/clang.rst
doc: Fix typos and improve wording indoc/build/tools.rst
doc: Fix typos and improve wording intools/buildman/buildman.rst
doc: Quote all long form options using double ticks in
tools/buildman/buildman.rst
doc: Ensure consistency of "buildman" (in the middle of a sentence)
and "Buildman" (at the beggining of a sentence) intools/buildman/buildman.rst
doc: Add riscv to the list of architectures in
tools/buildman/buildman.rst
doc: Fix typo indoc/build/documentation.rst
doc: Fix typo indoc/build/gen_compile_commands.rst
doc: Use a long dash instead intools/buildman/buildman.rst
doc: Fix typo intools/buildman/buildman.rstdoc/build/clang.rst | 8 +- doc/build/documentation.rst | 2 +- doc/build/gen_compile_commands.rst | 2 +- doc/build/tools.rst | 8 +- tools/buildman/buildman.rst | 116 ++++++++++++++--------------- 5 files changed, 68 insertions(+), 68 deletions(-)
Quoted 1 line
[...]
Thank you for the heads-up.
Com os melhores cumprimentos. / Best regards.
Adriano Carvalho