From 51a5138bfea0c1bebfa25ba9e726f52589f3c21a Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 12 Oct 2020 15:51:24 +0200 Subject: c-user: Add "Generated from ..." comments --- c-user/config/bdbuf.rst | 28 +++++++++++++++++++ c-user/config/bsp-related.rst | 16 +++++++++++ c-user/config/classic-api.rst | 26 +++++++++++++++++ c-user/config/classic-init-task.rst | 18 ++++++++++++ c-user/config/device-driver.rst | 38 +++++++++++++++++++++++++ c-user/config/event-record.rst | 10 +++++++ c-user/config/filesystem.rst | 56 +++++++++++++++++++++++++++++++++++++ c-user/config/general.rst | 44 +++++++++++++++++++++++++++++ c-user/config/idle-task.rst | 8 ++++++ c-user/config/mpci.rst | 16 +++++++++++ c-user/config/posix-api.rst | 20 +++++++++++++ c-user/config/posix-init-thread.rst | 8 ++++++ c-user/config/scheduler-general.rst | 30 ++++++++++++++++++++ c-user/config/task-stack-alloc.rst | 12 ++++++++ 14 files changed, 330 insertions(+) diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst index 1a0d393..e981f54 100644 --- a/c-user/config/bdbuf.rst +++ b/c-user/config/bdbuf.rst @@ -15,12 +15,16 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-bdbuf + Block Device Cache Configuration ================================ This section describes configuration options related to the Block Device Cache (bdbuf). +.. Generated from spec:/acfg/if/appl-needs-libblock + .. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK .. _CONFIGURE_APPLICATION_NEEDS_LIBBLOCK: @@ -47,6 +51,8 @@ NOTES: set by the user with the configuration options below. The Block Device Cache is used for example by the RFS and DOSFS filesystems. +.. Generated from spec:/acfg/if/bdbuf-buffer-max-size + .. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE .. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE: @@ -78,6 +84,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-buffer-min-size + .. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE .. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE: @@ -105,6 +113,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-cache-memory-size + .. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE .. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE: @@ -132,6 +142,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-max-read-ahead-blocks + .. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS .. _CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS: @@ -161,6 +173,8 @@ NOTES: will issue speculative read transfers if a sequential access pattern is detected. This can improve the performance on some systems. +.. Generated from spec:/acfg/if/bdbuf-max-write-blocks + .. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS .. _CONFIGURE_BDBUF_MAX_WRITE_BLOCKS: @@ -188,6 +202,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-read-ahead-task-priority + .. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY .. _CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY: @@ -214,6 +230,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-task-stack-size + .. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE .. _CONFIGURE_BDBUF_TASK_STACK_SIZE: @@ -251,6 +269,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-swapout-block-hold + .. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD .. _CONFIGURE_SWAPOUT_BLOCK_HOLD: @@ -278,6 +298,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-swapout-swap-period + .. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD .. _CONFIGURE_SWAPOUT_SWAP_PERIOD: @@ -305,6 +327,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-swapout-task-priority + .. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY .. _CONFIGURE_SWAPOUT_TASK_PRIORITY: @@ -331,6 +355,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-swapout-worker-tasks + .. index:: CONFIGURE_SWAPOUT_WORKER_TASKS .. _CONFIGURE_SWAPOUT_WORKER_TASKS: @@ -357,6 +383,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bdbuf-swapout-worker-taskp-riority + .. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY .. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY: diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst index 8ed34cf..71bcd58 100644 --- a/c-user/config/bsp-related.rst +++ b/c-user/config/bsp-related.rst @@ -15,6 +15,8 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-bsp + BSP Related Configuration Options ================================= @@ -23,6 +25,8 @@ configuration options may have a BSP-specific setting which is defined by ````. The BSP-specific settings can be disabled by the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option. +.. Generated from spec:/acfg/if/bsp-idle-task-body + .. index:: BSP_IDLE_TASK_BODY .. _BSP_IDLE_TASK_BODY: @@ -58,6 +62,8 @@ NOTES: peripheral buses, a BSP-specific IDLE task may be capable of turning components off to save power during extended periods of no task activity. +.. Generated from spec:/acfg/if/bsp-idle-task-stack-size + .. index:: BSP_IDLE_TASK_STACK_SIZE .. _BSP_IDLE_TASK_STACK_SIZE: @@ -98,6 +104,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bsp-initial-extension + .. index:: BSP_INITIAL_EXTENSION .. _BSP_INITIAL_EXTENSION: @@ -132,6 +140,8 @@ NOTES: The value of this configuration option is placed after the entries of all other initial user extensions. +.. Generated from spec:/acfg/if/bsp-interrupt-stack-size + .. index:: BSP_INTERRUPT_STACK_SIZE .. _BSP_INTERRUPT_STACK_SIZE: @@ -175,6 +185,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/bsp-prerequisite-drivers + .. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS .. _CONFIGURE_BSP_PREREQUISITE_DRIVERS: @@ -210,6 +222,8 @@ NOTES: other initial user extensions (including :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`). +.. Generated from spec:/acfg/if/disable-bsp-settings + .. index:: CONFIGURE_DISABLE_BSP_SETTINGS .. _CONFIGURE_DISABLE_BSP_SETTINGS: @@ -246,6 +260,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/malloc-bsp-supports-sbrk + .. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK .. _CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK: diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst index d1e197b..90aec72 100644 --- a/c-user/config/classic-api.rst +++ b/c-user/config/classic-api.rst @@ -15,11 +15,15 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-classic + Classic API Configuration ========================= This section describes configuration options related to the Classic API. +.. Generated from spec:/acfg/if/max-barriers + .. index:: CONFIGURE_MAXIMUM_BARRIERS .. _CONFIGURE_MAXIMUM_BARRIERS: @@ -61,6 +65,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-message-queues + .. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES .. _CONFIGURE_MAXIMUM_MESSAGE_QUEUES: @@ -104,6 +110,8 @@ NOTES: store the messages of each message queue, see :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. +.. Generated from spec:/acfg/if/max-partitions + .. index:: CONFIGURE_MAXIMUM_PARTITIONS .. _CONFIGURE_MAXIMUM_PARTITIONS: @@ -145,6 +153,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-periods + .. index:: CONFIGURE_MAXIMUM_PERIODS .. _CONFIGURE_MAXIMUM_PERIODS: @@ -186,6 +196,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-ports + .. index:: CONFIGURE_MAXIMUM_PORTS .. _CONFIGURE_MAXIMUM_PORTS: @@ -227,6 +239,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-regions + .. index:: CONFIGURE_MAXIMUM_REGIONS .. _CONFIGURE_MAXIMUM_REGIONS: @@ -268,6 +282,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-semaphores + .. index:: CONFIGURE_MAXIMUM_SEMAPHORES .. _CONFIGURE_MAXIMUM_SEMAPHORES: @@ -313,6 +329,8 @@ NOTES: scheduler count (see :ref:`ConfigurationSchedulerTable`). The semaphores using the :ref:`MrsP` need a ceiling priority per scheduler. +.. Generated from spec:/acfg/if/max-tasks + .. index:: CONFIGURE_MAXIMUM_TASKS .. _CONFIGURE_MAXIMUM_TASKS: @@ -371,6 +389,8 @@ NOTES: the addition of a new configuration parameter to specify the number of tasks which enable floating point support. +.. Generated from spec:/acfg/if/max-thread-local-storage-size + .. index:: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE .. _CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE: @@ -415,6 +435,8 @@ NOTES: the RTEMS Tools can be used to obtain the thread-local storage size and alignment of an application executable. +.. Generated from spec:/acfg/if/max-timers + .. index:: CONFIGURE_MAXIMUM_TIMERS .. _CONFIGURE_MAXIMUM_TIMERS: @@ -456,6 +478,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-user-extensions + .. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS .. _CONFIGURE_MAXIMUM_USER_EXTENSIONS: @@ -491,6 +515,8 @@ DESCRIPTION: NOTES: This object class cannot be configured in unlimited allocation mode. +.. Generated from spec:/acfg/if/min-tasks-with-user-provided-storage + .. index:: CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE .. _CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE: diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst index 8430757..64a8f9f 100644 --- a/c-user/config/classic-init-task.rst +++ b/c-user/config/classic-init-task.rst @@ -15,12 +15,16 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-classicinit + Classic API Initialization Task Configuration ============================================= This section describes configuration options related to the Classic API initialization task. +.. Generated from spec:/acfg/if/init-task-arguments + .. index:: CONFIGURE_INIT_TASK_ARGUMENTS .. _CONFIGURE_INIT_TASK_ARGUMENTS: @@ -48,6 +52,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/init-task-attributes + .. index:: CONFIGURE_INIT_TASK_ATTRIBUTES .. _CONFIGURE_INIT_TASK_ATTRIBUTES: @@ -74,6 +80,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/init-task-entrypoint + .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT .. _CONFIGURE_INIT_TASK_ENTRY_POINT: @@ -102,6 +110,8 @@ NOTES: The application shall provide the function referenced by this configuration option. +.. Generated from spec:/acfg/if/init-task-initial-modes + .. index:: CONFIGURE_INIT_TASK_INITIAL_MODES .. _CONFIGURE_INIT_TASK_INITIAL_MODES: @@ -129,6 +139,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/init-task-name + .. index:: CONFIGURE_INIT_TASK_NAME .. _CONFIGURE_INIT_TASK_NAME: @@ -156,6 +168,8 @@ DESCRIPTION: NOTES: Use :c:func:`rtems_build_name` to define the task name. +.. Generated from spec:/acfg/if/init-task-priority + .. index:: CONFIGURE_INIT_TASK_PRIORITY .. _CONFIGURE_INIT_TASK_PRIORITY: @@ -183,6 +197,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/init-task-stack-size + .. index:: CONFIGURE_INIT_TASK_STACK_SIZE .. _CONFIGURE_INIT_TASK_STACK_SIZE: @@ -216,6 +232,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/rtems-init-tasks-table + .. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE .. _CONFIGURE_RTEMS_INIT_TASKS_TABLE: diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst index 25f15d1..8915b0b 100644 --- a/c-user/config/device-driver.rst +++ b/c-user/config/device-driver.rst @@ -15,12 +15,16 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-devdrv + Device Driver Configuration =========================== This section describes configuration options related to the device drivers. Note that network device drivers are not covered by the following options. +.. Generated from spec:/acfg/if/appl-does-not-need-clock-driver + .. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER .. _CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER: @@ -57,6 +61,8 @@ NOTES: otherwise a compile time error in the configuration file will occur. +.. Generated from spec:/acfg/if/appl-extra-drivers + .. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS .. _CONFIGURE_APPLICATION_EXTRA_DRIVERS: @@ -88,6 +94,8 @@ NOTES: See :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS` for an alternative placement of application device driver initializers. +.. Generated from spec:/acfg/if/appl-needs-ata-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER: @@ -115,6 +123,8 @@ NOTES: If this option is defined and the BSP does not have this device driver, then the user will get a link time error for an undefined symbol. +.. Generated from spec:/acfg/if/appl-needs-clock-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER: @@ -150,6 +160,8 @@ NOTES: otherwise a compile time error in the configuration file will occur. +.. Generated from spec:/acfg/if/appl-needs-console-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER: @@ -189,6 +201,8 @@ NOTES: configuration options are mutually exclusive. +.. Generated from spec:/acfg/if/appl-needs-framebuffer-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER: @@ -217,6 +231,8 @@ NOTES: If this option is defined and the BSP does not have this device driver, then the user will get a link time error for an undefined symbol. +.. Generated from spec:/acfg/if/appl-needs-ide-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER: @@ -244,6 +260,8 @@ NOTES: If this option is defined and the BSP does not have this device driver, then the user will get a link time error for an undefined symbol. +.. Generated from spec:/acfg/if/appl-needs-null-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER .. index:: /dev/null @@ -269,6 +287,8 @@ DESCRIPTION: NOTES: This device driver is supported by all BSPs. +.. Generated from spec:/acfg/if/appl-needs-rtc-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER: @@ -297,6 +317,8 @@ NOTES: If this is defined and the BSP does not have this device driver, then the user will get a link time error for an undefined symbol. +.. Generated from spec:/acfg/if/appl-needs-simple-console-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER: @@ -340,6 +362,8 @@ NOTES: configuration options are mutually exclusive. +.. Generated from spec:/acfg/if/appl-needs-simple-task-console-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER: @@ -392,6 +416,8 @@ NOTES: configuration options are mutually exclusive. +.. Generated from spec:/acfg/if/appl-needs-stub-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER: @@ -417,6 +443,8 @@ NOTES: This device driver simply provides entry points that return successful and is primarily a test fixture. It is supported by all BSPs. +.. Generated from spec:/acfg/if/appl-needs-timer-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER: @@ -452,6 +480,8 @@ NOTES: otherwise a compile time error will occur. +.. Generated from spec:/acfg/if/appl-needs-watchdog-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER .. _CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER: @@ -480,6 +510,8 @@ NOTES: If this is defined and the BSP does not have this device driver, then the user will get a link time error for an undefined symbol. +.. Generated from spec:/acfg/if/appl-needs-zero-driver + .. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER .. index:: /dev/zero @@ -505,6 +537,8 @@ DESCRIPTION: NOTES: This device driver is supported by all BSPs. +.. Generated from spec:/acfg/if/appl-prerequisite-drivers + .. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS .. _CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS: @@ -537,6 +571,8 @@ NOTES: See :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS` for an alternative placement of application device driver initializers. +.. Generated from spec:/acfg/if/ata-driver-task-priority + .. index:: CONFIGURE_ATA_DRIVER_TASK_PRIORITY .. _CONFIGURE_ATA_DRIVER_TASK_PRIORITY: @@ -564,6 +600,8 @@ NOTES: This configuration option is only evaluated if the configuration option :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined. +.. Generated from spec:/acfg/if/max-drivers + .. index:: CONFIGURE_MAXIMUM_DRIVERS .. _CONFIGURE_MAXIMUM_DRIVERS: diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst index 462f9e2..6373e04 100644 --- a/c-user/config/event-record.rst +++ b/c-user/config/event-record.rst @@ -14,11 +14,15 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-eventrecord + Event Recording Configuration ============================= This section describes configuration options related to the event recording. +.. Generated from spec:/acfg/if/record-extensions-enabled + .. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED .. _CONFIGURE_RECORD_EXTENSIONS_ENABLED: @@ -49,6 +53,8 @@ NOTES: The record extensions capture thread create, start, restart, delete, switch, begin, exitted and terminate events. +.. Generated from spec:/acfg/if/record-fatal-dump-base64 + .. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64 .. _CONFIGURE_RECORD_FATAL_DUMP_BASE64: @@ -81,6 +87,8 @@ DESCRIPTION: NOTES: This extension can be used to produce crash dumps. +.. Generated from spec:/acfg/if/record-fatal-dump-base64-zlib + .. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB .. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB: @@ -112,6 +120,8 @@ NOTES: The zlib compression needs about 512KiB of RAM. This extension can be used to produce crash dumps. +.. Generated from spec:/acfg/if/record-per-processor-items + .. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS .. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS: diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst index 9269236..8ad9085 100644 --- a/c-user/config/filesystem.rst +++ b/c-user/config/filesystem.rst @@ -15,6 +15,8 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-filesystem + Filesystem Configuration ======================== @@ -60,6 +62,8 @@ configuration options: * :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO` +.. Generated from spec:/acfg/if/appl-disable-filesystem + .. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM .. _CONFIGURE_APPLICATION_DISABLE_FILESYSTEM: @@ -87,6 +91,8 @@ NOTES: drivers and basic input/output functions such as :c:func:`printf`. Filesystems can be disabled to reduce the memory footprint of an application. +.. Generated from spec:/acfg/if/filesystem-all + .. index:: CONFIGURE_FILESYSTEM_ALL .. _CONFIGURE_FILESYSTEM_ALL: @@ -125,6 +131,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/filesystem-dosfs + .. index:: CONFIGURE_FILESYSTEM_DOSFS .. _CONFIGURE_FILESYSTEM_DOSFS: @@ -151,6 +159,8 @@ NOTES: This filesystem requires a Block Device Cache configuration, see :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. +.. Generated from spec:/acfg/if/filesystem-ftpfs + .. index:: CONFIGURE_FILESYSTEM_FTPFS .. _CONFIGURE_FILESYSTEM_FTPFS: @@ -176,6 +186,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/filesystem-imfs + .. index:: CONFIGURE_FILESYSTEM_IMFS .. _CONFIGURE_FILESYSTEM_IMFS: @@ -203,6 +215,8 @@ NOTES: option is intended for test programs. You do not need to define this configuration option for the base filesystem (also known as root filesystem). +.. Generated from spec:/acfg/if/filesystem-jffs2 + .. index:: CONFIGURE_FILESYSTEM_JFFS2 .. _CONFIGURE_FILESYSTEM_JFFS2: @@ -228,6 +242,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/filesystem-nfs + .. index:: CONFIGURE_FILESYSTEM_NFS .. _CONFIGURE_FILESYSTEM_NFS: @@ -253,6 +269,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/filesystem-rfs + .. index:: CONFIGURE_FILESYSTEM_RFS .. _CONFIGURE_FILESYSTEM_RFS: @@ -279,6 +297,8 @@ NOTES: This filesystem requires a Block Device Cache configuration, see :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. +.. Generated from spec:/acfg/if/filesystem-tftpfs + .. index:: CONFIGURE_FILESYSTEM_TFTPFS .. _CONFIGURE_FILESYSTEM_TFTPFS: @@ -304,6 +324,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-chmod + .. index:: CONFIGURE_IMFS_DISABLE_CHMOD .. _CONFIGURE_IMFS_DISABLE_CHMOD: @@ -328,6 +350,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-chown + .. index:: CONFIGURE_IMFS_DISABLE_CHOWN .. _CONFIGURE_IMFS_DISABLE_CHOWN: @@ -352,6 +376,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-link + .. index:: CONFIGURE_IMFS_DISABLE_LINK .. _CONFIGURE_IMFS_DISABLE_LINK: @@ -376,6 +402,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-mknod + .. index:: CONFIGURE_IMFS_DISABLE_MKNOD .. _CONFIGURE_IMFS_DISABLE_MKNOD: @@ -400,6 +428,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-mknod-device + .. index:: CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE .. _CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE: @@ -424,6 +454,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-mknod-file + .. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE .. _CONFIGURE_IMFS_DISABLE_MKNOD_FILE: @@ -448,6 +480,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-mount + .. index:: CONFIGURE_IMFS_DISABLE_MOUNT .. _CONFIGURE_IMFS_DISABLE_MOUNT: @@ -473,6 +507,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-readdir + .. index:: CONFIGURE_IMFS_DISABLE_READDIR .. _CONFIGURE_IMFS_DISABLE_READDIR: @@ -498,6 +534,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-readlink + .. index:: CONFIGURE_IMFS_DISABLE_READLINK .. _CONFIGURE_IMFS_DISABLE_READLINK: @@ -522,6 +560,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-rename + .. index:: CONFIGURE_IMFS_DISABLE_RENAME .. _CONFIGURE_IMFS_DISABLE_RENAME: @@ -546,6 +586,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-rmnod + .. index:: CONFIGURE_IMFS_DISABLE_RMNOD .. _CONFIGURE_IMFS_DISABLE_RMNOD: @@ -570,6 +612,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-symlink + .. index:: CONFIGURE_IMFS_DISABLE_SYMLINK .. _CONFIGURE_IMFS_DISABLE_SYMLINK: @@ -594,6 +638,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-unmount + .. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT .. _CONFIGURE_IMFS_DISABLE_UNMOUNT: @@ -619,6 +665,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-disable-utime + .. index:: CONFIGURE_IMFS_DISABLE_UTIME .. _CONFIGURE_IMFS_DISABLE_UTIME: @@ -643,6 +691,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-enable-mkfifo + .. index:: CONFIGURE_IMFS_ENABLE_MKFIFO .. _CONFIGURE_IMFS_ENABLE_MKFIFO: @@ -667,6 +717,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/imfs-memfile-bytes-per-block + .. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK .. _CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK: @@ -718,6 +770,8 @@ NOTES: * when the block size is 512 bytes, the maximum file size is 1,082,195,456 bytes. +.. Generated from spec:/acfg/if/use-devfs-as-base-filesystem + .. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM .. _CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM: @@ -774,6 +828,8 @@ NOTES: comparable in functionality to the pseudo-filesystem name space provided before RTEMS release 4.5.0. +.. Generated from spec:/acfg/if/use-miniimfs-as-base-filesystem + .. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM .. _CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM: 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 ````. +.. 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 diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst index 8210da1..64a596f 100644 --- a/c-user/config/idle-task.rst +++ b/c-user/config/idle-task.rst @@ -15,11 +15,15 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-idle + Idle Task Configuration ======================= This section describes configuration options related to the idle tasks. +.. Generated from spec:/acfg/if/idle-task-body + .. index:: CONFIGURE_IDLE_TASK_BODY .. _CONFIGURE_IDLE_TASK_BODY: @@ -52,6 +56,8 @@ NOTES: IDLE threads can be used to initialize the application, see configuration option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`. +.. Generated from spec:/acfg/if/idle-task-init-appl + .. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION .. _CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION: @@ -98,6 +104,8 @@ NOTES: otherwise a compile time error in the configuration file will occur. +.. Generated from spec:/acfg/if/idle-task-stack-size + .. index:: CONFIGURE_IDLE_TASK_STACK_SIZE .. _CONFIGURE_IDLE_TASK_STACK_SIZE: diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst index aa35b1e..dac5cad 100644 --- a/c-user/config/mpci.rst +++ b/c-user/config/mpci.rst @@ -15,6 +15,8 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-mpci + Multiprocessing Configuration ============================= @@ -25,6 +27,8 @@ are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION` is defined. The multiprocessing (MPCI) support must not be confused with the SMP support. +.. Generated from spec:/acfg/if/mp-extra-server-stack + .. index:: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK .. _CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK: @@ -63,6 +67,8 @@ NOTES: This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. +.. Generated from spec:/acfg/if/mp-appl + .. index:: CONFIGURE_MP_APPLICATION .. _CONFIGURE_MP_APPLICATION: @@ -91,6 +97,8 @@ NOTES: build configuration option). Otherwise a compile time error in the configuration file will occur. +.. Generated from spec:/acfg/if/mp-max-global-objects + .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS .. _CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS: @@ -122,6 +130,8 @@ NOTES: This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. +.. Generated from spec:/acfg/if/mp-max-nodes + .. index:: CONFIGURE_MP_MAXIMUM_NODES .. _CONFIGURE_MP_MAXIMUM_NODES: @@ -150,6 +160,8 @@ NOTES: This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. +.. Generated from spec:/acfg/if/mp-max-proxies + .. index:: CONFIGURE_MP_MAXIMUM_PROXIES .. _CONFIGURE_MP_MAXIMUM_PROXIES: @@ -184,6 +196,8 @@ NOTES: This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. +.. Generated from spec:/acfg/if/mp-mpci-table-pointer + .. index:: CONFIGURE_MP_MPCI_TABLE_POINTER .. _CONFIGURE_MP_MPCI_TABLE_POINTER: @@ -216,6 +230,8 @@ NOTES: This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. +.. Generated from spec:/acfg/if/mp-node-number + .. index:: CONFIGURE_MP_NODE_NUMBER .. _CONFIGURE_MP_NODE_NUMBER: diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst index 6e91205..886f1e6 100644 --- a/c-user/config/posix-api.rst +++ b/c-user/config/posix-api.rst @@ -15,6 +15,8 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-posix + POSIX API Configuration ======================= @@ -23,6 +25,8 @@ POSIX API objects are available by default since RTEMS 5.1. The queued signals and timers are only available if RTEMS was built with the ``--enable-posix`` build configuration option. +.. Generated from spec:/acfg/if/max-posix-keys + .. index:: CONFIGURE_MAXIMUM_POSIX_KEYS .. _CONFIGURE_MAXIMUM_POSIX_KEYS: @@ -64,6 +68,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-posix-key-value-pairs + .. index:: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS .. _CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS: @@ -111,6 +117,8 @@ NOTES: A key value pair is created by :c:func:`pthread_setspecific` if the value is not `NULL `_, otherwise it is deleted. +.. Generated from spec:/acfg/if/max-posix-message-queues + .. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES .. _CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES: @@ -158,6 +166,8 @@ NOTES: store the messages of each message queue, see :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. +.. Generated from spec:/acfg/if/max-posix-queued-signals + .. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS .. _CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS: @@ -203,6 +213,8 @@ NOTES: Queued signals are only available if RTEMS was built with the ``--enable-posix`` build configuration option. +.. Generated from spec:/acfg/if/max-posix-semaphores + .. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES .. _CONFIGURE_MAXIMUM_POSIX_SEMAPHORES: @@ -253,6 +265,8 @@ NOTES: configuration option since the storage space for these semaphores is user-provided. +.. Generated from spec:/acfg/if/max-posix-shms + .. index:: CONFIGURE_MAXIMUM_POSIX_SHMS .. _CONFIGURE_MAXIMUM_POSIX_SHMS: @@ -298,6 +312,8 @@ NOTES: This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. +.. Generated from spec:/acfg/if/max-posix-threads + .. index:: CONFIGURE_MAXIMUM_POSIX_THREADS .. _CONFIGURE_MAXIMUM_POSIX_THREADS: @@ -348,6 +364,8 @@ NOTES: All POSIX threads have floating point enabled. +.. Generated from spec:/acfg/if/max-posix-timers + .. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS .. _CONFIGURE_MAXIMUM_POSIX_TIMERS: @@ -397,6 +415,8 @@ NOTES: Timers are only available if RTEMS was built with the ``--enable-posix`` build configuration option. +.. Generated from spec:/acfg/if/min-posix-thread-stack-size + .. index:: CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE .. index:: minimum POSIX thread stack size diff --git a/c-user/config/posix-init-thread.rst b/c-user/config/posix-init-thread.rst index deadbc6..08215e6 100644 --- a/c-user/config/posix-init-thread.rst +++ b/c-user/config/posix-init-thread.rst @@ -15,12 +15,16 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-posixinit + POSIX Initialization Thread Configuration ========================================= This section describes configuration options related to the POSIX initialization thread. +.. Generated from spec:/acfg/if/posix-init-thread-entry-point + .. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT .. _CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT: @@ -49,6 +53,8 @@ NOTES: The application shall provide the function referenced by this configuration option. +.. Generated from spec:/acfg/if/posix-init-thread-stack-size + .. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE .. _CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE: @@ -82,6 +88,8 @@ DESCRIPTION: NOTES: None. +.. Generated from spec:/acfg/if/posix-init-thread-table + .. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE .. _CONFIGURE_POSIX_INIT_THREAD_TABLE: diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst index 8c60a96..2916cf7 100644 --- a/c-user/config/scheduler-general.rst +++ b/c-user/config/scheduler-general.rst @@ -16,6 +16,8 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-schedgeneral + General Scheduler Configuration =============================== @@ -42,6 +44,8 @@ The pluggable scheduler interface also enables the user to provide their own scheduling algorithm. If you choose to do this, you must define multiple configuration option. +.. Generated from spec:/acfg/if/cbs-max-servers + .. index:: CONFIGURE_CBS_MAXIMUM_SERVERS .. _CONFIGURE_CBS_MAXIMUM_SERVERS: @@ -78,6 +82,8 @@ NOTES: This configuration option is only evaluated if the configuration option :ref:`CONFIGURE_SCHEDULER_CBS` is defined. +.. Generated from spec:/acfg/if/max-priority + .. index:: CONFIGURE_MAXIMUM_PRIORITY .. index:: maximum priority .. index:: number of priority levels @@ -136,6 +142,8 @@ NOTES: The default value is 255, because RTEMS shall support 256 priority levels to be compliant with various standards. These priorities range from 0 to 255. +.. Generated from spec:/acfg/if/scheduler-assignments + .. index:: CONFIGURE_SCHEDULER_ASSIGNMENTS .. _CONFIGURE_SCHEDULER_ASSIGNMENTS: @@ -177,6 +185,8 @@ NOTES: This is an advanced configuration option, see :ref:`ConfigurationSchedulersClustered`. +.. Generated from spec:/acfg/if/scheduler-cbs + .. index:: CONFIGURE_SCHEDULER_CBS .. _CONFIGURE_SCHEDULER_CBS: @@ -206,6 +216,8 @@ NOTES: In case no explicit :ref:`ConfigurationSchedulersClustered` is present, then it is used as the scheduler for exactly one processor. +.. Generated from spec:/acfg/if/scheduler-edf + .. index:: CONFIGURE_SCHEDULER_EDF .. _CONFIGURE_SCHEDULER_EDF: @@ -235,6 +247,8 @@ NOTES: In case no explicit :ref:`ConfigurationSchedulersClustered` is present, then it is used as the scheduler for exactly one processor. +.. Generated from spec:/acfg/if/scheduler-edf-smp + .. index:: CONFIGURE_SCHEDULER_EDF_SMP .. _CONFIGURE_SCHEDULER_EDF_SMP: @@ -271,6 +285,8 @@ NOTES: :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is greater than one. +.. Generated from spec:/acfg/if/scheduler-name + .. index:: CONFIGURE_SCHEDULER_NAME .. _CONFIGURE_SCHEDULER_NAME: @@ -319,6 +335,8 @@ NOTES: Use :c:func:`rtems_build_name` to define the scheduler name. +.. Generated from spec:/acfg/if/scheduler-priority + .. index:: CONFIGURE_SCHEDULER_PRIORITY .. _CONFIGURE_SCHEDULER_PRIORITY: @@ -355,6 +373,8 @@ NOTES: The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. +.. Generated from spec:/acfg/if/scheduler-priority-affinity-smp + .. index:: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP .. _CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP: @@ -390,6 +410,8 @@ NOTES: The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. +.. Generated from spec:/acfg/if/scheduler-priority-smp + .. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP .. _CONFIGURE_SCHEDULER_PRIORITY_SMP: @@ -425,6 +447,8 @@ NOTES: The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. +.. Generated from spec:/acfg/if/scheduler-simple + .. index:: CONFIGURE_SCHEDULER_SIMPLE .. _CONFIGURE_SCHEDULER_SIMPLE: @@ -454,6 +478,8 @@ NOTES: In case no explicit :ref:`ConfigurationSchedulersClustered` is present, then it is used as the scheduler for exactly one processor. +.. Generated from spec:/acfg/if/scheduler-simple-smp + .. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP .. _CONFIGURE_SCHEDULER_SIMPLE_SMP: @@ -487,6 +513,8 @@ NOTES: In case no explicit :ref:`ConfigurationSchedulersClustered` is present, then it is used as the scheduler for up to 32 processors. +.. Generated from spec:/acfg/if/scheduler-strong-apa + .. index:: CONFIGURE_SCHEDULER_STRONG_APA .. _CONFIGURE_SCHEDULER_STRONG_APA: @@ -517,6 +545,8 @@ NOTES: This scheduler algorithm is not correctly implemented. Do not use it. +.. Generated from spec:/acfg/if/scheduler-user + .. index:: CONFIGURE_SCHEDULER_USER .. _CONFIGURE_SCHEDULER_USER: diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst index a567477..7dd95bb 100644 --- a/c-user/config/task-stack-alloc.rst +++ b/c-user/config/task-stack-alloc.rst @@ -15,6 +15,8 @@ .. .. https://docs.rtems.org/branches/master/eng/req/howto.html +.. Generated from spec:/acfg/if/group-stackalloc + Task Stack Allocator Configuration ================================== @@ -24,6 +26,8 @@ and deallocation methods for task stacks. This can be used to place task stacks in special areas of memory or to utilize a Memory Management Unit so that stack overflows are detected in hardware. +.. Generated from spec:/acfg/if/task-stack-allocator + .. index:: CONFIGURE_TASK_STACK_ALLOCATOR .. index:: task stack allocator @@ -59,6 +63,8 @@ NOTES: * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` +.. Generated from spec:/acfg/if/task-stack-no-workspace + .. index:: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE .. _CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE: @@ -84,6 +90,8 @@ NOTES: This configuration option may be used if a custom task stack allocator is configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. +.. Generated from spec:/acfg/if/task-stack-allocator-init + .. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT .. _CONFIGURE_TASK_STACK_ALLOCATOR_INIT: @@ -118,6 +126,8 @@ NOTES: * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` +.. Generated from spec:/acfg/if/task-stack-deallocator + .. index:: CONFIGURE_TASK_STACK_DEALLOCATOR .. index:: task stack deallocator @@ -153,6 +163,8 @@ NOTES: * ``CONFIGURE_TASK_STACK_DEALLOCATOR`` +.. Generated from spec:/acfg/if/task-stack-from-alloc + .. index:: CONFIGURE_TASK_STACK_FROM_ALLOCATOR .. index:: task stack allocator -- cgit v1.2.3