[PATCH 2/2] doc: Rework the gcc section to reflect general build instructions

[Paul Barker]

On 15/02/2024 21:10, Tom Rini wrote:
> The first big issue is that the "gcc" file talked a lot about the
> general build requirements as well, but was titled in a gcc-centric
> manner. Solve this by renaming the file to compile.rst and more fully
> reflecting that it is general build instructions. Next, add a section
> about the prebuilt toolchains that are recommended (as they are the ones
> we use in CI), and update a few places to reference these vendor-neutral
> tools.
> 
> Next, we can include the reproducible builds section directly in the
> compile instructions rather than as a small standalone file.
> 
> Finally, we update the sandbox document to reflect both the name change
> as well as what is specifically required to build sandbox.
> 
> Signed-off-by: Tom Rini <trini at konsulko.com>
> ---
> Cc: Heinrich Schuchardt <xypron.glpk at gmx.de>
> ---
>  doc/arch/sandbox/sandbox.rst       |  5 ++-
>  doc/build/{gcc.rst => compile.rst} | 64 ++++++++++++++++++++++++++----
>  doc/build/index.rst                |  3 +-
>  doc/build/reproducible.rst         | 27 -------------
>  4 files changed, 61 insertions(+), 38 deletions(-)
>  rename doc/build/{gcc.rst => compile.rst} (73%)
>  delete mode 100644 doc/build/reproducible.rst
> 
> diff --git a/doc/arch/sandbox/sandbox.rst b/doc/arch/sandbox/sandbox.rst
> index 5f8db126657f..f2ed5a25c115 100644
> --- a/doc/arch/sandbox/sandbox.rst
> +++ b/doc/arch/sandbox/sandbox.rst
> @@ -39,11 +39,12 @@ integers can only be built on 64-bit hosts.
>  
>  Note that standalone/API support is not available at present.
>  
> -
>  Prerequisites
>  -------------
>  
> -Install the dependencies noted in :doc:`../../build/gcc`.
> +In addition to the normal dependencies shows in the :doc:`general build
> +instructions <../../build/compile>` to enable display support SDL2 libraries
> +need to be available.

I find this a little unclear. Perhaps:

To enable display support, SDL2 libraries need to be available in
addition to the normal dependencies shown in the :doc:`general build
instructions <../../build/compile>`.

>  
>  
>  Basic Operation
> diff --git a/doc/build/gcc.rst b/doc/build/compile.rst
> similarity index 73%
> rename from doc/build/gcc.rst
> rename to doc/build/compile.rst
> index 3c6465772729..ef9c8545835a 100644
> --- a/doc/build/gcc.rst
> +++ b/doc/build/compile.rst
> @@ -1,11 +1,19 @@
> -Building with GCC
> -=================
> +Building U-Boot
> +===============
>  
>  Dependencies
>  ------------
>  
> -For building U-Boot you need a GCC compiler for your host platform. If you
> -are not building on the target platform you further need  a GCC cross compiler.
> +For building U-Boot you need the general build tools such as `make` and a C
> +compiler for your host platform. Next, if you are not building on the same
> +architecture as the target platform you further need a C cross compiler.
> +Furthermore, some target platforms require additional host tools to be present
> +and their package names may vary slightly dependinng on the naming scheme used

s/dependinng/depending/

Thanks,

-- 
Paul Barker
-------------- next part --------------
A non-text attachment was scrubbed...
Name: OpenPGP_0x27F4B3459F002257.asc
Type: application/pgp-keys
Size: 3520 bytes
Desc: OpenPGP public key
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20240216/47e96418/attachment.key>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: OpenPGP_signature.asc
Type: application/pgp-signature
Size: 236 bytes
Desc: OpenPGP digital signature
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20240216/47e96418/attachment.sig>