<div dir="ltr"><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Mar 14, 2019 at 9:39 AM Gedare Bloom <<a href="mailto:gedare@rtems.org">gedare@rtems.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Mar 14, 2019 at 8:53 AM Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello,<br>
<br>
I am about to update the Doxygen Recommendations in the RTEMS Software <br>
Engineering handbook. Currently, there is a lot of other content mixed <br>
in such as "BSP Basics". We should really try to avoid all the <br>
duplication across the documentation set which is simply not <br>
maintainable. What is the right spot for information relevant to a BSP <br>
writer/maintainer (source tree layout, expected driver, documentation, <br>
etc.)? Should this be<br>
<br>
* a section in the RTEMS Software Engineering handbook, or<br>
<br>
* a section in the RTEMS BSP and Driver Guide?<br>
<br>
Should the RTEMS BSP and Driver Guide be merged into the RTEMS Software <br>
Engineering handbook?<br>
<br></blockquote><div><br></div><div>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.</div><div><br></div><div>My two cents.</div><div><br></div></div></div></blockquote><div><br></div><div>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.)</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div class="gmail_quote"><div></div><div>Gedare</div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
-- <br>
Sebastian Huber, embedded brains GmbH<br>
<br>
Address : Dornierstr. 4, D-82178 Puchheim, Germany<br>
Phone   : +49 89 189 47 41-16<br>
Fax     : +49 89 189 47 41-09<br>
E-Mail  : <a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a><br>
PGP     : Public key available on request.<br>
<br>
Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.<br>
<br>
_______________________________________________<br>
devel mailing list<br>
<a href="mailto:devel@rtems.org" target="_blank">devel@rtems.org</a><br>
<a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a></blockquote></div></div>
</blockquote></div></div></div>