[PATCH] c-user: Use configuration option as section name

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Nov 7 07:52:15 UTC 2017


On 07/11/17 01:56, Chris Johns wrote:
> On 06/11/2017 22:56, Sebastian Huber wrote:
>> This makes it easier to find the documentation for a given configuration
>> option.
> Can you please generate the HTML and PDF so we can review what this looks like?

You can review it here:

https://ftp.rtems.org/pub/rtems/people/sebh/c-user/html/index.html
https://ftp.rtems.org/pub/rtems/people/sebh/c-user/c-user.pdf

>
> I have figured out indexes and I will sweep over the docs adding them soon.

Sounds good.

> The
> CONFIGURE_.... then can be added as indexes which puts them a few of clicks away
> from the top level so I am not sure about this change. I tend to like the
> English and not the exact constants.
>
> The current labels could do with a clean up. There is way more info in the
> headings than needs to be there. The docs clearly show the levels in the HTML
> format and while not as clear in the PDF is it OK. This means for example:
>
> Instantiate Classic API Initialization Task Table =>
> Instantiate Classic Initialization Task Table
>
> Specifying Classic API Initialization Task Entry Point =>
>    Classic Initialization Task Entry Point
>
> Specify Maximum POSIX API Threads => Maximum POSIX Threads
>
> Classic API Initialization Tasks Table Configuration =>
> Classic Initialization Tasks Table Configuration

I (and some others using the manual) found it quite hard to quickly find 
the configuration options with these verbose section names.

My next step would be to sort them alphabetically in each group.

-- 
Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.




More information about the devel mailing list