Please Review Rewrite of Configuring a System Chapter

[Joel Sherrill]

I should have added that documenting the configuration
parameters in this manner is a big step into having them
documented in a more structured format so that an
Application Configuration GUI can know what data type,
default value, range of valid values, etc. easier.

The current documentation simply is not structured
in any manner which would enable that. The challenge
now is to make the new way consistent and complete.

On 04/06/2013 05:19 PM, Joel Sherrill wrote:
> Hi
>
> I have undertaken a very significant overhaul of the Configuring
> a System chapter. Each parameter now has a man page style
> section which allows much greater freedom in including
> informatin.
>
> I have placed the PDF of the new version of
> the chapter in my personal ftp space.  It needs review.
>
> http://www.rtems.org/ftp/pub/rtems/people/joel/config-v1.pdf.bz2
>
> In particular, before I commit it, I would like to know if there are
> any reordering of sections, typos, etc that need addressing.
> After it is committed, it still needs a review for:
>
> + is everything in confdefs.h documented?
> + are the data type and ranges and default value sections consistent?
> + More examples
> + More advice on each parameter
> + More cross references.
> + Possibly more index entries
>
> Cynthia was kind enough to review it while before I was finished.
>
> Please review and comment. Otherwise, sometime next week
> I will commit it.
>


-- 
Joel Sherrill, Ph.D.             Director of Research& Development
joel.sherrill at OARcorp.com        On-Line Applications Research
Ask me about RTEMS: a free RTOS  Huntsville AL 35806
Support Available               (256) 722-9985