diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-06 09:23:27 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-07 12:58:52 +0200 |
commit | 518d8c3763f4ab0e3cac33d643b968f5e868e9c4 (patch) | |
tree | 63b8ca1334ab7c71956214ab17a81d5bef04aaac /spec/if/acfg/appl-does-not-need-clock-driver.yml | |
parent | content: Add CContent.add_paragraph() (diff) | |
download | rtems-central-518d8c3763f4ab0e3cac33d643b968f5e868e9c4.tar.bz2 |
spec: Move application configuration items
Diffstat (limited to 'spec/if/acfg/appl-does-not-need-clock-driver.yml')
-rw-r--r-- | spec/if/acfg/appl-does-not-need-clock-driver.yml | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/spec/if/acfg/appl-does-not-need-clock-driver.yml b/spec/if/acfg/appl-does-not-need-clock-driver.yml new file mode 100644 index 00000000..67a89324 --- /dev/null +++ b/spec/if/acfg/appl-does-not-need-clock-driver.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | + If this configuration option is undefined, then a Clock Driver may be + initialized during system initialization. +description: | + In case this configuration option is defined, then **no** Clock Driver is + initialized during system initialization. +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: group-devdrv +name: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER +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. + + The application shall define exactly one of the following configuration options + + * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, + + * `CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or + + * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, + + otherwise a compile time error in the configuration file will occur. +text: '' +type: interface |