diff options
Diffstat (limited to 'spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml')
| -rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml index a10a7488..a8e962f7 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml @@ -1,22 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then a clock driver may be + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is defined when the - application does *NOT* want the Clock Device Driver and is *NOT* using the - Timer Driver. The inclusion or exclusion of the Clock Driver must be - explicit in user applications. + In case this configuration option is defined, then **no** clock driver is + initialized during system initialization. appl-config-option-index: [] appl-config-option-name: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER appl-config-option-notes: | This configuration parameter is intended to prevent the common user error of using the Hello World example as the baseline for an application and leaving out a clock tick source. -appl-config-option-range: | - Defined or undefined. + + The application must define exactly one of the following configuration options + + * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, + + * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or + + * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, + + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false |