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

[Joel Sherrill]

On Mon, Nov 6, 2017 at 6:56 PM, Chris Johns <chrisj at rtems.org> 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?
>
> I have figured out indexes and I will sweep over the docs adding them
> soon. 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
>

+1

Another option -- if it fits -- is to do something like the directives
and UNIX man pages. "cmd - English phrase". The risk here
is that this may be too long.

>
> etc.
>
> Chris
> _______________________________________________
> 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/20171106/f3e570b5/attachment-0001.html>