diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-27 12:53:09 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-04-01 07:49:12 +0200 |
commit | 7bad8940ad05ea1e3b41745012a0dc5391275477 (patch) | |
tree | 417974a7eedf1b89c709648c36e1d234934b9ff7 /c-user/config/event-record.rst | |
parent | c-user: Avoid self references (diff) | |
download | rtems-docs-7bad8940ad05ea1e3b41745012a0dc5391275477.tar.bz2 |
c-user: Use new template for integer config opts
Try to bring all descriptions up to date. Add cross-references to
several options. Clarify configuration value constraints.
Use this template also for initializer type options.
Close #3901.
Diffstat (limited to 'c-user/config/event-record.rst')
-rw-r--r-- | c-user/config/event-record.rst | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst index edd8722..6c93a3a 100644 --- a/c-user/config/event-record.rst +++ b/c-user/config/event-record.rst @@ -110,19 +110,31 @@ CONFIGURE_RECORD_PER_PROCESSOR_ITEMS CONSTANT: ``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS`` -DATA TYPE: - Unsigned integer (``unsigned int``). - -RANGE: - A power of two greater than or equal to 16. +OPTION TYPE: + This configuration option is an integer define. DEFAULT VALUE: - This is not defined by default. + The default value is 0. + +VALUE CONSTRAINTS: + The value of this configuration option shall satisfy all of the following + constraints: + + * It shall be greater than or equal to 16. + + * It shall be less than or equal to ``SIZE_MAX``. + + * It shall be a power of two. + + * It shall be less than or equal to a + BSP-specific and application-specific value which depends on the size of the + memory available to the application. DESCRIPTION: - If defined, then a record item buffer of the specified item count is - statically allocated for each configured processor - (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`). + The value of this configuration option defines the event record item count + per processor. NOTES: - None. + The event record buffers are statically allocated for each configured + processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this + configuration option is zero, then nothing is allocated. |