Proposal: Add BSP documentation to BSP build specification

[Gedare Bloom]

On Wed, Nov 11, 2020 at 9:36 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> On 11/11/2020 17:32, Gedare Bloom wrote:
>
> > Hi Sebastian,
> >
> > What is the advantage of doing this?
> >
> > I don't immediately see the rationale.
>
> The advantage is that as soon as you add/remove a BSP family or variant
> to/from the build you can generate an up to date user manual.
>
> Having documentation of the BSP in the build specification helps to
> concentrate things which belong together in one spot. In a next step we
> should think about adding the BSP option documentation to the user manual.
>
OK, consolidation is a reasonable argument, and the possibility to
'script' some doc generation from the build spec is intriguing.  It
continues to raise the bar on documentation patches, but I'm fine with
it.

> --
> embedded brains GmbH
> Sebastian HUBER
> Dornierstr. 4
> 82178 Puchheim
> Germany
> email: sebastian.huber at embedded-brains.de
> Phone: +49-89-18 94 741 - 16
> Fax:   +49-89-18 94 741 - 08
> PGP: Public key available on request.
>
> embedded brains GmbH
> Registergericht: Amtsgericht München
> Registernummer: HRB 157899
> Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
> Unsere Datenschutzerklärung finden Sie hier: https://embedded-brains.de/datenschutzerklaerung/
>