[PATCH 2/4] doc: Migrate DesignPrinciples wiki page to sphinx

[Tom Rini]

On Sat, Jul 09, 2022 at 08:37:12AM +0200, Heinrich Schuchardt wrote:
> On 6/27/22 19:17, Tom Rini wrote:
> > Move the current DesignPrinciples wiki page to
> > doc/develop/designprinciples.rst.  The changes here are for formatting
> > or slight rewording so that it reads well when linking to other sphinx
> > documents.
> > 
> > Signed-off-by: Tom Rini <trini at konsulko.com>
> > ---
> >   doc/develop/designprinciples.rst | 197 +++++++++++++++++++++++++++++++
> >   doc/develop/index.rst            |   1 +
> >   2 files changed, 198 insertions(+)
> >   create mode 100644 doc/develop/designprinciples.rst
> > 
> > diff --git a/doc/develop/designprinciples.rst b/doc/develop/designprinciples.rst
> > new file mode 100644
> > index 000000000000..79694db77604
> > --- /dev/null
> > +++ b/doc/develop/designprinciples.rst
> > @@ -0,0 +1,197 @@
> > +.. SPDX-License-Identifier: GPL-2.0+:
> > +
> > +U-Boot Design Principles
> > +========================
> > +
> > +The 10 Golden Rules of U-Boot design
> > +------------------------------------
> > +
> > +Keep it Small
> > +^^^^^^^^^^^^^
> > +
> > +U-Boot is a Boot Loader, i.e. its primary purpose in the shipping
> > +system is to load some operating system.
> > +That means that U-Boot is
> > +necessary to perform a certain task, but it's nothing you want to
> > +throw any significant resources at. Typically U-Boot is stored in
> > +relatively small NOR flash memory, which is expensive
> > +compared to the much larger NAND devices often used to store the
> > +operating system and the application.
> > +
> > +At the moment, U-Boot supports boards with just 128 !KiB ROM or with
> > +256 !KiB NOR flash. We should not easily ignore such configurations -
> 
> %s/!KiB/KiB/g

I fixed that in a follow-up.

> Are these numbers still true? U-Boot typically is larger than 512 KiB.

More true than not still, yes.  And then very much so something to keep
in  mind for SPL.  It's more true that NOR isn't common than less than
512KiB isn't true.

[snip]
> > +Keep it Simple
> > +^^^^^^^^^^^^^^
> > +
> > +U-Boot is a boot loader, but it is also a tool used for board
> > +bring-up, for production testing, and for other activities
> 
> %/$/./
> 
> I cannot see how this sentence is related to the heading. The sentence
> is repeated below.

It's also verbatim what the original page says.  It's repetition for
emphasis.

-- 
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/20220709/6a9c54b7/attachment.sig>