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

[Tom Rini]

On Fri, Feb 16, 2024 at 10:10:19AM +0000, Paul Barker wrote:
> 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>`.

The issue is that SDL2 is required by default, so I'll try and reword
this a bit more still, thanks.

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20240216/ac810645/attachment.sig>