diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-10-12 15:51:24 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-09 15:04:34 +0100 |
commit | 51a5138bfea0c1bebfa25ba9e726f52589f3c21a (patch) | |
tree | 59bfb31a847d2bde43ed4f8a4e73de920b291150 /c-user/config/general.rst | |
parent | eng: Add function attributes (diff) | |
download | rtems-docs-51a5138bfea0c1bebfa25ba9e726f52589f3c21a.tar.bz2 |
c-user: Add "Generated from ..." comments
Diffstat (limited to 'c-user/config/general.rst')
-rw-r--r-- | c-user/config/general.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/c-user/config/general.rst b/c-user/config/general.rst index b78a81c..9662506 100644 --- a/c-user/config/general.rst +++ b/c-user/config/general.rst @@ -15,11 +15,15 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-general + General System Configuration ============================ This section describes general system configuration options. +.. Generated from spec:/acfg/if/dirty-memory + .. index:: CONFIGURE_DIRTY_MEMORY .. _CONFIGURE_DIRTY_MEMORY: @@ -51,6 +55,8 @@ NOTES: See also :ref:`CONFIGURE_MALLOC_DIRTY`. +.. Generated from spec:/acfg/if/disable-newlib-reentrancy + .. index:: CONFIGURE_DISABLE_NEWLIB_REENTRANCY .. _CONFIGURE_DISABLE_NEWLIB_REENTRANCY: @@ -78,6 +84,8 @@ NOTES: behaviour. For example, :c:macro:`errno` is no longer a thread-local variable if this option is enabled. +.. Generated from spec:/acfg/if/executive-ram-size + .. index:: CONFIGURE_EXECUTIVE_RAM_SIZE .. _CONFIGURE_EXECUTIVE_RAM_SIZE: @@ -116,6 +124,8 @@ NOTES: This is an advanced configuration option. Use it only if you know exactly what you are doing. +.. Generated from spec:/acfg/if/extra-task-stacks + .. index:: CONFIGURE_EXTRA_TASK_STACKS .. index:: memory for task tasks @@ -153,6 +163,8 @@ NOTES: stacks larger then the minimum, then that memory is **not** accounted for by ``<rtems/confdefs.h>``. +.. Generated from spec:/acfg/if/initial-extensions + .. index:: CONFIGURE_INITIAL_EXTENSIONS .. _CONFIGURE_INITIAL_EXTENSIONS: @@ -182,6 +194,8 @@ NOTES: :ref:`BSP_INITIAL_EXTENSION` and after the entries of all other initial user extensions. +.. Generated from spec:/acfg/if/interrupt-stack-size + .. index:: CONFIGURE_INTERRUPT_STACK_SIZE .. index:: interrupt stack size @@ -236,6 +250,8 @@ NOTES: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` instead of :c:macro:`CPU_STACK_MINIMUM_SIZE`. +.. Generated from spec:/acfg/if/malloc-dirty + .. index:: CONFIGURE_MALLOC_DIRTY .. _CONFIGURE_MALLOC_DIRTY: @@ -264,6 +280,8 @@ NOTES: :ref:`CONFIGURE_DIRTY_MEMORY` which dirties the memory only once during the system initialization. +.. Generated from spec:/acfg/if/max-file-descriptors + .. index:: CONFIGURE_MAXIMUM_FILE_DESCRIPTORS .. index:: maximum file descriptors @@ -301,6 +319,8 @@ NOTES: The default value of three file descriptors allows RTEMS to support standard input, output, and error I/O streams on :file:`/dev/console`. +.. Generated from spec:/acfg/if/max-processors + .. index:: CONFIGURE_MAXIMUM_PROCESSORS .. _CONFIGURE_MAXIMUM_PROCESSORS: @@ -336,6 +356,8 @@ NOTES: was built with the ``--enable-smp`` build configuration option). In all other configurations it has no effect. +.. Generated from spec:/acfg/if/max-thread-name-size + .. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE .. index:: maximum thread name size @@ -378,6 +400,8 @@ NOTES: This configuration option is available since RTEMS 5.1. +.. Generated from spec:/acfg/if/memory-overhead + .. index:: CONFIGURE_MEMORY_OVERHEAD .. _CONFIGURE_MEMORY_OVERHEAD: @@ -420,6 +444,8 @@ NOTES: all message queue buffers or task stacks, see :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. +.. Generated from spec:/acfg/if/message-buffer-memory + .. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY .. index:: configure message queue buffer memory .. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE @@ -504,6 +530,8 @@ NOTES: ) \ ) +.. Generated from spec:/acfg/if/microseconds-per-tick + .. index:: CONFIGURE_MICROSECONDS_PER_TICK .. index:: clock tick quantum .. index:: tick quantum @@ -558,6 +586,8 @@ NOTES: There may be Clock Driver specific limits on the resolution or maximum value of a clock tick quantum. +.. Generated from spec:/acfg/if/min-task-stack-size + .. index:: CONFIGURE_MINIMUM_TASK_STACK_SIZE .. index:: minimum task stack size @@ -612,6 +642,8 @@ NOTES: In releases before RTEMS 5.1 the ``CONFIGURE_MINIMUM_TASK_STACK_SIZE`` was used to define the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`. +.. Generated from spec:/acfg/if/stack-checker-enabled + .. index:: CONFIGURE_STACK_CHECKER_ENABLED .. _CONFIGURE_STACK_CHECKER_ENABLED: @@ -640,6 +672,8 @@ NOTES: In 4.9 and older, this configuration option was named ``STACK_CHECKER_ON``. +.. Generated from spec:/acfg/if/ticks-per-time-slice + .. index:: CONFIGURE_TICKS_PER_TIMESLICE .. index:: ticks per timeslice @@ -669,6 +703,8 @@ NOTES: This configuration option has no impact if the Clock Driver is not configured, see :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`. +.. Generated from spec:/acfg/if/unified-work-areas + .. index:: CONFIGURE_UNIFIED_WORK_AREAS .. index:: unified work areas .. index:: separate work areas @@ -705,6 +741,8 @@ NOTES: until you run out of all available memory rather then just until you run out of RTEMS Workspace. +.. Generated from spec:/acfg/if/unlimited-allocation-size + .. index:: CONFIGURE_UNLIMITED_ALLOCATION_SIZE .. _CONFIGURE_UNLIMITED_ALLOCATION_SIZE: @@ -738,6 +776,8 @@ NOTES: The object maximum of each class can be configured also individually using the :c:func:`rtems_resource_unlimited` macro. +.. Generated from spec:/acfg/if/unlimited-objects + .. index:: CONFIGURE_UNLIMITED_OBJECTS .. _CONFIGURE_UNLIMITED_OBJECTS: @@ -769,6 +809,8 @@ NOTES: See also :ref:`CONFIGURE_UNLIMITED_ALLOCATION_SIZE`. +.. Generated from spec:/acfg/if/verbose-system-init + .. index:: CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION .. _CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION: @@ -794,6 +836,8 @@ NOTES: You may use this feature to debug system initialization issues. The :c:func:`printk` function is used to print the information. +.. Generated from spec:/acfg/if/zero-workspace-automatically + .. index:: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY .. index:: clear C Program Heap .. index:: clear RTEMS Workspace |