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

Christian MAUDERER christian.mauderer at embedded-brains.de
Tue Aug 3 07:00:27 UTC 2021


Hello,

Am 03.08.21 um 04:07 schrieb Chris Johns:
> On 3/8/21 3:24 am, Sebastian Huber wrote:
>> On 02/08/2021 18:37, Vijay Kumar Banerjee wrote:
>>> I think there should be a high-level user manual subsection for
>>> networking that describes how the selection of the network stack
>>> works. We can then add another subsection about lwip since legacy
>>> already has one, and libbsd is getting added now.
>>
>> This sounds like a good approach.
>>
> 
> I agree.
> 
> Chris

Just so that we are all on the same page:

That would be a number of new subsections in 
https://docs.rtems.org/branches/master/user/index.html:

- 15. Selecting a Network Stack
- 16. Add-on: libbsd Stack
- 17. Add-on: lwIP
- 18. Add-on: Legacy Network Stack

Or was it meant to be only a section

- 15. Selecting a Network Stack
in https://docs.rtems.org/branches/master/user/index.html,
- a new manual "libbsd" in the top level https://docs.rtems.org/,
- a new manual "lwip" in the top level https://docs.rtems.org/

By the way: I think we maybe should keep in mind that there can be more 
add-on packages added some-when in the future that are not network 
stacks. We could for example add documentation for a CAN library, a 
display library or a weather control station. So if we need a top level 
name for all packages, we maybe should call it "add-on packages" instead 
of "network libraries".

Best regards

Christian


More information about the devel mailing list