Documentation | Draft: Create a Package Manual (!50)

[Christian Mauderer (@c-mauderer)]

Merge request https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50 was reviewed by Christian Mauderer

--
  
Christian Mauderer commented on a discussion on package/libbsd/developer/network_drivers.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114237

 > +   basic informations can also be printed using `netstat` independent of the
 > +   driver.
 > +#. `media01` should also provide a `tcpdump` that you can use to dump received

I switched to ftpd01 for both cases. That should work for the basic ping tests too.

--
  
Christian Mauderer commented on a discussion on package/libbsd/user/index.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114238

 > +   other configuration files. Advantage of this model is that it is simple and
 > +   straightforward. Usually the FreeBSD documentation can be used to find out
 > +   how to configure something. The disadvantage is that the configuration isn't

I tried to remove all contractions that I have added. I hope I didn't miss one.

--
  
Christian Mauderer commented on a discussion on package/libbsd/user/index.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114239

 > +   don't have serious memory limitations.
 > +
 > +2. Alternatively it's possible to do the configuration with calls to certain

I tried to remove all contractions that I have added. I hope I didn't miss one.

--
  
Christian Mauderer commented on a discussion on package/index.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114240

 > +
 > +    overview
 > +    legacy-networking/index

Done.

--
  
Christian Mauderer commented on a discussion on package/index.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114241

 > +    legacy-networking/index
 > +    lwip/index
 > +    libbsd/index

I moved the manual to the user (like suggested in #35). So I think the index should be solved with that?

--
  
Christian Mauderer commented on a discussion on package/overview.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114242

 > +
 > +This manual provides information for various bigger add-on-packages for RTEMS
 > +that are maintained by the RTEMS community like the various network stacks.

I tried to add a short explanation.

--
  
Christian Mauderer commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_114243


Like suggested in #35, I moved the manual to be a subchapter of the user manual.

I think at the moment I added commits on top to make it simpler to see what I changed between the versions. If the current version is OK, I'll squash the commits into something sensible and remove the draft state of the merge request.

PS: Sorry for the slow response times. At the moment this is a hobby-time change.


-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20241102/cbff55c8/attachment-0001.htm>