<div dir="ltr">Hi,<div><br></div><div>I understand. I'll learn how to use Doxygen and put it in my codes. Thank you.</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Jul 9, 2020 at 12:43 PM Sebastian Huber <<a href="mailto:sebastian.huber@embedded-brains.de">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 Richi,<br>
<br>
we use Doxygen to document the software design. Maybe you can write your <br>
high-level description with it. This way it is integrated already <br>
integrated in the sources. You can use @dot for graphs and @msc for <br>
message sequences.<br>
<br>
I would document the data structures and the invariants of the data <br>
structures. I would also try to write code which checks that the <br>
invariants are satisfied. This can be used in _Assert() and RTEMS_DEBUG <br>
blocks.<br>
<br>
I would also write test cases. You can already run the test cases with:<br>
<br>
<a href="https://docs.rtems.org/branches/master/c-user/scheduling_concepts.html#arbitrary-processor-affinity-priority-smp-scheduler" rel="noreferrer" target="_blank">https://docs.rtems.org/branches/master/c-user/scheduling_concepts.html#arbitrary-processor-affinity-priority-smp-scheduler</a><br>
<br>
There should be test cases which would fail with the Linux push and pull <br>
scheduler.<br>
<br>
You should identify the key scheduler operations (e.g. block and <br>
unblock) and write a high level description of the algorithms used for <br>
these operations in some sort of pseudo code.<br>
<br>
-- <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>
</blockquote></div>