On Thu, Mar 14, 2019 at 9:39 AM Gedare Bloom <ged...@rtems.org> wrote:
> > > On Thu, Mar 14, 2019 at 8:53 AM Sebastian Huber < > sebastian.hu...@embedded-brains.de> wrote: > >> Hello, >> >> I am about to update the Doxygen Recommendations in the RTEMS Software >> Engineering handbook. Currently, there is a lot of other content mixed >> in such as "BSP Basics". We should really try to avoid all the >> duplication across the documentation set which is simply not >> maintainable. What is the right spot for information relevant to a BSP >> writer/maintainer (source tree layout, expected driver, documentation, >> etc.)? Should this be >> >> * a section in the RTEMS Software Engineering handbook, or >> >> * a section in the RTEMS BSP and Driver Guide? >> >> Should the RTEMS BSP and Driver Guide be merged into the RTEMS Software >> Engineering handbook? >> >> > I don't think they entirely fit together. The SwE book is about processes > and policies for RTEMS (along the path toward pre-qualification). The > BSP/Driver guide includes some suggestions along those lines, but is mostly > about implementation details and how to use certain driver/BSP frameworks > we have in place. I think that maybe there should be a short > section/chapter in the SwE that might provide the specific expectations > (requirements, BSP-specific processes to follow, etc.) we have about BSPs, > with the pointer to the BSP guide for implementers to follow. > > My two cents. > > P.S. I'd just merge the '4.3.4 Doxygen Recommendations for BSPs' into the BSP manual. It will need some editing too. (It was copied from the wiki instructions intended for GCI students.) > Gedare > > -- >> Sebastian Huber, embedded brains GmbH >> >> Address : Dornierstr. 4, D-82178 Puchheim, Germany >> Phone : +49 89 189 47 41-16 >> Fax : +49 89 189 47 41-09 >> E-Mail : sebastian.hu...@embedded-brains.de >> PGP : Public key available on request. >> >> Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG. >> >> _______________________________________________ >> devel mailing list >> devel@rtems.org >> http://lists.rtems.org/mailman/listinfo/devel > >
_______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
