[RTEMS Project] #3901: New template for configuration options with a value

RTEMS trac trac at rtems.org
Fri Mar 6 15:27:25 UTC 2020


#3901: New template for configuration options with a value
------------------------------+-----------------------------
  Reporter:  Sebastian Huber  |      Owner:  Sebastian Huber
      Type:  task             |     Status:  assigned
  Priority:  normal           |  Milestone:  5.1
 Component:  doc              |    Version:  5
  Severity:  normal           |   Keywords:
Blocked By:                   |   Blocking:
------------------------------+-----------------------------
 Change the documentation template for configuration options with a value
 to:
 {{{
 .. _CONFIGURE_XYZ:

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

 CONSTANT:
     ``CONFIGURE_XYZ``

 OPTION TYPE:
     This configuration option is an integer define.

 VALUE RANGE:
     The specified value must be greater than or equal to X and less than
 or
     equal to Y.

 DEFAULT VALUE:
     The default value is Z.

 DESCRIPTION:
     This configuration option defines the ABC.

 NOTES:
     Notes for XYZ.
 }}}
 Use `OPTION TYPE` instead of `DATA TYPE` since we have to characterize the
 option an not just the value of an option.  This is in line with #3900.

 Use `VALUE RANGE` instead of `RANGE` to be more specific.

--
Ticket URL: <http://devel.rtems.org/ticket/3901>
RTEMS Project <http://www.rtems.org/>
RTEMS Project


More information about the bugs mailing list