AW: Description of rtems-libbsd testsuite applications

[Jan.Sommer at dlr.de]

Thanks for the suggestions.
I have to figure out what some of the tests do anyway and writing it down somewhere will also prevent future-me to do it again.
If I have some notes, is it ok to prepare a README.md inside the individual test's directory or do you prefer a single README inside the testsuite directory with a section per test?


> -----Ursprüngliche Nachricht-----
> Von: Sebastian Huber [mailto:sebastian.huber at embedded-brains.de]
> Gesendet: Freitag, 14. Februar 2020 09:59
> An: Sommer, Jan; RTEMS
> Betreff: Re: Description of rtems-libbsd testsuite applications
> 
> Hello Jan,
> 
> On 14/02/2020 09:46, Jan.Sommer at dlr.de wrote:
> > is there already somewhere a file which gives some short description what
> the different test applications in the testsuite directory (are supposed to) do?
> > If not, would you accept patches with some short descriptions and maybe an
> example output?
> 
> there is no such documentation available. Thanks for your offer to fix
> this. If you have time, it would be nice to use the rtems_test_begin()
> and rtems_test_end() functions to print the begin/end messages. Using
> the test state RTEMS_TEST_STATE_USER_INPUT for tests which need user
> input or a network should allow test runs by the RTEMS Tester.
> 
> With respect to the description, maybe the first step would be to add it
> to the top of the files?
> 
> Using the new test framework would be nice:
> 
> https://docs.rtems.org/branches/master/eng/test-framework.html#the-rtems-
> test-framework
> 
> However, this is a labor intensive and boring task.