[PATCH 0/1] c-user: Generate I/O Manager documentation

[Joel Sherrill]

On Thu, Oct 1, 2020 at 10:53 AM Sebastian Huber <
sebastian.huber at embedded-brains.de> wrote:

> On 29/09/2020 16:59, Sebastian Huber wrote:
>
> > This is the first generated documentation of a manager. For the PDF
> > output please have a look at:
> >
> > https://ftp.rtems.org/pub/rtems/people/sebh/c-user.pdf
> >
> > Please review the layout.  I changed the layout to use definition lists
> > instead of tables.  The benefit of definition lists is that the layout
> > of longer text paragraphs is much nicer compared to tables (at least for
> > the PDF output).
>

I'm not opposed to changing the all caps shorthand name to the real name.


>
> Two new layout variants are available. This one has the description
> after the calling sequence:
>
> https://ftp.rtems.org/pub/rtems/people/sebh/c-user-3.pdf
>
> This one has calling sequence, parameters, description:
>
> https://ftp.rtems.org/pub/rtems/people/sebh/c-user-4.pdf


This is preferable. We should try to follow the POSIX ordering.

It looks like the ordering of the methods has changed. It was generally
very carefully chosen. Why would close be the first service listed?

The order generally reflects the usage -- open before close, create
before delete. etc.

The order shouldn't change.

>
>
> Here is the HTML output:
>
> https://ftp.rtems.org/pub/rtems/people/sebh/c-user/html/index.html
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20201001/9d34c26c/attachment.html>