diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-18 14:45:19 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-19 09:04:34 +0100 |
commit | a0e78f0e0fac19ed6361e91bac32a0a6b30b3d28 (patch) | |
tree | ca30798781a82aa873f2e325c4209c070445e02f /spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml | |
parent | applconfig: Support new boolean feature template (diff) | |
download | rtems-central-a0e78f0e0fac19ed6361e91bac32a0a6b30b3d28.tar.bz2 |
spec: Convert boolean feature options
Diffstat (limited to 'spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml')
-rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml index f854be80..bbc2940f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml @@ -1,22 +1,27 @@ 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 no Benchmark Timer Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`` is defined if the application - wishes to include the Timer Driver. This device driver is used to - benchmark execution times by the RTEMS Timing Test Suites. + In case this configuration option is defined, then the Benchmark Timer Driver is + initialized during system initialization. appl-config-option-index: [] appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER appl-config-option-notes: | - If neither the Clock Driver not Benchmark Timer is enabled and the - configuration parameter - ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a - compile time error will occur. -appl-config-option-range: | - Defined or undefined. + The Benchmark Timer Driver is intended for the benchmark tests of the RTEMS + Testsuite. Applications should not use this driver. + + 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 |