[PATCH rtems-libbsd 0/5] RTEMS LibBSD Documentation

[Christian MAUDERER]

Am 02.08.21 um 10:38 schrieb Chris Johns:
> On 2/8/21 4:58 pm, Christian MAUDERER wrote:
>> Hello Husni,
>>
>> thanks for the patches. I'm sure that this will start a discussion about the
>> right place for that documentation. libbsd documentation is a long overdue topic
>> that has been neglected by all of us (including myself) so I think it's good to
>> start that discussion.
> 
> I suggest the user manual.
> 
> Chris
> 

Hello Chris,

thanks for the suggestion. So that would be a new libbsd chapter in the 
user manual and not some extra manual like the "Legacy Networking User 
Manual"?

Sooner or later most of the user facing documentation we already have in 
libbsd most likely would be moved there too. That would be mainly:

https://git.rtems.org/rtems-libbsd/tree/README.md
https://git.rtems.org/rtems-libbsd/tree/libbsd.txt

The CONTRIBUTING.md is more developer facing. Would we move that in the 
user manual too or would that be something that should move to either 
"BSP and Driver Guide" or the "Software Engineering" manual:

https://git.rtems.org/rtems-libbsd/tree/CONTRIBUTING.md

Note that I don't want to push that work to anyone. I asked Husni that 
he adds his work to a new manual at the moment so that we have a basis 
for discussion. The alternative would be to continue adding information 
like that to the text documents in libbsd. But the text files start to 
get convoluted and I think a better organized manual is long overdue. I 
thought that Husnis work would be a great chance to trigger finding the 
right place so that we can add or move more documentation to that place 
slowly. I'm sure that I should do quite some of that too because I have 
added a lot of stuff to libbsd over the time.

Best regards

Christian
-- 
--------------------------------------------
embedded brains GmbH
Herr Christian MAUDERER
Dornierstr. 4
82178 Puchheim
Germany
email: christian.mauderer at embedded-brains.de
phone: +49-89-18 94 741 - 18
fax:   +49-89-18 94 741 - 08

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/