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

[Christian MAUDERER]

Hello Chris,

Am 04.08.21 um 09:28 schrieb Chris Johns:
> On 3/8/21 5:00 pm, Christian MAUDERER wrote:
>> 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
> 
> I think a single section so all things networking are grouped.

That will result in either a deep nesting for the chapters or in very 
hard to organize information because two levels are used up already. For 
example the current legacy network manual has a

   5.3.1. Additional include files

If we make one "networking" group, that would be

   15. Networking
   15.3 Legacy Network Stack
   15.3.5 Using Networking in an RTEMS application
   15.3.5.3 Initialization
   15.3.5.3.1 Additional include files

And please also note: I think we should see libbsd more as an Add-on 
package and less as a pure network stack. It provides a lot more than 
just networking. It has USB, it can add HDMI (on beagle for example), it 
includes an OpenSSL implementation, ...

Best regards

Christian

> 
> Chris
> 
>>
>> - 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

-- 
--------------------------------------------
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/