[RTEMS Project] #3900: New template for boolean feature defines

[RTEMS trac]

#3900: New template for boolean feature defines
-----------------------------+------------------------------
 Reporter:  Sebastian Huber  |       Owner:  Sebastian Huber
     Type:  task             |      Status:  assigned
 Priority:  normal           |   Milestone:  5.1
Component:  doc              |     Version:  5
 Severity:  normal           |  Resolution:
 Keywords:                   |  Blocked By:
 Blocking:                   |
-----------------------------+------------------------------
Description changed by Sebastian Huber:

Old description:

> All boolean feature defines are undefined by default. The current
> template is a bit awkward. Change the application configuration option
> template for boolean feature defines to:
> {{{
> .. index:: CONFIGURE_XYZ
>
> .. _CONFIGURE_XYZ:
>
> CONFIGURE_XYZ
> -------------
>
> CONSTANT:
>     ``CONFIGURE_XYZ``
>
> OPTION TYPE:
>     This configuration option is a boolean feature define.
>
> DEFAULT CONFIGURATION:
>     If this configuration option is undefined, then not ABC or something
> else.
>
> OPTION DEFINED CONFIGURATION:
>     In case this configuration option is defined, then ABC.
>
> NOTES:
>     Notes for XYZ.
> }}}

New description:

 All boolean feature defines are undefined by default. The current template
 is a bit awkward. Change the application configuration option template for
 boolean feature defines to:
 {{{
 .. index:: CONFIGURE_XYZ

 .. _CONFIGURE_XYZ:

 CONFIGURE_XYZ
 -------------

 CONSTANT:
     ``CONFIGURE_XYZ``

 OPTION TYPE:
     This configuration option is a boolean feature define.

 DEFAULT CONFIGURATION:
     If this configuration option is undefined, then not ABC or something
 else.

 DESCRIPTION:
     In case this configuration option is defined, then ABC.

 NOTES:
     Notes for XYZ.
 }}}

--

--
Ticket URL: <http://devel.rtems.org/ticket/3900#comment:1>
RTEMS Project <http://www.rtems.org/>
RTEMS Project