summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
committerChris Johns <chrisj@rtems.org>2017-11-13 13:25:18 +1100
commit33849946ff6022c26722ec71248fd76aa55de4ef (patch)
treef082f683008e92f0894d8ac36bc4c83d4860bd37
parentUse '.. toctree::' and not '.. include::' in the User Manual. (diff)
downloadrtems-docs-33849946ff6022c26722ec71248fd76aa55de4ef.tar.bz2
Clean up sphinx warnings.
- Fix minor formatting issues. - Fix reference the gloassary TLS using ':term:'. - Make sure nothing is between an anchor and the heading where ':ref:' references the anchor. This meant moving all the recently added '.. index::' entries. Update #3232. Update #3229.
-rw-r--r--c-user/ada_support.rst3
-rw-r--r--c-user/board_support_packages.rst6
-rw-r--r--c-user/chains.rst4
-rw-r--r--c-user/clock_manager.rst4
-rw-r--r--c-user/configuring_a_system.rst402
-rw-r--r--c-user/constant_bandwidth_server.rst44
-rw-r--r--c-user/cpu_usage_statistics.rst6
-rw-r--r--c-user/directive_status_codes.rst3
-rw-r--r--c-user/dual_ports_memory_manager.rst15
-rw-r--r--c-user/event_manager.rst6
-rw-r--r--c-user/fatal_error.rst24
-rw-r--r--c-user/initialization.rst5
-rw-r--r--c-user/interrupt_manager.rst36
-rw-r--r--c-user/io_manager.rst30
-rw-r--r--c-user/key_concepts.rst15
-rw-r--r--c-user/linker_sets.rst63
-rw-r--r--c-user/message_manager.rst27
-rw-r--r--c-user/multiprocessing.rst3
-rw-r--r--c-user/object_services.rst54
-rw-r--r--c-user/partition_manager.rst15
-rw-r--r--c-user/rate_monotonic_manager.rst41
-rw-r--r--c-user/region_manager.rst24
-rw-r--r--c-user/semaphore_manager.rst21
-rw-r--r--c-user/signal_manager.rst6
-rw-r--r--c-user/symmetric_multiprocessing_services.rst6
-rw-r--r--c-user/task_manager.rst63
-rw-r--r--c-user/timer_manager.rst30
-rw-r--r--c-user/timespec_helpers.rst42
-rw-r--r--c-user/user_extensions.rst12
-rw-r--r--user/additional/index.rst34
-rw-r--r--user/installation/prefixes-sandboxing.rst2
-rw-r--r--user/start/index.rst6
-rw-r--r--user/tools/index.rst1
-rw-r--r--user/tools/simulation.rst13
-rw-r--r--user/tools/tester.rst70
35 files changed, 708 insertions, 428 deletions
diff --git a/c-user/ada_support.rst b/c-user/ada_support.rst
index ba7b5b5..7353e8a 100644
--- a/c-user/ada_support.rst
+++ b/c-user/ada_support.rst
@@ -4,9 +4,8 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-.. _ada_support
-
.. index:: Ada
+.. _ada_support:
Ada Support
************
diff --git a/c-user/board_support_packages.rst b/c-user/board_support_packages.rst
index 5d3153f..333efd5 100644
--- a/c-user/board_support_packages.rst
+++ b/c-user/board_support_packages.rst
@@ -4,13 +4,13 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-Board Support Packages
-**********************
-
.. index:: Board Support Packages
.. index:: BSPs
.. index:: BSP, definition
+Board Support Packages
+**********************
+
Introduction
============
diff --git a/c-user/chains.rst b/c-user/chains.rst
index 73e7980..0abcd2b 100644
--- a/c-user/chains.rst
+++ b/c-user/chains.rst
@@ -3,11 +3,11 @@
.. COMMENT: Copyright 2014 Gedare Bloom.
.. COMMENT: All rights reserved.
+.. index:: chains
+
Chains
******
-.. index:: chains
-
Introduction
============
diff --git a/c-user/clock_manager.rst b/c-user/clock_manager.rst
index 4a7ee84..3d41064 100644
--- a/c-user/clock_manager.rst
+++ b/c-user/clock_manager.rst
@@ -4,11 +4,11 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. index:: clock
+
Clock Manager
*************
-.. index:: clock
-
Introduction
============
diff --git a/c-user/configuring_a_system.rst b/c-user/configuring_a_system.rst
index dd1ddd8..96f4987 100644
--- a/c-user/configuring_a_system.rst
+++ b/c-user/configuring_a_system.rst
@@ -4,9 +4,8 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-.. _Configuring a System:
-
.. index:: configuring a system
+.. _Configuring a System:
Configuring a System
********************
@@ -442,9 +441,10 @@ responsible for enabling unlimited objects and specifying the allocation size.
.. COMMENT: === CONFIGURE_UNLIMITED_OBJECTS ===
-.. _Enable Unlimited Object Instances:
.. index:: CONFIGURE_UNLIMITED_OBJECTS
+.. _Enable Unlimited Object Instances:
+
Enable Unlimited Object Instances
---------------------------------
@@ -517,9 +517,10 @@ supported by ``<rtems/confdefs.h>``.
.. COMMENT: === CONFIGURE_MAXIMUM_TASKS ===
-.. _Specify Maximum Classic API Tasks:
.. index:: CONFIGURE_MAXIMUM_TASKS
+.. _Specify Maximum Classic API Tasks:
+
Specify Maximum Classic API Tasks
---------------------------------
@@ -562,9 +563,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_TIMERS ===
-.. _Specify Maximum Classic API Timers:
.. index:: CONFIGURE_MAXIMUM_TIMERS
+.. _Specify Maximum Classic API Timers:
+
Specify Maximum Classic API Timers
----------------------------------
@@ -589,9 +591,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_SEMAPHORES ===
-.. _Specify Maximum Classic API Semaphores:
.. index:: CONFIGURE_MAXIMUM_SEMAPHORES
+.. _Specify Maximum Classic API Semaphores:
+
Specify Maximum Classic API Semaphores
--------------------------------------
@@ -616,9 +619,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_MRSP_SEMAPHORES ===
-.. _Specify Maximum Classic API Semaphores usable with MrsP:
.. index:: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
+.. _Specify Maximum Classic API Semaphores usable with MrsP:
+
Specify Maximum Classic API Semaphores usable with MrsP
-------------------------------------------------------
@@ -645,9 +649,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_MESSAGE_QUEUES ===
-.. _Specify Maximum Classic API Message Queues:
.. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
+.. _Specify Maximum Classic API Message Queues:
+
Specify Maximum Classic API Message Queues
------------------------------------------
@@ -672,9 +677,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_BARRIERS ===
-.. _Specify Maximum Classic API Barriers:
.. index:: CONFIGURE_MAXIMUM_BARRIERS
+.. _Specify Maximum Classic API Barriers:
+
Specify Maximum Classic API Barriers
------------------------------------
@@ -699,9 +705,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_PERIODS ===
-.. _Specify Maximum Classic API Periods:
.. index:: CONFIGURE_MAXIMUM_PERIODS
+.. _Specify Maximum Classic API Periods:
+
Specify Maximum Classic API Periods
-----------------------------------
@@ -726,9 +733,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_PARTITIONS ===
-.. _Specify Maximum Classic API Partitions:
.. index:: CONFIGURE_MAXIMUM_PARTITIONS
+.. _Specify Maximum Classic API Partitions:
+
Specify Maximum Classic API Partitions
--------------------------------------
@@ -753,9 +761,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_REGIONS ===
-.. _Specify Maximum Classic API Regions:
.. index:: CONFIGURE_MAXIMUM_REGIONS
+.. _Specify Maximum Classic API Regions:
+
Specify Maximum Classic API Regions
-----------------------------------
@@ -780,9 +789,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_PORTS ===
-.. _Specify Maximum Classic API Ports:
.. index:: CONFIGURE_MAXIMUM_PORTS
+.. _Specify Maximum Classic API Ports:
+
Specify Maximum Classic API Ports
---------------------------------
@@ -807,9 +817,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_USER_EXTENSIONS ===
-.. _Specify Maximum Classic API User Extensions:
.. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
+.. _Specify Maximum Classic API User Extensions:
+
Specify Maximum Classic API User Extensions
-------------------------------------------
@@ -843,9 +854,10 @@ The following parameters control the generation of that table.
.. COMMENT: === CONFIGURE_RTEMS_INIT_TASKS_TABLE ===
-.. _Instantiate Classic API Initialization Task Table:
.. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
+.. _Instantiate Classic API Initialization Task Table:
+
Instantiate Classic API Initialization Task Table
-------------------------------------------------
@@ -880,9 +892,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_ENTRY_POINT ===
-.. _Specifying Classic API Initialization Task Entry Point:
.. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
+.. _Specifying Classic API Initialization Task Entry Point:
+
Specifying Classic API Initialization Task Entry Point
------------------------------------------------------
@@ -909,9 +922,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_NAME ===
-.. _Specifying Classic API Initialization Task Name:
.. index:: CONFIGURE_INIT_TASK_NAME
+.. _Specifying Classic API Initialization Task Name:
+
Specifying Classic API Initialization Task Name
-----------------------------------------------
@@ -936,9 +950,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_STACK_SIZE ===
-.. _Specifying Classic API Initialization Task Stack Size:
.. index:: CONFIGURE_INIT_TASK_STACK_SIZE
+.. _Specifying Classic API Initialization Task Stack Size:
+
Specifying Classic API Initialization Task Stack Size
-----------------------------------------------------
@@ -966,9 +981,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_PRIORITY ===
-.. _Specifying Classic API Initialization Task Priority:
.. index:: CONFIGURE_INIT_TASK_PRIORITY
+.. _Specifying Classic API Initialization Task Priority:
+
Specifying Classic API Initialization Task Priority
---------------------------------------------------
@@ -993,9 +1009,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_ATTRIBUTES ===
-.. _Specifying Classic API Initialization Task Attributes:
.. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
+.. _Specifying Classic API Initialization Task Attributes:
+
Specifying Classic API Initialization Task Attributes
-----------------------------------------------------
@@ -1020,9 +1037,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_INITIAL_MODES ===
-.. _Specifying Classic API Initialization Task Modes:
.. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
+.. _Specifying Classic API Initialization Task Modes:
+
Specifying Classic API Initialization Task Modes
------------------------------------------------
@@ -1048,9 +1066,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INIT_TASK_ARGUMENTS ===
-.. _Specifying Classic API Initialization Task Arguments:
.. index:: CONFIGURE_INIT_TASK_ARGUMENTS
+.. _Specifying Classic API Initialization Task Arguments:
+
Specifying Classic API Initialization Task Arguments
----------------------------------------------------
@@ -1075,9 +1094,10 @@ NOTES:
.. COMMENT: === CONFIGURE_HAS_OWN_INIT_TASK_TABLE ===
-.. _Not Using Generated Initialization Tasks Table:
.. index:: CONFIGURE_HAS_OWN_INIT_TASK_TABLE
+.. _Not Using Generated Initialization Tasks Table:
+
Not Using Generated Initialization Tasks Table
----------------------------------------------
@@ -1113,9 +1133,10 @@ time using the ``--enable-posix`` option.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_THREADS ===
-.. _Specify Maximum POSIX API Threads:
.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
+.. _Specify Maximum POSIX API Threads:
+
Specify Maximum POSIX API Threads
---------------------------------
@@ -1153,9 +1174,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_KEYS ===
-.. _Specify Maximum POSIX API Keys:
.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
+.. _Specify Maximum POSIX API Keys:
+
Specify Maximum POSIX API Keys
------------------------------
@@ -1182,9 +1204,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_TIMERS ===
-.. _Specify Maximum POSIX API Timers:
.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
+.. _Specify Maximum POSIX API Timers:
+
Specify Maximum POSIX API Timers
--------------------------------
@@ -1209,9 +1232,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS ===
-.. _Specify Maximum POSIX API Queued Signals:
.. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
+.. _Specify Maximum POSIX API Queued Signals:
+
Specify Maximum POSIX API Queued Signals
----------------------------------------
@@ -1236,9 +1260,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES ===
-.. _Specify Maximum POSIX API Message Queues:
.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
+.. _Specify Maximum POSIX API Message Queues:
+
Specify Maximum POSIX API Message Queues
----------------------------------------
@@ -1263,9 +1288,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_SEMAPHORES ===
-.. _Specify Maximum POSIX API Semaphores:
.. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
+.. _Specify Maximum POSIX API Semaphores:
+
Specify Maximum POSIX API Named Semaphores
------------------------------------------
@@ -1302,9 +1328,10 @@ a single entry. The following parameters control the generation of that table.
.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_TABLE ===
-.. _Instantiate POSIX API Initialization Thread Table:
.. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
+.. _Instantiate POSIX API Initialization Thread Table:
+
Instantiate POSIX API Initialization Thread Table
-------------------------------------------------
@@ -1341,9 +1368,10 @@ NOTES:
.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT ===
-.. _Specifying POSIX API Initialization Thread Entry Point:
.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
+.. _Specifying POSIX API Initialization Thread Entry Point:
+
Specifying POSIX API Initialization Thread Entry Point
------------------------------------------------------
@@ -1370,9 +1398,10 @@ NOTES:
.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE ===
-.. _Specifying POSIX API Initialization Thread Stack Size:
.. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
+.. _Specifying POSIX API Initialization Thread Stack Size:
+
Specifying POSIX API Initialization Thread Stack Size
-----------------------------------------------------
@@ -1401,9 +1430,10 @@ NOTES:
.. COMMENT: === CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE ===
-.. _Not Using Generated POSIX Initialization Threads Table:
.. index:: CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
+.. _Not Using Generated POSIX Initialization Threads Table:
+
Not Using Generated POSIX Initialization Threads Table
------------------------------------------------------
@@ -1438,13 +1468,14 @@ This section defines the general system configuration parameters supported by
.. COMMENT: === CONFIGURE_UNIFIED_WORK_AREAS ===
-.. _Separate or Unified Work Areas:
.. index:: CONFIGURE_UNIFIED_WORK_AREAS
.. index:: unified work areas
.. index:: separate work areas
.. index:: RTEMS Workspace
.. index:: C Program Heap
+.. _Separate or Unified Work Areas:
+
Separate or Unified Work Areas
------------------------------
@@ -1481,9 +1512,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_PROCESSORS ===
-.. _CONFIGURE_MAXIMUM_PROCESSORS:
.. index:: CONFIGURE_MAXIMUM_PROCESSORS
+.. _CONFIGURE_MAXIMUM_PROCESSORS:
+
Specify Maximum Processors
----------------------------------------
@@ -1514,10 +1546,11 @@ NOTES:
.. COMMENT: === CONFIGURE_MICROSECONDS_PER_TICK ===
-.. _CONFIGURE_MICROSECONDS_PER_TICK:
.. index:: CONFIGURE_MICROSECONDS_PER_TICK
.. index:: tick quantum
+.. _CONFIGURE_MICROSECONDS_PER_TICK:
+
Length of Each Clock Tick
-------------------------
@@ -1561,10 +1594,11 @@ NOTES:
.. COMMENT: === CONFIGURE_TICKS_PER_TIMESLICE ===
-.. _Specifying Timeslicing Quantum:
.. index:: CONFIGURE_TICKS_PER_TIMESLICE
.. index:: ticks per timeslice
+.. _Specifying Timeslicing Quantum:
+
Specifying Timeslicing Quantum
------------------------------
@@ -1590,11 +1624,12 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_PRIORITY ===
-.. _Specifying the Number of Thread Priority Levels:
.. index:: CONFIGURE_MAXIMUM_PRIORITY
.. index:: maximum priority
.. index:: number of priority levels
+.. _Specifying the Number of Thread Priority Levels:
+
Specifying the Number of Thread Priority Levels
-----------------------------------------------
@@ -1637,10 +1672,11 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_THREAD_NAME_SIZE ===
-.. _CONFIGURE_MAXIMUM_THREAD_NAME_SIZE:
.. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE
.. index:: maximum thread name size
+.. _CONFIGURE_MAXIMUM_THREAD_NAME_SIZE:
+
Specifying the Maximum Thread Name Size
---------------------------------------
@@ -1668,10 +1704,11 @@ NOTE:
.. COMMENT: === CONFIGURE_MINIMUM_TASK_STACK_SIZE ===
-.. _Specifying the Minimum Task Size:
.. index:: CONFIGURE_MINIMUM_TASK_STACK_SIZE
.. index:: minimum task stack size
+.. _Specifying the Minimum Task Size:
+
Specifying the Minimum Task Size
--------------------------------
@@ -1707,10 +1744,11 @@ NOTES:
.. COMMENT: === CONFIGURE_INTERRUPT_STACK_SIZE ===
-.. _Configuring the Size of the Interrupt Stack:
.. index:: CONFIGURE_INTERRUPT_STACK_SIZE
.. index:: interrupt stack size
+.. _Configuring the Size of the Interrupt Stack:
+
Configuring the Size of the Interrupt Stack
-------------------------------------------
@@ -1742,10 +1780,11 @@ NOTES:
.. COMMENT: === CONFIGURE_EXTRA_TASK_STACKS ===
-.. _Reserve Task/Thread Stack Memory Above Minimum:
.. index:: CONFIGURE_EXTRA_TASK_STACKS
.. index:: memory for task tasks
+.. _Reserve Task/Thread Stack Memory Above Minimum:
+
Reserve Task/Thread Stack Memory Above Minimum
----------------------------------------------
@@ -1773,13 +1812,14 @@ NOTES:
.. COMMENT: === CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY ===
-.. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
.. index:: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
.. index:: clear C Program Heap
.. index:: clear RTEMS Workspace
.. index:: zero C Program Heap
.. index:: zero RTEMS Workspace
+.. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
+
Automatically Zeroing the RTEMS Workspace and C Program Heap
------------------------------------------------------------
@@ -1807,9 +1847,10 @@ NOTES:
.. COMMENT: === CONFIGURE_STACK_CHECKER_ENABLED ===
-.. _Enable The Task Stack Usage Checker:
.. index:: CONFIGURE_STACK_CHECKER_ENABLED
+.. _Enable The Task Stack Usage Checker:
+
Enable The Task Stack Usage Checker
-----------------------------------
@@ -1837,9 +1878,10 @@ NOTES:
.. COMMENT: === CONFIGURE_INITIAL_EXTENSIONS ===
-.. _CONFIGURE_INITIAL_EXTENSIONS:
.. index:: CONFIGURE_INITIAL_EXTENSIONS
+.. _CONFIGURE_INITIAL_EXTENSIONS:
+
Specify Application Specific User Extensions
--------------------------------------------
@@ -1875,9 +1917,10 @@ overflows are detected in hardware.
.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR_INIT ===
-.. _Custom Task Stack Allocator Initialization:
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
+.. _Custom Task Stack Allocator Initialization:
+
Custom Task Stack Allocator Initialization
------------------------------------------
@@ -1910,10 +1953,11 @@ NOTES:
.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR ===
-.. _Custom Task Stack Allocator:
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR
.. index:: task stack allocator
+.. _Custom Task Stack Allocator:
+
Custom Task Stack Allocator
---------------------------
@@ -1945,10 +1989,11 @@ NOTES:
.. COMMENT: === CONFIGURE_TASK_STACK_DEALLOCATOR ===
-.. _Custom Task Stack Deallocator:
.. index:: CONFIGURE_TASK_STACK_DEALLOCATOR
.. index:: task stack deallocator
+.. _Custom Task Stack Deallocator:
+
Custom Task Stack Deallocator
-----------------------------
@@ -1988,10 +2033,11 @@ amount of memory reserved for Classic API Message Buffers.
.. COMMENT: === CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE ===
-.. _Calculate Memory for a Single Classic Message API Message Queue:
.. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
.. index:: memory for a single message queue's buffers
+.. _Calculate Memory for a Single Classic Message API Message Queue:
+
Calculate Memory for a Single Classic Message API Message Queue
---------------------------------------------------------------
@@ -2028,10 +2074,11 @@ NOTES:
.. COMMENT: === CONFIGURE_MESSAGE_BUFFER_MEMORY ===
-.. _Reserve Memory for All Classic Message API Message Queues:
.. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY
.. index:: configure message queue buffer memory
+.. _Reserve Memory for All Classic Message API Message Queues:
+
Reserve Memory for All Classic Message API Message Queues
---------------------------------------------------------
@@ -2083,9 +2130,10 @@ work-arounds when the memory estimated by ``<rtems/confdefs.h>`` is incorrect.
.. COMMENT: === CONFIGURE_MEMORY_OVERHEAD ===
-.. _Specify Memory Overhead:
.. index:: CONFIGURE_MEMORY_OVERHEAD
+.. _Specify Memory Overhead:
+
Specify Memory Overhead
-----------------------
@@ -2113,9 +2161,10 @@ NOTES:
.. COMMENT: === CONFIGURE_HAS_OWN_CONFIGURATION_TABLE ===
-.. _Do Not Generate Configuration Information:
.. index:: CONFIGURE_HAS_OWN_CONFIGURATION_TABLE
+.. _Do Not Generate Configuration Information:
+
Do Not Generate Configuration Information
-----------------------------------------
@@ -2148,10 +2197,11 @@ parameters supported by ``<rtems/confdefs.h>``.
.. COMMENT: === CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS ===
-.. _Specify Maximum Number of File Descriptors:
.. index:: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
.. index:: maximum file descriptors
+.. _Specify Maximum Number of File Descriptors:
+
Specify Maximum Number of File Descriptors
------------------------------------------
@@ -2179,9 +2229,10 @@ NOTES:
.. COMMENT: === CONFIGURE_TERMIOS_DISABLED ===
-.. _Disable POSIX Termios Support:
.. index:: CONFIGURE_TERMIOS_DISABLED
+.. _Disable POSIX Termios Support:
+
Disable POSIX Termios Support
-----------------------------
@@ -2209,9 +2260,10 @@ NOTES:
.. COMMENT: === CONFIGURE_NUMBER_OF_TERMIOS_PORTS ===
-.. _Specify Maximum Termios Ports:
.. index:: CONFIGURE_NUMBER_OF_TERMIOS_PORTS
+.. _Specify Maximum Termios Ports:
+
Specify Maximum Termios Ports
-----------------------------
@@ -2247,9 +2299,10 @@ This section defines File System related configuration parameters.
.. COMMENT: === CONFIGURE_HAS_OWN_MOUNT_TABLE ===
-.. _Providing Application Specific Mount Table:
.. index:: CONFIGURE_HAS_OWN_MOUNT_TABLE
+.. _Providing Application Specific Mount Table:
+
Providing Application Specific Mount Table
------------------------------------------
@@ -2281,9 +2334,10 @@ NOTES:
.. COMMENT: === CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM ===
-.. _Configure devFS as Root File System:
.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
+.. _Configure devFS as Root File System:
+
Configure devFS as Root File System
-----------------------------------
@@ -2313,9 +2367,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_DEVICES ===
-.. _Specifying Maximum Devices for devFS:
.. index:: CONFIGURE_MAXIMUM_DEVICES
+.. _Specifying Maximum Devices for devFS:
+
Specifying Maximum Devices for devFS
------------------------------------
@@ -2344,9 +2399,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_DISABLE_FILESYSTEM ===
-.. _Disable File System Support:
.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
+.. _Disable File System Support:
+
Disable File System Support
---------------------------
@@ -2373,9 +2429,10 @@ NOTES:
.. COMMENT: === CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM ===
-.. _Use a Root IMFS with a Minimalistic Feature Set:
.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
+.. _Use a Root IMFS with a Minimalistic Feature Set:
+
Use a Root IMFS with a Minimalistic Feature Set
-----------------------------------------------
@@ -2413,9 +2470,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK ===
-.. _Specify Block Size for IMFS:
.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
+.. _Specify Block Size for IMFS:
+
Specify Block Size for IMFS
---------------------------
@@ -2463,9 +2521,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHOWN ===
-.. _Disable Change Owner Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
+.. _Disable Change Owner Support of Root IMFS:
+
Disable Change Owner Support of Root IMFS
-----------------------------------------
@@ -2487,9 +2546,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHMOD ===
-.. _Disable Change Mode Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
+.. _Disable Change Mode Support of Root IMFS:
+
Disable Change Mode Support of Root IMFS
----------------------------------------
@@ -2511,9 +2571,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_UTIME ===
-.. _Disable Change Times Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_UTIME
+.. _Disable Change Times Support of Root IMFS:
+
Disable Change Times Support of Root IMFS
-----------------------------------------
@@ -2535,9 +2596,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_LINK ===
-.. _Disable Create Hard Link Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_LINK
+.. _Disable Create Hard Link Support of Root IMFS:
+
Disable Create Hard Link Support of Root IMFS
---------------------------------------------
@@ -2559,9 +2621,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_SYMLINK ===
-.. _Disable Create Symbolic Link Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
+.. _Disable Create Symbolic Link Support of Root IMFS:
+
Disable Create Symbolic Link Support of Root IMFS
-------------------------------------------------
@@ -2583,9 +2646,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_READLINK ===
-.. _Disable Read Symbolic Link Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_READLINK
+.. _Disable Read Symbolic Link Support of Root IMFS:
+
Disable Read Symbolic Link Support of Root IMFS
-----------------------------------------------
@@ -2607,9 +2671,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_RENAME ===
-.. _Disable Rename Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_RENAME
+.. _Disable Rename Support of Root IMFS:
+
Disable Rename Support of Root IMFS
-----------------------------------
@@ -2631,9 +2696,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_READDIR ===
-.. _Disable Directory Read Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_READDIR
+.. _Disable Directory Read Support of Root IMFS:
+
Disable Directory Read Support of Root IMFS
-------------------------------------------
@@ -2656,9 +2722,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_MOUNT ===
-.. _Disable Mount Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
+.. _Disable Mount Support of Root IMFS:
+
Disable Mount Support of Root IMFS
----------------------------------
@@ -2680,9 +2747,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_UNMOUNT ===
-.. _Disable Unmount Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
+.. _Disable Unmount Support of Root IMFS:
+
Disable Unmount Support of Root IMFS
------------------------------------
@@ -2704,9 +2772,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD ===
-.. _Disable Make Nodes Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
+.. _Disable Make Nodes Support of Root IMFS:
+
Disable Make Nodes Support of Root IMFS
---------------------------------------
@@ -2728,9 +2797,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD_FILE ===
-.. _Disable Make Files Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
+.. _Disable Make Files Support of Root IMFS:
+
Disable Make Files Support of Root IMFS
---------------------------------------
@@ -2752,9 +2822,10 @@ DESCRIPTION:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_RMNOD ===
-.. _Disable Remove Nodes Support of Root IMFS:
.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
+.. _Disable Remove Nodes Support of Root IMFS:
+
Disable Remove Nodes Support of Root IMFS
-----------------------------------------
@@ -2784,9 +2855,10 @@ parameters.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_LIBBLOCK ===
-.. _Enable Block Device Cache:
.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
+.. _Enable Block Device Cache:
+
Enable Block Device Cache
-------------------------
@@ -2812,9 +2884,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_CACHE_MEMORY_SIZE ===
-.. _Size of the Cache Memory:
.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
+.. _Size of the Cache Memory:
+
Size of the Cache Memory
------------------------
@@ -2838,9 +2911,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MIN_SIZE ===
-.. _Minimum Size of a Buffer:
.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
+.. _Minimum Size of a Buffer:
+
Minimum Size of a Buffer
------------------------
@@ -2864,9 +2938,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MAX_SIZE ===
-.. _Maximum Size of a Buffer:
.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+.. _Maximum Size of a Buffer:
+
Maximum Size of a Buffer
------------------------
@@ -2890,9 +2965,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SWAPOUT_SWAP_PERIOD ===
-.. _Swapout Task Swap Period:
.. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
+.. _Swapout Task Swap Period:
+
Swapout Task Swap Period
------------------------
@@ -2916,9 +2992,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SWAPOUT_BLOCK_HOLD ===
-.. _Swapout Task Maximum Block Hold Time:
.. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
+.. _Swapout Task Maximum Block Hold Time:
+
Swapout Task Maximum Block Hold Time
------------------------------------
@@ -2942,9 +3019,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SWAPOUT_TASK_PRIORITY ===
-.. _Swapout Task Priority:
.. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
+.. _Swapout Task Priority:
+
Swapout Task Priority
---------------------
@@ -2968,9 +3046,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS ===
-.. _Maximum Blocks per Read-Ahead Request:
.. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
+.. _Maximum Blocks per Read-Ahead Request:
+
Maximum Blocks per Read-Ahead Request
-------------------------------------
@@ -2996,9 +3075,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_MAX_WRITE_BLOCKS ===
-.. _Maximum Blocks per Write Request:
.. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
+.. _Maximum Blocks per Write Request:
+
Maximum Blocks per Write Request
--------------------------------
@@ -3022,9 +3102,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_TASK_STACK_SIZE ===
-.. _Task Stack Size of the Block Device Cache Tasks:
.. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
+.. _Task Stack Size of the Block Device Cache Tasks:
+
Task Stack Size of the Block Device Cache Tasks
-----------------------------------------------
@@ -3048,9 +3129,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY ===
-.. _Read-Ahead Task Priority:
.. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
+.. _Read-Ahead Task Priority:
+
Read-Ahead Task Priority
------------------------
@@ -3074,9 +3156,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASKS ===
-.. _Swapout Worker Task Count:
.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
+.. _Swapout Worker Task Count:
+
Swapout Worker Task Count
-------------------------
@@ -3100,9 +3183,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY ===
-.. _Swapout Worker Task Priority:
.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
+.. _Swapout Worker Task Priority:
+
Swapout Worker Task Priority
----------------------------
@@ -3135,9 +3219,10 @@ This section describes BSP specific configuration settings used by
.. COMMENT: === Disable BSP Settings ===
-.. _Disable BSP Configuration Settings:
.. index:: CONFIGURE_DISABLE_BSP_SETTINGS
+.. _Disable BSP Configuration Settings:
+
Disable BSP Configuration Settings
----------------------------------
@@ -3162,9 +3247,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK ===
-.. _Specify BSP Supports sbrk():
.. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
+.. _Specify BSP Supports sbrk():
+
Specify BSP Supports sbrk()
---------------------------
@@ -3194,9 +3280,10 @@ NOTES:
.. COMMENT: === BSP_IDLE_TASK_BODY ===
-.. _Specify BSP Specific Idle Task:
.. index:: BSP_IDLE_TASK_BODY
+.. _Specify BSP Specific Idle Task:
+
Specify BSP Specific Idle Task
------------------------------
@@ -3224,9 +3311,10 @@ NOTES:
.. COMMENT: === BSP_IDLE_TASK_STACK_SIZE ===
-.. _Specify BSP Suggested Value for IDLE Task Stack Size:
.. index:: BSP_IDLE_TASK_STACK_SIZE
+.. _Specify BSP Suggested Value for IDLE Task Stack Size:
+
Specify BSP Suggested Value for IDLE Task Stack Size
----------------------------------------------------
@@ -3262,9 +3350,10 @@ NOTES:
.. COMMENT: === BSP_INITIAL_EXTENSION ===
-.. _Specify BSP Specific User Extensions:
.. index:: BSP_INITIAL_EXTENSION
+.. _Specify BSP Specific User Extensions:
+
Specify BSP Specific User Extensions
------------------------------------
@@ -3290,9 +3379,10 @@ NOTES:
.. COMMENT: === BSP_INTERRUPT_STACK_SIZE ===
-.. _Specifying BSP Specific Interrupt Stack Size:
.. index:: BSP_INTERRUPT_STACK_SIZE
+.. _Specifying BSP Specific Interrupt Stack Size:
+
Specifying BSP Specific Interrupt Stack Size
--------------------------------------------
@@ -3318,9 +3408,10 @@ NOTES:
.. COMMENT: === BSP_MAXIMUM_DEVICES ===
-.. _Specifying BSP Specific Maximum Devices:
.. index:: BSP_MAXIMUM_DEVICES
+.. _Specifying BSP Specific Maximum Devices:
+
Specifying BSP Specific Maximum Devices
---------------------------------------
@@ -3349,9 +3440,10 @@ NOTES:
.. COMMENT: === BSP_ZERO_WORKSPACE_AUTOMATICALLY ===
-.. _BSP Recommends RTEMS Workspace be Cleared:
.. index:: BSP_ZERO_WORKSPACE_AUTOMATICALLY
+.. _BSP Recommends RTEMS Workspace be Cleared:
+
BSP Recommends RTEMS Workspace be Cleared
-----------------------------------------
@@ -3378,9 +3470,10 @@ NOTES:
.. COMMENT: === CONFIGURE_BSP_PREREQUISITE_DRIVERS ===
-.. _Specify BSP Prerequisite Drivers:
.. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
+.. _Specify BSP Prerequisite Drivers:
+
Specify BSP Prerequisite Drivers
--------------------------------
@@ -3418,9 +3511,10 @@ by ``<rtems/confdefs.h>``.
.. COMMENT: === CONFIGURE_IDLE_TASK_BODY ===
-.. _Specify Application Specific Idle Task Body:
.. index:: CONFIGURE_IDLE_TASK_BODY
+.. _Specify Application Specific Idle Task Body:
+
Specify Application Specific Idle Task Body
-------------------------------------------
@@ -3446,9 +3540,10 @@ NOTES:
.. COMMENT: === CONFIGURE_IDLE_TASK_STACK_SIZE ===
-.. _Specify Idle Task Stack Size:
.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
+.. _Specify Idle Task Stack Size:
+
Specify Idle Task Stack Size
----------------------------
@@ -3473,9 +3568,10 @@ NOTES:
.. COMMENT: === CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION ===
-.. _Specify Idle Task Performs Application Initialization:
.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
+.. _Specify Idle Task Performs Application Initialization:
+
Specify Idle Task Performs Application Initialization
-----------------------------------------------------
@@ -3523,9 +3619,10 @@ configuration macros.
.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY ===
-.. _Use Deterministic Priority Scheduler:
.. index:: CONFIGURE_SCHEDULER_PRIORITY
+.. _Use Deterministic Priority Scheduler:
+
Use Deterministic Priority Scheduler
------------------------------------
@@ -3556,9 +3653,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE ===
-.. _Use Simple Priority Scheduler:
.. index:: CONFIGURE_SCHEDULER_SIMPLE
+.. _Use Simple Priority Scheduler:
+
Use Simple Priority Scheduler
-----------------------------
@@ -3591,9 +3689,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SCHEDULER_EDF ===
-.. _Use Earliest Deadline First Scheduler:
.. index:: CONFIGURE_SCHEDULER_EDF
+.. _Use Earliest Deadline First Scheduler:
+
Use Earliest Deadline First Scheduler
-------------------------------------
@@ -3628,9 +3727,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SCHEDULER_EDF_SMP ===
-.. _Use Earliest Deadline First SMP Scheduler:
.. index:: CONFIGURE_SCHEDULER_EDF_SMP
+.. _Use Earliest Deadline First SMP Scheduler:
+
Use Earliest Deadline First Scheduler
-------------------------------------
@@ -3655,9 +3755,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SCHEDULER_CBS ===
-.. _Use Constant Bandwidth Server Scheduler:
.. index:: CONFIGURE_SCHEDULER_CBS
+.. _Use Constant Bandwidth Server Scheduler:
+
Use Constant Bandwidth Server Scheduler
---------------------------------------
@@ -3690,9 +3791,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY_SMP ===
-.. _Use Deterministic Priority SMP Scheduler:
.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
+.. _Use Deterministic Priority SMP Scheduler:
+
Use Deterministic Priority SMP Scheduler
----------------------------------------
@@ -3725,9 +3827,10 @@ NOTES:
.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE_SMP ===
-.. _Use Simple SMP Priority Scheduler:
.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
+.. _Use Simple SMP Priority Scheduler:
+
Use Simple SMP Priority Scheduler
---------------------------------
@@ -3766,9 +3869,10 @@ NOTES:
.. COMMENT: === Configuring a Scheduler Name ===
-.. _Configuring a Scheduler Name:
.. index:: CONFIGURE_SCHEDULER_NAME
+.. _Configuring a Scheduler Name:
+
Configuring a Scheduler Name
----------------------------
@@ -3800,9 +3904,10 @@ NOTES:
.. COMMENT: === Configuring a User Scheduler ===
-.. _Configuring a User Provided Scheduler:
.. index:: CONFIGURE_SCHEDULER_USER
+.. _Configuring a User Provided Scheduler:
+
Configuring a User Provided Scheduler
-------------------------------------
@@ -4029,9 +4134,10 @@ Note that network device drivers are not configured in the Device Driver Table.
.. COMMENT: === CONFIGURE_MAXIMUM_DRIVERS ===
-.. _Specifying the Maximum Number of Device Drivers:
.. index:: CONFIGURE_MAXIMUM_DRIVERS
+.. _Specifying the Maximum Number of Device Drivers:
+
Specifying the Maximum Number of Device Drivers
-----------------------------------------------
@@ -4063,9 +4169,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER ===
-.. _Enable Console Device Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
+.. _Enable Console Device Driver:
+
Enable Console Device Driver
----------------------------
@@ -4094,9 +4201,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER ===
-.. _Enable Clock Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
+.. _Enable Clock Driver:
+
Enable Clock Driver
-------------------
@@ -4127,9 +4235,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER ===
-.. _Enable the Benchmark Timer Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
+.. _Enable the Benchmark Timer Driver:
+
Enable the Benchmark Timer Driver
---------------------------------
@@ -4158,9 +4267,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER ===
-.. _Specify Clock and Benchmark Timer Drivers Are Not Needed:
.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
+.. _Specify Clock and Benchmark Timer Drivers Are Not Needed:
+
Specify Clock and Benchmark Timer Drivers Are Not Needed
--------------------------------------------------------
@@ -4189,9 +4299,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER ===
-.. _Enable Real-Time Clock Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
+.. _Enable Real-Time Clock Driver:
+
Enable Real-Time Clock Driver
-----------------------------
@@ -4220,9 +4331,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER ===
-.. _Enable the Watchdog Device Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
+.. _Enable the Watchdog Device Driver:
+
Enable the Watchdog Device Driver
---------------------------------
@@ -4251,9 +4363,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER ===
-.. _Enable the Graphics Frame Buffer Device Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
+.. _Enable the Graphics Frame Buffer Device Driver:
+
Enable the Graphics Frame Buffer Device Driver
----------------------------------------------
@@ -4282,9 +4395,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER ===
-.. _Enable Stub Device Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
+.. _Enable Stub Device Driver:
+
Enable Stub Device Driver
-------------------------
@@ -4310,9 +4424,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS ===
-.. _Specify Application Prerequisite Device Drivers:
.. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
+.. _Specify Application Prerequisite Device Drivers:
+
Specify Application Prerequisite Device Drivers
-----------------------------------------------
@@ -4346,9 +4461,10 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_EXTRA_DRIVERS ===
-.. _Specify Extra Application Device Drivers:
.. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
+.. _Specify Extra Application Device Drivers:
+
Specify Extra Application Device Drivers
----------------------------------------
@@ -4375,10 +4491,11 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER ===
-.. _Enable /dev/null Device Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
.. index:: /dev/null
+.. _Enable /dev/null Device Driver:
+
Enable /dev/null Device Driver
------------------------------
@@ -4402,10 +4519,11 @@ NOTES:
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER ===
-.. _Enable /dev/zero Device Driver:
.. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
.. index:: /dev/zero
+.. _Enable /dev/zero Device Driver:
+
Enable /dev/zero Device Driver
------------------------------
@@ -4429,9 +4547,10 @@ NOTES:
.. COMMENT: === CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE ===
-.. _Specifying Application Defined Device Driver Table:
.. index:: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
+.. _Specifying Application Defined Device Driver Table:
+
Specifying Application Defined Device Driver Table
--------------------------------------------------
@@ -4475,9 +4594,10 @@ Additionally, this class of Configuration Constants are only applicable if
.. COMMENT: === CONFIGURE_MP_APPLICATION ===
-.. _Specify Application Will Use Multiprocessing:
.. index:: CONFIGURE_MP_APPLICATION
+.. _Specify Application Will Use Multiprocessing:
+
Specify Application Will Use Multiprocessing
--------------------------------------------
@@ -4505,9 +4625,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MP_NODE_NUMBER ===
-.. _Configure Node Number in Multiprocessor Configuration:
.. index:: CONFIGURE_MP_NODE_NUMBER
+.. _Configure Node Number in Multiprocessor Configuration:
+
Configure Node Number in Multiprocessor Configuration
-----------------------------------------------------
@@ -4536,9 +4657,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MP_MAXIMUM_NODES ===
-.. _Configure Maximum Node in Multiprocessor Configuration:
.. index:: CONFIGURE_MP_MAXIMUM_NODES
+.. _Configure Maximum Node in Multiprocessor Configuration:
+
Configure Maximum Node in Multiprocessor Configuration
------------------------------------------------------
@@ -4563,9 +4685,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS ===
-.. _Configure Maximum Global Objects in Multiprocessor Configuration:
.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
+.. _Configure Maximum Global Objects in Multiprocessor Configuration:
+
Configure Maximum Global Objects in Multiprocessor Configuration
----------------------------------------------------------------
@@ -4591,9 +4714,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MP_MAXIMUM_PROXIES ===
-.. _Configure Maximum Proxies in Multiprocessor Configuration:
.. index:: CONFIGURE_MP_MAXIMUM_PROXIES
+.. _Configure Maximum Proxies in Multiprocessor Configuration:
+
Configure Maximum Proxies in Multiprocessor Configuration
---------------------------------------------------------
@@ -4622,9 +4746,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MP_MPCI_TABLE_POINTER ===
-.. _Configure MPCI in Multiprocessor Configuration:
.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
+.. _Configure MPCI in Multiprocessor Configuration:
+
Configure MPCI in Multiprocessor Configuration
----------------------------------------------
@@ -4651,9 +4776,10 @@ NOTES:
.. COMMENT: === CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE ===
-.. _Do Not Generate Multiprocessor Configuration Table:
.. index:: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
+.. _Do Not Generate Multiprocessor Configuration Table:
+
Do Not Generate Multiprocessor Configuration Table
--------------------------------------------------
@@ -4698,9 +4824,10 @@ has a test suite. This test suite is enabled only when``--enable-tests`` and
.. COMMENT: === CONFIGURE_GNAT_RTEMS ===
-.. _Specify Application Includes Ada Code:
.. index:: CONFIGURE_GNAT_RTEMS
+.. _Specify Application Includes Ada Code:
+
Specify Application Includes Ada Code
-------------------------------------
@@ -4727,9 +4854,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_ADA_TASKS ===
-.. _Specify the Maximum Number of Ada Tasks.:
.. index:: CONFIGURE_MAXIMUM_ADA_TASKS
+.. _Specify the Maximum Number of Ada Tasks.:
+
Specify the Maximum Number of Ada Tasks.
----------------------------------------
@@ -4755,9 +4883,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_FAKE_ADA_TASKS ===
-.. _Specify the Maximum Fake Ada Tasks:
.. index:: CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
+.. _Specify the Maximum Fake Ada Tasks:
+
Specify the Maximum Fake Ada Tasks
----------------------------------
@@ -4843,9 +4972,10 @@ Go Tasks
.. COMMENT: === CONFIGURE_ENABLE_GO ===
-.. _Specify Application Includes Go Code:
.. index:: CONFIGURE_ENABLE_GO
+.. _Specify Application Includes Go Code:
+
Specify Application Includes Go Code
------------------------------------
@@ -4870,9 +5000,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_GOROUTINES ===
-.. _Specify the maximum number of Go routines:
.. index:: CONFIGURE_MAXIMUM_GOROUTINES
+.. _Specify the maximum number of Go routines:
+
Specify the maximum number of Go routines
-----------------------------------------
@@ -4897,9 +5028,10 @@ NOTES:
.. COMMENT: === CONFIGURE_MAXIMUM_GO_CHANNELS ===
-.. _Specify the maximum number of Go Channels:
.. index:: CONFIGURE_MAXIMUM_GO_CHANNELS
+.. _Specify the maximum number of Go Channels:
+
Specify the maximum number of Go Channels
-----------------------------------------
diff --git a/c-user/constant_bandwidth_server.rst b/c-user/constant_bandwidth_server.rst
index 2a6ed40..2b03475 100644
--- a/c-user/constant_bandwidth_server.rst
+++ b/c-user/constant_bandwidth_server.rst
@@ -4,11 +4,11 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. index:: cbs
+
Constant Bandwidth Server Scheduler API
***************************************
-.. index:: cbs
-
Introduction
============
@@ -40,11 +40,12 @@ provided by the CBS API are:
- rtems_cbs_get_approved_budget_ - Get scheduler approved execution time
-Background
-==========
.. index:: CBS parameters
.. index:: rtems_cbs_parameters
+Background
+==========
+
Constant Bandwidth Server Definitions
-------------------------------------
@@ -232,9 +233,9 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_cbs_initialize:
.. index:: initialize the CBS library
.. index:: rtems_cbs_initialize
+.. _rtems_cbs_initialize:
CBS_INITIALIZE - Initialize the CBS library
-------------------------------------------
@@ -270,10 +271,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_cleanup:
.. index:: cleanup the CBS library
.. index:: rtems_cbs_cleanup
+.. _rtems_cbs_cleanup:
+
CBS_CLEANUP - Cleanup the CBS library
-------------------------------------
@@ -300,10 +302,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_create_server:
.. index:: create a new bandwidth server
.. index:: rtems_cbs_create_server
+.. _rtems_cbs_create_server:
+
CBS_CREATE_SERVER - Create a new bandwidth server
-------------------------------------------------
@@ -348,10 +351,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_attach_thread:
.. index:: attach a thread to server
.. index:: rtems_cbs_attach_thread
+.. _rtems_cbs_attach_thread:
+
CBS_ATTACH_THREAD - Attach a thread to server
---------------------------------------------
@@ -390,10 +394,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_detach_thread:
.. index:: detach a thread from server
.. index:: rtems_cbs_detach_thread
+.. _rtems_cbs_detach_thread:
+
CBS_DETACH_THREAD - Detach a thread from server
-----------------------------------------------
@@ -427,10 +432,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_destroy_server:
.. index:: destroy a bandwidth server
.. index:: rtems_cbs_destroy_server
+.. _rtems_cbs_destroy_server:
+
CBS_DESTROY_SERVER - Destroy a bandwidth server
-----------------------------------------------
@@ -464,10 +470,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_server_id:
.. index:: get an ID of a server
.. index:: rtems_cbs_get_server_id
+.. _rtems_cbs_get_server_id:
+
CBS_GET_SERVER_ID - Get an ID of a server
-----------------------------------------
@@ -495,10 +502,11 @@ DESCRIPTION:
\clearpage
-.. _rtems_cbs_get_parameters:
.. index:: get scheduling parameters of a server
.. index:: rtems_cbs_get_parameters
+.. _rtems_cbs_get_parameters:
+
CBS_GET_PARAMETERS - Get scheduling parameters of a server
----------------------------------------------------------
@@ -532,10 +540,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_set_parameters:
.. index:: set scheduling parameters
.. index:: rtems_cbs_set_parameters
+.. _rtems_cbs_set_parameters:
+
CBS_SET_PARAMETERS - Set scheduling parameters
----------------------------------------------
@@ -571,10 +580,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_execution_time:
.. index:: get elapsed execution time
.. index:: rtems_cbs_get_execution_time
+.. _rtems_cbs_get_execution_time:
+
CBS_GET_EXECUTION_TIME - Get elapsed execution time
---------------------------------------------------
@@ -609,10 +619,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_remaining_budget:
.. index:: get remaining execution time
.. index:: rtems_cbs_get_remaining_budget
+.. _rtems_cbs_get_remaining_budget:
+
CBS_GET_REMAINING_BUDGET - Get remaining execution time
-------------------------------------------------------
@@ -647,10 +658,11 @@ NOTES:
\clearpage
-.. _rtems_cbs_get_approved_budget:
.. index:: get scheduler approved execution time
.. index:: rtems_cbs_get_approved_budget
+.. _rtems_cbs_get_approved_budget:
+
CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time
---------------------------------------------------------------
diff --git a/c-user/cpu_usage_statistics.rst b/c-user/cpu_usage_statistics.rst
index fde008f..98bdc1c 100644
--- a/c-user/cpu_usage_statistics.rst
+++ b/c-user/cpu_usage_statistics.rst
@@ -110,9 +110,10 @@ calling sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_cpu_usage_report:
.. index:: rtems_cpu_usage_report
+.. _rtems_cpu_usage_report:
+
cpu_usage_report - Report CPU Usage Statistics
----------------------------------------------
@@ -135,9 +136,10 @@ NOTES:
\clearpage
-.. _rtems_cpu_usage_reset:
.. index:: rtems_cpu_usage_reset
+.. _rtems_cpu_usage_reset:
+
cpu_usage_reset - Reset CPU Usage Statistics
--------------------------------------------
diff --git a/c-user/directive_status_codes.rst b/c-user/directive_status_codes.rst
index 6acfd4d..b74f190 100644
--- a/c-user/directive_status_codes.rst
+++ b/c-user/directive_status_codes.rst
@@ -84,9 +84,10 @@ The directives are:
\clearpage
-.. _rtems_status_text:
.. index:: rtems_status_text
+.. _rtems_status_text:
+
STATUS_TEXT - Returns the enumeration name for a status code
------------------------------------------------------------
diff --git a/c-user/dual_ports_memory_manager.rst b/c-user/dual_ports_memory_manager.rst
index ed93482..1ca71d6 100644
--- a/c-user/dual_ports_memory_manager.rst
+++ b/c-user/dual_ports_memory_manager.rst
@@ -99,10 +99,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_port_create:
.. index:: create a port
.. index:: rtems_port_create
+.. _rtems_port_create:
+
PORT_CREATE - Create a port
---------------------------
@@ -152,11 +153,12 @@ NOTES:
\clearpage
-.. _rtems_port_ident:
.. index:: get ID of a port
.. index:: obtain ID of a port
.. index:: rtems_port_ident
+.. _rtems_port_ident:
+
PORT_IDENT - Get ID of a port
-----------------------------
@@ -193,10 +195,11 @@ NOTES:
\clearpage
-.. _rtems_port_delete:
.. index:: delete a port
.. index:: rtems_port_delete
+.. _rtems_port_delete:
+
PORT_DELETE - Delete a port
---------------------------
@@ -230,10 +233,11 @@ NOTES:
\clearpage
-.. _rtems_port_external_to_internal:
.. index:: convert external to internal address
.. index:: rtems_port_external_to_internal
+.. _rtems_port_external_to_internal:
+
PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address
----------------------------------------------------------------
@@ -270,10 +274,11 @@ NOTES:
\clearpage
-.. _rtems_port_internal_to_external:
.. index:: convert internal to external address
.. index:: rtems_port_internal_to_external
+.. _rtems_port_internal_to_external:
+
PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address
----------------------------------------------------------------
diff --git a/c-user/event_manager.rst b/c-user/event_manager.rst
index d3c1a95..3108984 100644
--- a/c-user/event_manager.rst
+++ b/c-user/event_manager.rst
@@ -182,10 +182,11 @@ related constants, usage, and status codes.
\clearpage
-.. _rtems_event_send:
.. index:: send event set to a task
.. index:: rtems_event_send
+.. _rtems_event_send:
+
EVENT_SEND - Send event set to a task
-------------------------------------
@@ -233,10 +234,11 @@ NOTES:
\clearpage
-.. _rtems_event_receive:
.. index:: receive event condition
.. index:: rtems_event_receive
+.. _rtems_event_receive:
+
EVENT_RECEIVE - Receive event condition
---------------------------------------
diff --git a/c-user/fatal_error.rst b/c-user/fatal_error.rst
index 6cee174..8aa7c52 100644
--- a/c-user/fatal_error.rst
+++ b/c-user/fatal_error.rst
@@ -4,9 +4,10 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-.. _fatal_error_manager:
.. index:: fatal errors
+.. _fatal_error_manager:
+
Fatal Error Manager
*******************
@@ -386,9 +387,10 @@ INTERNAL_ERROR_LIBIO_STDERR_FD_OPEN_FAILED (37)
Operations
==========
-.. _Terminate:
.. index:: _Terminate
+.. _Terminate:
+
Announcing a Fatal Error
------------------------
@@ -441,11 +443,12 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_fatal:
.. index:: announce fatal error
.. index:: fatal error, announce
.. index:: rtems_fatal
+.. _rtems_fatal:
+
FATAL - Invoke the fatal error
------------------------------
@@ -471,10 +474,11 @@ NOTE:
\clearpage
-.. _rtems_shutdown_executive:
.. index:: shutdown RTEMS
.. index:: rtems_shutdown_executive
+.. _rtems_shutdown_executive:
+
SHUTDOWN_EXECUTIVE - Shutdown RTEMS
-----------------------------------
@@ -503,10 +507,11 @@ NOTES:
\clearpage
-.. _rtems_exception_frame_print:
.. index:: exception frame
.. index:: rtems_exception_frame_print
+.. _rtems_exception_frame_print:
+
EXCEPTION_FRAME_PRINT - Prints the exception frame
--------------------------------------------------
@@ -527,10 +532,11 @@ DESCRIPTION:
\clearpage
-.. _rtems_fatal_source_text:
.. index:: fatal error
.. index:: rtems_fatal_source_text
+.. _rtems_fatal_source_text:
+
FATAL_SOURCE_TEXT - Returns a text for a fatal source
-----------------------------------------------------
@@ -552,10 +558,11 @@ DESCRIPTION:
\clearpage
-.. _rtems_internal_error_text:
.. index:: fatal error
.. index:: rtems_internal_error_text
+.. _rtems_internal_error_text:
+
INTERNAL_ERROR_TEXT - Returns a text for an internal error code
---------------------------------------------------------------
@@ -577,11 +584,12 @@ DESCRIPTION:
\clearpage
-.. _rtems_fatal_error_occurred:
.. index:: announce fatal error
.. index:: fatal error, announce
.. index:: rtems_fatal_error_occurred
+.. _rtems_fatal_error_occurred:
+
FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
------------------------------------------------------------------
diff --git a/c-user/initialization.rst b/c-user/initialization.rst
index a04633d..6c30a2d 100644
--- a/c-user/initialization.rst
+++ b/c-user/initialization.rst
@@ -71,7 +71,7 @@ Initializing RTEMS
------------------
The Initialization Manager :c:func:`rtems_initialize_executive()` directives is
-called by the :c:ref:`boot_card()` routine which is invoked by the Board
+called by the :c:func:`boot_card()` routine which is invoked by the Board
Support Package once a basic C run-time environment is set up. This consists
of
@@ -305,11 +305,12 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_initialize_executive:
.. index:: initialize RTEMS
.. index:: start multitasking
.. index:: rtems_initialize_executive
+.. _rtems_initialize_executive:
+
INITIALIZE_EXECUTIVE - Initialize RTEMS
---------------------------------------
diff --git a/c-user/interrupt_manager.rst b/c-user/interrupt_manager.rst
index 41dc8dd..5882261 100644
--- a/c-user/interrupt_manager.rst
+++ b/c-user/interrupt_manager.rst
@@ -268,11 +268,12 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_interrupt_catch:
.. index:: establish an ISR
.. index:: install an ISR
.. index:: rtems_interrupt_catch
+.. _rtems_interrupt_catch:
+
INTERRUPT_CATCH - Establish an ISR
----------------------------------
@@ -312,10 +313,11 @@ NOTES:
\clearpage
-.. _rtems_interrupt_disable:
.. index:: disable interrupts
.. index:: rtems_interrupt_disable
+.. _rtems_interrupt_disable:
+
INTERRUPT_DISABLE - Disable Interrupts
--------------------------------------
@@ -350,10 +352,11 @@ NOTES:
\clearpage
-.. _rtems_interrupt_enable:
.. index:: enable interrupts
.. index:: rtems_interrupt_enable
+.. _rtems_interrupt_enable:
+
INTERRUPT_ENABLE - Enable Interrupts
------------------------------------
@@ -385,10 +388,11 @@ NOTES:
\clearpage
-.. _rtems_interrupt_flash:
.. index:: flash interrupts
.. index:: rtems_interrupt_flash
+.. _rtems_interrupt_flash:
+
INTERRUPT_FLASH - Flash Interrupts
----------------------------------
@@ -420,10 +424,11 @@ NOTES:
\clearpage
-.. _rtems_interrupt_local_disable:
.. index:: disable interrupts
.. index:: rtems_interrupt_local_disable
+.. _rtems_interrupt_local_disable:
+
INTERRUPT_LOCAL_DISABLE - Disable Interrupts on Current Processor
-----------------------------------------------------------------
@@ -457,10 +462,11 @@ NOTES:
\clearpage
-.. _rtems_interrupt_local_enable:
.. index:: enable interrupts
.. index:: rtems_interrupt_local_enable
+.. _rtems_interrupt_local_enable:
+
INTERRUPT_LOCAL_ENABLE - Enable Interrupts on Current Processor
---------------------------------------------------------------
@@ -488,9 +494,10 @@ NOTES:
\clearpage
-.. _rtems_interrupt_lock_initialize:
.. index:: rtems_interrupt_lock_initialize
+.. _rtems_interrupt_lock_initialize:
+
INTERRUPT_LOCK_INITIALIZE - Initialize an ISR Lock
--------------------------------------------------
@@ -516,9 +523,10 @@ NOTES:
\clearpage
-.. _rtems_interrupt_lock_acquire:
.. index:: rtems_interrupt_lock_acquire
+.. _rtems_interrupt_lock_acquire:
+
INTERRUPT_LOCK_ACQUIRE - Acquire an ISR Lock
--------------------------------------------
@@ -551,9 +559,10 @@ NOTES:
\clearpage
-.. _rtems_interrupt_lock_release:
.. index:: rtems_interrupt_lock_release
+.. _rtems_interrupt_lock_release:
+
INTERRUPT_LOCK_RELEASE - Release an ISR Lock
--------------------------------------------
@@ -583,9 +592,10 @@ NOTES:
\clearpage
-.. _rtems_interrupt_lock_acquire_isr:
.. index:: rtems_interrupt_lock_acquire_isr
+.. _rtems_interrupt_lock_acquire_isr:
+
INTERRUPT_LOCK_ACQUIRE_ISR - Acquire an ISR Lock from ISR
---------------------------------------------------------
@@ -621,9 +631,10 @@ NOTES:
\clearpage
-.. _rtems_interrupt_lock_release_isr:
.. index:: rtems_interrupt_lock_release_isr
+.. _rtems_interrupt_lock_release_isr:
+
INTERRUPT_LOCK_RELEASE_ISR - Release an ISR Lock from ISR
---------------------------------------------------------
@@ -653,10 +664,11 @@ NOTES:
\clearpage
-.. _rtems_interrupt_is_in_progress:
.. index:: is interrupt in progress
.. index:: rtems_interrupt_is_in_progress
+.. _rtems_interrupt_is_in_progress:
+
INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress
------------------------------------------------
diff --git a/c-user/io_manager.rst b/c-user/io_manager.rst
index ab7be41..208fd9c 100644
--- a/c-user/io_manager.rst
+++ b/c-user/io_manager.rst
@@ -230,10 +230,11 @@ related constants, usage, and status codes.
\clearpage
-.. _rtems_io_register_driver:
.. index:: register a device driver
.. index:: rtems_io_register_driver
+.. _rtems_io_register_driver:
+
IO_REGISTER_DRIVER - Register a device driver
---------------------------------------------
@@ -288,10 +289,11 @@ NOTES:
\clearpage
-.. _rtems_io_unregister_driver:
.. index:: unregister a device driver
.. index:: rtems_io_unregister_driver
+.. _rtems_io_unregister_driver:
+
IO_UNREGISTER_DRIVER - Unregister a device driver
-------------------------------------------------
@@ -321,10 +323,11 @@ NOTES:
\clearpage
-.. _rtems_io_initialize:
.. index:: initialize a device driver
.. index:: rtems_io_initialize
+.. _rtems_io_initialize:
+
IO_INITIALIZE - Initialize a device driver
------------------------------------------
@@ -364,10 +367,11 @@ NOTES:
\clearpage
-.. _rtems_io_register_name:
.. index:: register device
.. index:: rtems_io_register_name
+.. _rtems_io_register_name:
+
IO_REGISTER_NAME - Register a device
------------------------------------
@@ -399,10 +403,11 @@ NOTES:
\clearpage
-.. _rtems_io_lookup_name:
.. index:: lookup device major and minor number
.. index:: rtems_io_lookup_name
+.. _rtems_io_lookup_name:
+
IO_LOOKUP_NAME - Lookup a device
--------------------------------
@@ -434,10 +439,11 @@ NOTES:
\clearpage
-.. _rtems_io_open:
.. index:: open a devive
.. index:: rtems_io_open
+.. _rtems_io_open:
+
IO_OPEN - Open a device
-----------------------
@@ -472,10 +478,11 @@ NOTES:
\clearpage
-.. _rtems_io_close:
.. index:: close a device
.. index:: rtems_io_close
+.. _rtems_io_close:
+
IO_CLOSE - Close a device
-------------------------
@@ -510,10 +517,11 @@ NOTES:
\clearpage
-.. _rtems_io_read:
.. index:: read from a device
.. index:: rtems_io_read
+.. _rtems_io_read:
+
IO_READ - Read from a device
----------------------------
@@ -549,10 +557,11 @@ NOTES:
\clearpage
-.. _rtems_io_write:
.. index:: write to a device
.. index:: rtems_io_write
+.. _rtems_io_write:
+
IO_WRITE - Write to a device
----------------------------
@@ -588,11 +597,12 @@ NOTES:
\clearpage
-.. _rtems_io_control:
.. index:: special device services
.. index:: IO Control
.. index:: rtems_io_control
+.. _rtems_io_control:
+
IO_CONTROL - Special device services
------------------------------------
diff --git a/c-user/key_concepts.rst b/c-user/key_concepts.rst
index c88132e..ff28430 100644
--- a/c-user/key_concepts.rst
+++ b/c-user/key_concepts.rst
@@ -270,9 +270,10 @@ relationships define a directed acyclic graph (DAG). The run-time of the mutex
obtain, release and timeout operations depend on the complexity of this
resource dependency graph.
-.. _PriorityInversion:
.. index:: priority inversion
+.. _PriorityInversion:
+
Priority Inversion
------------------
@@ -286,10 +287,11 @@ priority tasks. Because the low priority task is not executing, it cannot
complete its interaction with the resource and release that resource. The high
priority task is effectively prevented from executing by lower priority tasks.
-.. _PriorityCeiling:
.. index:: priority ceiling protocol
.. index:: immediate ceiling priority protocol
+.. _PriorityCeiling:
+
Immediate Ceiling Priority Protocol (ICPP)
------------------------------------------
@@ -312,9 +314,10 @@ may occur while a thread owns a particular mutex, the priority inheritance
protocol is more forgiving in that it does not require this apriori
information.
-.. _PriorityInheritance:
.. index:: priority inheritance protocol
+.. _PriorityInheritance:
+
Priority Inheritance Protocol
-----------------------------
@@ -323,9 +326,10 @@ threads that currently wait for ownership of this mutex :cite:`Sha:1990:PI`.
Since RTEMS 5.1, priority updates due to the priority inheritance protocol
take place immediately and are propagated recursively.
-.. _MrsP:
.. index:: Multiprocessor Resource Sharing Protocol (MrsP)
+.. _MrsP:
+
Multiprocessor Resource Sharing Protocol (MrsP)
-----------------------------------------------
@@ -344,9 +348,10 @@ protocol is available since RTEMS 4.11. It was re-implemented in RTEMS 5.1 to
overcome some shortcomings of the original implementation
:cite:`Catellani:2015:MrsP`.
-.. _OMIP:
.. index:: O(m) Independence-Preserving Protocol (OMIP)
+.. _OMIP:
+
O(m) Independence-Preserving Protocol (OMIP)
----------------------------------------------------
diff --git a/c-user/linker_sets.rst b/c-user/linker_sets.rst
index a93f829..9b2f1ca 100644
--- a/c-user/linker_sets.rst
+++ b/c-user/linker_sets.rst
@@ -4,9 +4,10 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-.. _linker_sets:
.. index:: linkersets
+.. _linker_sets:
+
Linker Sets
***********
@@ -126,9 +127,10 @@ Directives
\clearpage
-.. _RTEMS_LINKER_SET_BEGIN:
.. index:: RTEMS_LINKER_SET_BEGIN
+.. _RTEMS_LINKER_SET_BEGIN:
+
RTEMS_LINKER_SET_BEGIN - Designator of the linker set begin marker
------------------------------------------------------------------
@@ -159,9 +161,10 @@ NOTE:
\clearpage
-.. _RTEMS_LINKER_SET_END:
.. index:: RTEMS_LINKER_SET_END
+.. _RTEMS_LINKER_SET_END:
+
RTEMS_LINKER_SET_END - Designator of the linker set end marker
--------------------------------------------------------------
@@ -181,9 +184,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_SET_SIZE:
.. index:: RTEMS_LINKER_SET_SIZE
+.. _RTEMS_LINKER_SET_SIZE:
+
RTEMS_LINKER_SET_SIZE - The linker set size in characters
---------------------------------------------------------
@@ -202,9 +206,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_SET_ITEM_COUNT:
.. index:: RTEMS_LINKER_SET_ITEM_COUNT
+.. _RTEMS_LINKER_SET_ITEM_COUNT:
+
RTEMS_LINKER_SET_ITEM_COUNT - The linker set item count
---------------------------------------------------------
@@ -222,9 +227,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_SET_IS_EMPTY:
.. index:: RTEMS_LINKER_SET_IS_EMPTY
+.. _RTEMS_LINKER_SET_IS_EMPTY:
+
RTEMS_LINKER_SET_IS_EMPTY - Is the linker set empty?
---------------------------------------------------------
@@ -243,9 +249,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_SET_FOREACH:
.. index:: RTEMS_LINKER_SET_FOREACH
+.. _RTEMS_LINKER_SET_FOREACH:
+
RTEMS_LINKER_SET_FOREACH - Iterate through the linker set items
---------------------------------------------------------
@@ -279,9 +286,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_ROSET_DECLARE:
.. index:: RTEMS_LINKER_ROSET_DECLARE
+.. _RTEMS_LINKER_ROSET_DECLARE:
+
RTEMS_LINKER_ROSET_DECLARE - Declares a read-only linker set
------------------------------------------------------------
@@ -302,9 +310,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_ROSET:
.. index:: RTEMS_LINKER_ROSET
+.. _RTEMS_LINKER_ROSET:
+
RTEMS_LINKER_ROSET - Defines a read-only linker set
---------------------------------------------------
@@ -325,9 +334,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_ROSET_ITEM_DECLARE:
.. index:: RTEMS_LINKER_ROSET_ITEM_DECLARE
+.. _RTEMS_LINKER_ROSET_ITEM_DECLARE:
+
RTEMS_LINKER_ROSET_ITEM_DECLARE - Declares a read-only linker set item
----------------------------------------------------------------------
@@ -350,9 +360,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_ROSET_ITEM_REFERENCE:
.. index:: RTEMS_LINKER_ROSET_ITEM_REFERENCE
+.. _RTEMS_LINKER_ROSET_ITEM_REFERENCE:
+
RTEMS_LINKER_ROSET_ITEM_REFERENCE - References a read-only linker set item
--------------------------------------------------------------------------
@@ -375,9 +386,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_ROSET_ITEM:
.. index:: RTEMS_LINKER_ROSET_ITEM
+.. _RTEMS_LINKER_ROSET_ITEM:
+
RTEMS_LINKER_ROSET_ITEM - Defines a read-only linker set item
-------------------------------------------------------------
@@ -400,9 +412,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_ROSET_ITEM_ORDERED:
.. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED
+.. _RTEMS_LINKER_ROSET_ITEM_ORDERED:
+
RTEMS_LINKER_ROSET_ITEM_ORDERED - Defines an ordered read-only linker set item
------------------------------------------------------------------------------
@@ -457,9 +470,10 @@ NOTES:
\clearpage
-.. _RTEMS_LINKER_ROSET_CONTENT:
.. index:: RTEMS_LINKER_ROSET_CONTENT
+.. _RTEMS_LINKER_ROSET_CONTENT:
+
RTEMS_LINKER_ROSET_CONTENT - Marks a declaration as a read-only linker set content
----------------------------------------------------------------------------------
@@ -479,9 +493,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_RWSET_DECLARE:
.. index:: RTEMS_LINKER_RWSET_DECLARE
+.. _RTEMS_LINKER_RWSET_DECLARE:
+
RTEMS_LINKER_RWSET_DECLARE - Declares a read-write linker set
-------------------------------------------------------------
@@ -502,9 +517,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_RWSET:
.. index:: RTEMS_LINKER_RWSET
+.. _RTEMS_LINKER_RWSET:
+
RTEMS_LINKER_RWSET - Defines a read-write linker set
----------------------------------------------------
@@ -525,9 +541,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_RWSET_ITEM_DECLARE:
.. index:: RTEMS_LINKER_RWSET_ITEM_DECLARE
+.. _RTEMS_LINKER_RWSET_ITEM_DECLARE:
+
RTEMS_LINKER_RWSET_ITEM_DECLARE - Declares a read-write linker set item
-----------------------------------------------------------------------
@@ -550,9 +567,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_RWSET_ITEM_REFERENCE:
.. index:: RTEMS_LINKER_RWSET_ITEM_REFERENCE
+.. _RTEMS_LINKER_RWSET_ITEM_REFERENCE:
+
RTEMS_LINKER_RWSET_ITEM_REFERENCE - References a read-write linker set item
---------------------------------------------------------------------------
@@ -575,9 +593,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_RWSET_ITEM:
.. index:: RTEMS_LINKER_RWSET_ITEM
+.. _RTEMS_LINKER_RWSET_ITEM:
+
RTEMS_LINKER_RWSET_ITEM - Defines a read-write linker set item
--------------------------------------------------------------
@@ -600,9 +619,10 @@ DESCRIPTION:
\clearpage
-.. _RTEMS_LINKER_RWSET_ITEM_ORDERED:
.. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED
+.. _RTEMS_LINKER_RWSET_ITEM_ORDERED:
+
RTEMS_LINKER_RWSET_ITEM_ORDERED - Defines an ordered read-write linker set item
-------------------------------------------------------------------------------
@@ -657,9 +677,10 @@ NOTES:
\clearpage
-.. _RTEMS_LINKER_RWSET_CONTENT:
.. index:: RTEMS_LINKER_RWSET_CONTENT
+.. _RTEMS_LINKER_RWSET_CONTENT:
+
RTEMS_LINKER_RWSET_CONTENT - Marks a declaration as a read-write linker set content
-----------------------------------------------------------------------------------
diff --git a/c-user/message_manager.rst b/c-user/message_manager.rst
index 2c908d9..4ecabc6 100644
--- a/c-user/message_manager.rst
+++ b/c-user/message_manager.rst
@@ -220,10 +220,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_message_queue_create:
.. index:: create a message queue
.. index:: rtems_message_queue_create
+.. _rtems_message_queue_create:
+
MESSAGE_QUEUE_CREATE - Create a queue
-------------------------------------
@@ -307,10 +308,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_ident:
.. index:: get ID of a message queue
.. index:: rtems_message_queue_ident
+.. _rtems_message_queue_ident:
+
MESSAGE_QUEUE_IDENT - Get ID of a queue
---------------------------------------
@@ -360,10 +362,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_delete:
.. index:: delete a message queue
.. index:: rtems_message_queue_delete
+.. _rtems_message_queue_delete:
+
MESSAGE_QUEUE_DELETE - Delete a queue
-------------------------------------
@@ -418,10 +421,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_send:
.. index:: send message to a queue
.. index:: rtems_message_queue_send
+.. _rtems_message_queue_send:
+
MESSAGE_QUEUE_SEND - Put message at rear of a queue
---------------------------------------------------
@@ -475,10 +479,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_urgent:
.. index:: put message at front of queue
.. index:: rtems_message_queue_urgent
+.. _rtems_message_queue_urgent:
+
MESSAGE_QUEUE_URGENT - Put message at front of a queue
------------------------------------------------------
@@ -532,10 +537,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_broadcast:
.. index:: broadcast message to a queue
.. index:: rtems_message_queue_broadcast
+.. _rtems_message_queue_broadcast:
+
MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue
---------------------------------------------------------
@@ -592,10 +598,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_receive:
.. index:: receive message from a queue
.. index:: rtems_message_queue_receive
+.. _rtems_message_queue_receive:
+
MESSAGE_QUEUE_RECEIVE - Receive message from a queue
----------------------------------------------------
@@ -679,10 +686,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_get_number_pending:
.. index:: get number of pending messages
.. index:: rtems_message_queue_get_number_pending
+.. _rtems_message_queue_get_number_pending:
+
MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
----------------------------------------------------------------------------
@@ -718,10 +726,11 @@ NOTES:
\clearpage
-.. _rtems_message_queue_flush:
.. index:: flush messages on a queue
.. index:: rtems_message_queue_flush
+.. _rtems_message_queue_flush:
+
MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
---------------------------------------------------
diff --git a/c-user/multiprocessing.rst b/c-user/multiprocessing.rst
index 740eabf..4528bcf 100644
--- a/c-user/multiprocessing.rst
+++ b/c-user/multiprocessing.rst
@@ -481,10 +481,11 @@ usage, and status codes.
\clearpage
-.. _rtems_multiprocessing_announce:
.. index:: announce arrival of package
.. index:: rtems_multiprocessing_announce
+.. _rtems_multiprocessing_announce:
+
MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
-----------------------------------------------------------
diff --git a/c-user/object_services.rst b/c-user/object_services.rst
index dd924da..dbe61d3 100644
--- a/c-user/object_services.rst
+++ b/c-user/object_services.rst
@@ -180,10 +180,11 @@ Directives
\clearpage
-.. _rtems_build_name:
.. index:: build object name
.. index:: rtems_build_name
+.. _rtems_build_name:
+
BUILD_NAME - Build object name from characters
----------------------------------------------
@@ -212,11 +213,12 @@ NOTES:
\clearpage
-.. _rtems_object_get_classic_name:
.. index:: get name from id
.. index:: obtain name from id
.. index:: rtems_object_get_classic_name
+.. _rtems_object_get_classic_name:
+
OBJECT_GET_CLASSIC_NAME - Lookup name from id
---------------------------------------------
@@ -250,11 +252,12 @@ NOTES:
\clearpage
-.. _rtems_object_get_name:
.. index:: get object name as string
.. index:: obtain object name as string
.. index:: rtems_object_get_name
+.. _rtems_object_get_name:
+
OBJECT_GET_NAME - Obtain object name as string
----------------------------------------------
@@ -283,10 +286,11 @@ NOTES:
\clearpage
-.. _rtems_object_set_name:
.. index:: set object name
.. index:: rtems_object_set_name
+.. _rtems_object_set_name:
+
OBJECT_SET_NAME - Set object name
---------------------------------
@@ -330,10 +334,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_get_api:
.. index:: obtain API from id
.. index:: rtems_object_id_get_api
+.. _rtems_object_id_get_api:
+
OBJECT_ID_GET_API - Obtain API from Id
--------------------------------------
@@ -359,10 +364,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_get_class:
.. index:: obtain class from object id
.. index:: rtems_object_id_get_class
+.. _rtems_object_id_get_class:
+
OBJECT_ID_GET_CLASS - Obtain Class from Id
------------------------------------------
@@ -388,10 +394,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_get_node:
.. index:: obtain node from object id
.. index:: rtems_object_id_get_node
+.. _rtems_object_id_get_node:
+
OBJECT_ID_GET_NODE - Obtain Node from Id
----------------------------------------
@@ -417,10 +424,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_get_index:
.. index:: obtain index from object id
.. index:: rtems_object_id_get_index
+.. _rtems_object_id_get_index:
+
OBJECT_ID_GET_INDEX - Obtain Index from Id
------------------------------------------
@@ -446,10 +454,11 @@ NOTES:
\clearpage
-.. _rtems_build_id:
.. index:: build object id from components
.. index:: rtems_build_id
+.. _rtems_build_id:
+
BUILD_ID - Build Object Id From Components
------------------------------------------
@@ -480,10 +489,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_api_minimum:
.. index:: obtain minimum API value
.. index:: rtems_object_id_api_minimum
+.. _rtems_object_id_api_minimum:
+
OBJECT_ID_API_MINIMUM - Obtain Minimum API Value
------------------------------------------------
@@ -505,10 +515,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_api_maximum:
.. index:: obtain maximum API value
.. index:: rtems_object_id_api_maximum
+.. _rtems_object_id_api_maximum:
+
OBJECT_ID_API_MAXIMUM - Obtain Maximum API Value
------------------------------------------------
@@ -530,10 +541,11 @@ NOTES:
\clearpage
-.. _rtems_object_api_minimum_class:
.. index:: obtain minimum class value
.. index:: rtems_object_api_minimum_class
+.. _rtems_object_api_minimum_class:
+
OBJECT_API_MINIMUM_CLASS - Obtain Minimum Class Value
-----------------------------------------------------
@@ -561,10 +573,11 @@ NOTES:
\clearpage
-.. _rtems_object_api_maximum_class:
.. index:: obtain maximum class value
.. index:: rtems_object_api_maximum_class
+.. _rtems_object_api_maximum_class:
+
OBJECT_API_MAXIMUM_CLASS - Obtain Maximum Class Value
-----------------------------------------------------
@@ -592,10 +605,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_api_minimum_class:
.. index:: obtain minimum class value for an API
.. index:: rtems_object_id_api_minimum_class
+.. _rtems_object_id_api_minimum_class:
+
OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API
-------------------------------------------------------------------
@@ -623,10 +637,11 @@ NOTES:
\clearpage
-.. _rtems_object_id_api_maximum_class:
.. index:: obtain maximum class value for an API
.. index:: rtems_object_id_api_maximum_class
+.. _rtems_object_id_api_maximum_class:
+
OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API
-------------------------------------------------------------------
@@ -654,10 +669,11 @@ NOTES:
\clearpage
-.. _rtems_object_get_api_name:
.. index:: obtain API name
.. index:: rtems_object_get_api_name
+.. _rtems_object_get_api_name:
+
OBJECT_GET_API_NAME - Obtain API Name
-------------------------------------
@@ -686,10 +702,11 @@ NOTES:
\clearpage
-.. _rtems_object_get_api_class_name:
.. index:: obtain class name
.. index:: rtems_object_get_api_class_name
+.. _rtems_object_get_api_class_name:
+
OBJECT_GET_API_CLASS_NAME - Obtain Class Name
---------------------------------------------
@@ -722,10 +739,11 @@ NOTES:
\clearpage
-.. _rtems_object_get_class_information:
.. index:: obtain class information
.. index:: rtems_object_get_class_information
+.. _rtems_object_get_class_information:
+
OBJECT_GET_CLASS_INFORMATION - Obtain Class Information
-------------------------------------------------------
diff --git a/c-user/partition_manager.rst b/c-user/partition_manager.rst
index 9edf09f..68761da 100644
--- a/c-user/partition_manager.rst
+++ b/c-user/partition_manager.rst
@@ -135,10 +135,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_partition_create:
.. index:: create a partition
.. index:: rtems_partition_create
+.. _rtems_partition_create:
+
PARTITION_CREATE - Create a partition
-------------------------------------
@@ -229,11 +230,12 @@ NOTES:
\clearpage
-.. _rtems_partition_ident:
.. index:: get ID of a partition
.. index:: obtain ID of a partition
.. index:: rtems_partition_ident
+.. _rtems_partition_ident:
+
PARTITION_IDENT - Get ID of a partition
---------------------------------------
@@ -283,10 +285,11 @@ NOTES:
\clearpage
-.. _rtems_partition_delete:
.. index:: delete a partition
.. index:: rtems_partition_delete
+.. _rtems_partition_delete:
+
PARTITION_DELETE - Delete a partition
-------------------------------------
@@ -332,11 +335,12 @@ NOTES:
\clearpage
-.. _rtems_partition_get_buffer:
.. index:: get buffer from partition
.. index:: obtain buffer from partition
.. index:: rtems_partition_get_buffer
+.. _rtems_partition_get_buffer:
+
PARTITION_GET_BUFFER - Get buffer from a partition
--------------------------------------------------
@@ -380,10 +384,11 @@ NOTES:
\clearpage
-.. _rtems_partition_return_buffer:
.. index:: return buffer to partitition
.. index:: rtems_partition_return_buffer
+.. _rtems_partition_return_buffer:
+
PARTITION_RETURN_BUFFER - Return buffer to a partition
------------------------------------------------------
diff --git a/c-user/rate_monotonic_manager.rst b/c-user/rate_monotonic_manager.rst
index ad675b0..eeb1ec6 100644
--- a/c-user/rate_monotonic_manager.rst
+++ b/c-user/rate_monotonic_manager.rst
@@ -634,10 +634,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_rate_monotonic_create:
.. index:: create a period
.. index:: rtems_rate_monotonic_create
+.. _rtems_rate_monotonic_create:
+
RATE_MONOTONIC_CREATE - Create a rate monotonic period
------------------------------------------------------
@@ -674,11 +675,12 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_ident:
.. index:: get ID of a period
.. index:: obtain ID of a period
.. index:: rtems_rate_monotonic_ident
+.. _rtems_rate_monotonic_ident:
+
RATE_MONOTONIC_IDENT - Get ID of a period
-----------------------------------------
@@ -713,10 +715,11 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_cancel:
.. index:: cancel a period
.. index:: rtems_rate_monotonic_cancel
+.. _rtems_rate_monotonic_cancel:
+
RATE_MONOTONIC_CANCEL - Cancel a period
---------------------------------------
@@ -754,10 +757,11 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_delete:
.. index:: rtems_rate_monotonic_delete
.. index:: delete a period
+.. _rtems_rate_monotonic_delete:
+
RATE_MONOTONIC_DELETE - Delete a rate monotonic period
------------------------------------------------------
@@ -793,12 +797,13 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_period:
.. index:: conclude current period
.. index:: start current period
.. index:: period initiation
.. index:: rtems_rate_monotonic_period
+.. _rtems_rate_monotonic_period:
+
RATE_MONOTONIC_PERIOD - Conclude current/Start next period
----------------------------------------------------------
@@ -847,11 +852,12 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_get_status:
.. index:: get status of period
.. index:: obtain status of period
.. index:: rtems_rate_monotonic_get_status
+.. _rtems_rate_monotonic_get_status:
+
RATE_MONOTONIC_GET_STATUS - Obtain status from a period
-------------------------------------------------------
@@ -898,12 +904,13 @@ DIRECTIVE STATUS CODES:
time values will be set to 0. Otherwise, both time values will contain
time information since the last invocation of the
``rtems_rate_monotonic_period`` directive. More specifically, the
- since_last_period value contains the elapsed time which has occurred
- since the last invocation of the ``rtems_rate_monotonic_period`` directive
- and the ``executed_since_last_period`` contains how much processor
- time the owning task has consumed since the invocation of the
+ since_last_period value contains the elapsed time which has occurred since
+ the last invocation of the ``rtems_rate_monotonic_period`` directive and
+ the ``executed_since_last_period`` contains how much processor time the
+ owning task has consumed since the invocation of the
``rtems_rate_monotonic_period`` directive. In addition, the
- postponed_jobs_count value contains the count of jobs which are not released yet.
+ ``postponed_jobs_count value`` contains the count of jobs which are not
+ released yet.
NOTES:
This directive will not cause the running task to be preempted.
@@ -912,11 +919,12 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_get_statistics:
.. index:: get statistics of period
.. index:: obtain statistics of period
.. index:: rtems_rate_monotonic_get_statistics
+.. _rtems_rate_monotonic_get_statistics:
+
RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
---------------------------------------------------------------
@@ -981,10 +989,11 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_reset_statistics:
.. index:: reset statistics of period
.. index:: rtems_rate_monotonic_reset_statistics
+.. _rtems_rate_monotonic_reset_statistics:
+
RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period
---------------------------------------------------------------
@@ -1015,10 +1024,11 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_reset_all_statistics:
.. index:: reset statistics of all periods
.. index:: rtems_rate_monotonic_reset_all_statistics
+.. _rtems_rate_monotonic_reset_all_statistics:
+
RATE_MONOTONIC_RESET_ALL_STATISTICS - Reset statistics for all periods
----------------------------------------------------------------------
@@ -1041,11 +1051,12 @@ NOTES:
\clearpage
-.. _rtems_rate_monotonic_report_statistics:
.. index:: print period statistics report
.. index:: period statistics report
.. index:: rtems_rate_monotonic_report_statistics
+.. _rtems_rate_monotonic_report_statistics:
+
RATE_MONOTONIC_REPORT_STATISTICS - Print period statistics report
-----------------------------------------------------------------
diff --git a/c-user/region_manager.rst b/c-user/region_manager.rst
index 9867a72..1bebd8a 100644
--- a/c-user/region_manager.rst
+++ b/c-user/region_manager.rst
@@ -224,9 +224,10 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_region_create:
.. index:: create a region
+.. _rtems_region_create:
+
REGION_CREATE - Create a region
-------------------------------
@@ -300,11 +301,12 @@ NOTES:
\clearpage
-.. _rtems_region_ident:
.. index:: get ID of a region
.. index:: obtain ID of a region
.. index:: rtems_region_ident
+.. _rtems_region_ident:
+
REGION_IDENT - Get ID of a region
---------------------------------
@@ -342,10 +344,11 @@ NOTES:
\clearpage
-.. _rtems_region_delete:
.. index:: delete a region
.. index:: rtems_region_delete
+.. _rtems_region_delete:
+
REGION_DELETE - Delete a region
-------------------------------
@@ -383,11 +386,12 @@ NOTES:
\clearpage
-.. _rtems_region_extend:
.. index:: add memory to a region
.. index:: region, add memory
.. index:: rtems_region_extend
+.. _rtems_region_extend:
+
REGION_EXTEND - Add memory to a region
--------------------------------------
@@ -436,10 +440,11 @@ NOTES:
\clearpage
-.. _rtems_region_get_segment:
.. index:: get segment from region
.. index:: rtems_region_get_segment
+.. _rtems_region_get_segment:
+
REGION_GET_SEGMENT - Get segment from a region
----------------------------------------------
@@ -522,10 +527,11 @@ NOTES:
\clearpage
-.. _rtems_region_return_segment:
.. index:: return segment to region
.. index:: rtems_region_return_segment
+.. _rtems_region_return_segment:
+
REGION_RETURN_SEGMENT - Return segment to a region
--------------------------------------------------
@@ -571,10 +577,11 @@ NOTES:
\clearpage
-.. _rtems_region_get_segment_size:
.. index:: get size of segment
.. index:: rtems_region_get_segment_size
+.. _rtems_region_get_segment_size:
+
REGION_GET_SEGMENT_SIZE - Obtain size of a segment
--------------------------------------------------
@@ -613,10 +620,11 @@ NOTES:
\clearpage
-.. _rtems_region_resize_segment:
.. index:: resize segment
.. index:: rtems_region_resize_segment
+.. _rtems_region_resize_segment:
+
REGION_RESIZE_SEGMENT - Change size of a segment
------------------------------------------------
diff --git a/c-user/semaphore_manager.rst b/c-user/semaphore_manager.rst
index 6d95708..27080e0 100644
--- a/c-user/semaphore_manager.rst
+++ b/c-user/semaphore_manager.rst
@@ -324,10 +324,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_semaphore_create:
.. index:: create a semaphore
.. index:: rtems_semaphore_create
+.. _rtems_semaphore_create:
+
SEMAPHORE_CREATE - Create a semaphore
-------------------------------------
@@ -436,11 +437,12 @@ NOTES:
\clearpage
-.. _rtems_semaphore_ident:
.. index:: get ID of a semaphore
.. index:: obtain ID of a semaphore
.. index:: rtems_semaphore_ident
+.. _rtems_semaphore_ident:
+
SEMAPHORE_IDENT - Get ID of a semaphore
---------------------------------------
@@ -488,10 +490,11 @@ NOTES:
\clearpage
-.. _rtems_semaphore_delete:
.. index:: delete a semaphore
.. index:: rtems_semaphore_delete
+.. _rtems_semaphore_delete:
+
SEMAPHORE_DELETE - Delete a semaphore
-------------------------------------
@@ -544,11 +547,12 @@ NOTES:
\clearpage
-.. _rtems_semaphore_obtain:
.. index:: obtain a semaphore
.. index:: lock a semaphore
.. index:: rtems_semaphore_obtain
+.. _rtems_semaphore_obtain:
+
SEMAPHORE_OBTAIN - Acquire a semaphore
--------------------------------------
@@ -643,11 +647,12 @@ NOTES:
\clearpage
-.. _rtems_semaphore_release:
.. index:: release a semaphore
.. index:: unlock a semaphore
.. index:: rtems_semaphore_release
+.. _rtems_semaphore_release:
+
SEMAPHORE_RELEASE - Release a semaphore
---------------------------------------
@@ -704,11 +709,12 @@ NOTES:
\clearpage
-.. _rtems_semaphore_flush:
.. index:: flush a semaphore
.. index:: unblock all tasks waiting on a semaphore
.. index:: rtems_semaphore_flush
+.. _rtems_semaphore_flush:
+
SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
----------------------------------------------------------
@@ -760,10 +766,11 @@ NOTES:
\clearpage
-.. _rtems_semaphore_set_priority:
.. index:: set priority by scheduler for a semaphore
.. index:: rtems_semaphore_set_priority
+.. _rtems_semaphore_set_priority:
+
SEMAPHORE_SET_PRIORITY - Set priority by scheduler for a semaphore
------------------------------------------------------------------
diff --git a/c-user/signal_manager.rst b/c-user/signal_manager.rst
index 6b74854..5e233fd 100644
--- a/c-user/signal_manager.rst
+++ b/c-user/signal_manager.rst
@@ -211,11 +211,12 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_signal_catch:
.. index:: establish an ASR
.. index:: install an ASR
.. index:: rtems_signal_catch
+.. _rtems_signal_catch:
+
SIGNAL_CATCH - Establish an ASR
-------------------------------
@@ -272,10 +273,11 @@ NOTES:
\clearpage
-.. _rtems_signal_send:
.. index:: send signal set
.. index:: rtems_signal_send
+.. _rtems_signal_send:
+
SIGNAL_SEND - Send signal set to a task
---------------------------------------
diff --git a/c-user/symmetric_multiprocessing_services.rst b/c-user/symmetric_multiprocessing_services.rst
index 0cdf1ef..a2776f2 100644
--- a/c-user/symmetric_multiprocessing_services.rst
+++ b/c-user/symmetric_multiprocessing_services.rst
@@ -327,9 +327,9 @@ thread. During a context switch from the executing thread to the heir thread,
the value of each task variable is saved to the thread control block of the
executing thread and restored from the thread control block of the heir thread.
This is inherently broken if more than one executing thread exists.
-Alternatives to task variables are POSIX keys and :ref:`TLS <TLS>`. All use
-cases of task variables in the RTEMS code base were replaced with alternatives.
-The task variable API has been removed in RTEMS 5.1.
+Alternatives to task variables are POSIX keys and :term:`TLS`. All use cases
+of task variables in the RTEMS code base were replaced with alternatives. The
+task variable API has been removed in RTEMS 5.1.
Highest Priority Thread Never Walks Alone
-----------------------------------------
diff --git a/c-user/task_manager.rst b/c-user/task_manager.rst
index 8934315..8917fba 100644
--- a/c-user/task_manager.rst
+++ b/c-user/task_manager.rst
@@ -598,10 +598,11 @@ related constants, usage, and status codes.
\clearpage
-.. _rtems_task_create:
.. index:: create a task
.. index:: rtems_task_create
+.. _rtems_task_create:
+
TASK_CREATE - Create a task
---------------------------
@@ -743,10 +744,11 @@ NOTES:
\clearpage
-.. _rtems_task_ident:
.. index:: get ID of a task
.. index:: rtems_task_ident
+.. _rtems_task_ident:
+
TASK_IDENT - Get ID of a task
-----------------------------
@@ -797,10 +799,11 @@ NOTES:
\clearpage
-.. _rtems_task_self:
.. index:: obtain ID of caller
.. index:: rtems_task_self
+.. _rtems_task_self:
+
TASK_SELF - Obtain ID of caller
-------------------------------
@@ -823,10 +826,11 @@ NOTES:
\clearpage
-.. _rtems_task_start:
.. index:: starting a task
.. index:: rtems_task_start
+.. _rtems_task_start:
+
TASK_START - Start a task
-------------------------
@@ -877,10 +881,11 @@ NOTES:
\clearpage
-.. _rtems_task_restart:
.. index:: restarting a task
.. index:: rtems_task_restart
+.. _rtems_task_restart:
+
TASK_RESTART - Restart a task
-----------------------------
@@ -939,10 +944,11 @@ NOTES:
\clearpage
-.. _rtems_task_delete:
.. index:: deleting a task
.. index:: rtems_task_delete
+.. _rtems_task_delete:
+
TASK_DELETE - Delete a task
---------------------------
@@ -995,10 +1001,11 @@ NOTES:
\clearpage
-.. _rtems_task_suspend:
.. index:: suspending a task
.. index:: rtems_task_suspend
+.. _rtems_task_suspend:
+
TASK_SUSPEND - Suspend a task
-----------------------------
@@ -1042,10 +1049,11 @@ NOTES:
\clearpage
-.. _rtems_task_resume:
.. index:: resuming a task
.. index:: rtems_task_resume
+.. _rtems_task_resume:
+
TASK_RESUME - Resume a task
---------------------------
@@ -1087,10 +1095,11 @@ NOTES:
\clearpage
-.. _rtems_task_is_suspended:
.. index:: is task suspended
.. index:: rtems_task_is_suspended
+.. _rtems_task_is_suspended:
+
TASK_IS_SUSPENDED - Determine if a task is Suspended
----------------------------------------------------
@@ -1125,13 +1134,14 @@ NOTES:
\clearpage
-.. _rtems_task_set_priority:
.. index:: rtems_task_set_priority
.. index:: current task priority
.. index:: set task priority
.. index:: get task priority
.. index:: obtain task priority
+.. _rtems_task_set_priority:
+
TASK_SET_PRIORITY - Set task priority
-------------------------------------
@@ -1189,12 +1199,13 @@ NOTES:
\clearpage
-.. _rtems_task_get_priority:
.. index:: rtems_task_get_priority
.. index:: current task priority
.. index:: get task priority
.. index:: obtain task priority
+.. _rtems_task_get_priority:
+
TASK_GET_PRIORITY - Get task priority
-------------------------------------
@@ -1238,7 +1249,6 @@ NOTES:
\clearpage
-.. _rtems_task_mode:
.. index:: current task mode
.. index:: set task mode
.. index:: get task mode
@@ -1247,6 +1257,8 @@ NOTES:
.. index:: obtain task mode
.. index:: rtems_task_mode
+.. _rtems_task_mode:
+
TASK_MODE - Change the current task mode
----------------------------------------
@@ -1317,11 +1329,12 @@ NOTES:
\clearpage
-.. _rtems_task_wake_after:
.. index:: delay a task for an interval
.. index:: wake up after an interval
.. index:: rtems_task_wake_after
+.. _rtems_task_wake_after:
+
TASK_WAKE_AFTER - Wake up after interval
----------------------------------------
@@ -1360,11 +1373,12 @@ NOTES:
\clearpage
-.. _rtems_task_wake_when:
.. index:: delay a task until a wall time
.. index:: wake up at a wall time
.. index:: rtems_task_wake_when
+.. _rtems_task_wake_when:
+
TASK_WAKE_WHEN - Wake up when specified
---------------------------------------
@@ -1616,10 +1630,11 @@ NOTES:
\clearpage
-.. _rtems_task_iterate:
.. index:: iterate over all threads
.. index:: rtems_task_iterate
+.. _rtems_task_iterate:
+
TASK_ITERATE - Iterate Over Tasks
---------------------------------
@@ -1658,9 +1673,10 @@ Deprecated and Removed Directives
\clearpage
-.. _rtems_iterate_over_all_threads:
.. index:: rtems_iterate_over_all_threads
+.. _rtems_iterate_over_all_threads:
+
ITERATE_OVER_ALL_THREADS - Iterate Over Tasks
---------------------------------------------
@@ -1697,10 +1713,11 @@ NOTES:
\clearpage
-.. _rtems_task_get_note:
.. index:: get task notepad entry
.. index:: rtems_task_get_note
+.. _rtems_task_get_note:
+
TASK_GET_NOTE - Get task notepad entry
--------------------------------------
@@ -1750,10 +1767,11 @@ NOTES:
\clearpage
-.. _rtems_task_set_note:
.. index:: set task notepad entry
.. index:: rtems_task_set_note
+.. _rtems_task_set_note:
+
TASK_SET_NOTE - Set task notepad entry
--------------------------------------
@@ -1802,12 +1820,13 @@ NOTES:
\clearpage
-.. _rtems_task_variable_add:
.. index:: per-task variable
.. index:: task private variable
.. index:: task private data
.. index:: rtems_task_variable_add
+.. _rtems_task_variable_add:
+
TASK_VARIABLE_ADD - Associate per task variable
-----------------------------------------------
@@ -1865,11 +1884,12 @@ NOTES:
\clearpage
-.. _rtems_task_variable_get:
.. index:: get per-task variable
.. index:: obtain per-task variable
.. index:: rtems_task_variable_get
+.. _rtems_task_variable_get:
+
TASK_VARIABLE_GET - Obtain value of a per task variable
-------------------------------------------------------
@@ -1922,12 +1942,13 @@ NOTES:
\clearpage
-.. _rtems_task_variable_delete:
.. index:: per-task variable
.. index:: task private variable
.. index:: task private data
.. index:: rtems_task_variable_delete
+.. _rtems_task_variable_delete:
+
TASK_VARIABLE_DELETE - Remove per task variable
-----------------------------------------------
diff --git a/c-user/timer_manager.rst b/c-user/timer_manager.rst
index ca80dfd..8e41b47 100644
--- a/c-user/timer_manager.rst
+++ b/c-user/timer_manager.rst
@@ -194,10 +194,11 @@ related constants, usage, and status codes.
.. raw:: latex
\clearpage
-.. _rtems_timer_create:
.. index:: create a timer
.. index:: rtems_timer_create
+.. _rtems_timer_create:
+
TIMER_CREATE - Create a timer
-----------------------------
@@ -240,10 +241,11 @@ NOTES:
\clearpage
-.. _rtems_timer_ident:
.. index:: obtain the ID of a timer
.. index:: rtems_timer_ident
+.. _rtems_timer_ident:
+
TIMER_IDENT - Get ID of a timer
-------------------------------
@@ -280,10 +282,11 @@ NOTES:
\clearpage
-.. _rtems_timer_cancel:
.. index:: cancel a timer
.. index:: rtems_timer_cancel
+.. _rtems_timer_cancel:
+
TIMER_CANCEL - Cancel a timer
-----------------------------
@@ -315,10 +318,11 @@ NOTES:
\clearpage
-.. _rtems_timer_delete:
.. index:: delete a timer
.. index:: rtems_timer_delete
+.. _rtems_timer_delete:
+
TIMER_DELETE - Delete a timer
-----------------------------
@@ -354,10 +358,11 @@ NOTES:
\clearpage
-.. _rtems_timer_fire_after:
.. index:: fire a timer after an interval
.. index:: rtems_timer_fire_after
+.. _rtems_timer_fire_after:
+
TIMER_FIRE_AFTER - Fire timer after interval
--------------------------------------------
@@ -398,10 +403,11 @@ NOTES:
\clearpage
-.. _rtems_timer_fire_when:
.. index:: fire a timer at wall time
.. index:: rtems_timer_fire_when
+.. _rtems_timer_fire_when:
+
TIMER_FIRE_WHEN - Fire timer when specified
-------------------------------------------
@@ -446,10 +452,11 @@ NOTES:
\clearpage
-.. _rtems_timer_initiate_server:
.. index:: initiate the Timer Server
.. index:: rtems_timer_initiate_server
+.. _rtems_timer_initiate_server:
+
TIMER_INITIATE_SERVER - Initiate server for task-based timers
-------------------------------------------------------------
@@ -491,10 +498,11 @@ NOTES:
\clearpage
-.. _rtems_timer_server_fire_after:
.. index:: fire task-based a timer after an interval
.. index:: rtems_timer_server_fire_after
+.. _rtems_timer_server_fire_after:
+
TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
--------------------------------------------------------------
@@ -539,10 +547,11 @@ NOTES:
\clearpage
-.. _rtems_timer_server_fire_when:
.. index:: fire a task-based timer at wall time
.. index:: rtems_timer_server_fire_when
+.. _rtems_timer_server_fire_when:
+
TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
-------------------------------------------------------------
@@ -591,10 +600,11 @@ NOTES:
\clearpage
-.. _rtems_timer_reset:
.. index:: reset a timer
.. index:: rtems_timer_reset
+.. _rtems_timer_reset:
+
TIMER_RESET - Reset an interval timer
-------------------------------------
diff --git a/c-user/timespec_helpers.rst b/c-user/timespec_helpers.rst
index 115833b..e169809 100644
--- a/c-user/timespec_helpers.rst
+++ b/c-user/timespec_helpers.rst
@@ -125,10 +125,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_timespec_set:
.. index:: set struct timespec instance
.. index:: rtems_timespec_set
+.. _rtems_timespec_set:
+
TIMESPEC_SET - Set struct timespec Instance
-------------------------------------------
@@ -156,9 +157,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_zero:
.. index:: rtems_timespec_zero
+.. _rtems_timespec_zero:
+
TIMESPEC_ZERO - Zero struct timespec Instance
---------------------------------------------
@@ -183,9 +185,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_is_valid:
.. index:: rtems_timespec_is_valid
+.. _rtems_timespec_is_valid:
+
TIMESPEC_IS_VALID - Check validity of a struct timespec instance
----------------------------------------------------------------
@@ -212,9 +215,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_add_to:
.. index:: rtems_timespec_add_to
+.. _rtems_timespec_add_to:
+
TIMESPEC_ADD_TO - Add Two struct timespec Instances
---------------------------------------------------
@@ -241,9 +245,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_subtract:
.. index:: rtems_timespec_subtract
+.. _rtems_timespec_subtract:
+
TIMESPEC_SUBTRACT - Subtract Two struct timespec Instances
----------------------------------------------------------
@@ -275,9 +280,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_divide:
.. index:: rtems_timespec_divide
+.. _rtems_timespec_divide:
+
TIMESPEC_DIVIDE - Divide Two struct timespec Instances
------------------------------------------------------
@@ -315,9 +321,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_divide_by_integer:
.. index:: rtems_timespec_divide_by_integer
+.. _rtems_timespec_divide_by_integer:
+
TIMESPEC_DIVIDE_BY_INTEGER - Divide a struct timespec Instance by an Integer
----------------------------------------------------------------------------
@@ -346,9 +353,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_less_than:
.. index:: rtems_timespec_less_than
+.. _rtems_timespec_less_than:
+
TIMESPEC_LESS_THAN - Less than operator
---------------------------------------
@@ -376,9 +384,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_greater_than:
.. index:: rtems_timespec_greater_than
+.. _rtems_timespec_greater_than:
+
TIMESPEC_GREATER_THAN - Greater than operator
---------------------------------------------
@@ -404,9 +413,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_equal_to:
.. index:: rtems_timespec_equal_to
+.. _rtems_timespec_equal_to:
+
TIMESPEC_EQUAL_TO - Check equality of timespecs
-----------------------------------------------
@@ -432,9 +442,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_get_seconds:
.. index:: rtems_timespec_get_seconds
+.. _rtems_timespec_get_seconds:
+
TIMESPEC_GET_SECONDS - Get Seconds Portion of struct timespec Instance
----------------------------------------------------------------------
@@ -460,9 +471,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_get_nanoseconds:
.. index:: rtems_timespec_get_nanoseconds
+.. _rtems_timespec_get_nanoseconds:
+
TIMESPEC_GET_NANOSECONDS - Get Nanoseconds Portion of the struct timespec Instance
----------------------------------------------------------------------------------
@@ -488,9 +500,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_to_ticks:
.. index:: rtems_timespec_to_ticks
+.. _rtems_timespec_to_ticks:
+
TIMESPEC_TO_TICKS - Convert struct timespec Instance to Ticks
-------------------------------------------------------------
@@ -515,9 +528,10 @@ NOTES:
\clearpage
-.. _rtems_timespec_from_ticks:
.. index:: rtems_timespec_from_ticks
+.. _rtems_timespec_from_ticks:
+
TIMESPEC_FROM_TICKS - Convert Ticks to struct timespec Representation
---------------------------------------------------------------------
diff --git a/c-user/user_extensions.rst b/c-user/user_extensions.rst
index 84af815..c83dcb0 100644
--- a/c-user/user_extensions.rst
+++ b/c-user/user_extensions.rst
@@ -4,9 +4,10 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
-.. _User Extensions Manager:
.. index:: user extensions
+.. _User Extensions Manager:
+
User Extensions Manager
***********************
@@ -424,10 +425,11 @@ sequence, related constants, usage, and status codes.
\clearpage
-.. _rtems_extension_create:
.. index:: create an extension set
.. index:: rtems_extension_create
+.. _rtems_extension_create:
+
EXTENSION_CREATE - Create a extension set
-----------------------------------------
@@ -472,11 +474,12 @@ NOTES:
\clearpage
-.. _rtems_extension_ident:
.. index:: get ID of an extension set
.. index:: obtain ID of an extension set
.. index:: rtems_extension_ident
+.. _rtems_extension_ident:
+
EXTENSION_IDENT - Get ID of a extension set
-------------------------------------------
@@ -513,10 +516,11 @@ NOTES:
\clearpage
-.. _rtems_extension_delete:
.. index:: delete an extension set
.. index:: rtems_extension_delete
+.. _rtems_extension_delete:
+
EXTENSION_DELETE - Delete a extension set
-----------------------------------------
diff --git a/user/additional/index.rst b/user/additional/index.rst
deleted file mode 100644
index c276f03..0000000
--- a/user/additional/index.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. comment SPDX-License-Identifier: CC-BY-SA-4.0
-
-
-Additional Information
-**********************
-
-Information and details that do not belong in other sections go here.
-
-
-
-Important Terms
-===============
-
-Waf
----
-Waf build system. For more information see http://www.waf.io/
-
-
-Test Suite
-----------
-RTEMS test suite located in the ``testsuites/`` directory.
-
-
-
-Command List
-============
-
-List of all available commands in RTEMS
-
-
-Program List
-============
-
-List of all available programs in RTEMS
diff --git a/user/installation/prefixes-sandboxing.rst b/user/installation/prefixes-sandboxing.rst
index c7dbdca..55acd54 100644
--- a/user/installation/prefixes-sandboxing.rst
+++ b/user/installation/prefixes-sandboxing.rst
@@ -3,8 +3,8 @@
.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
.. comment: All rights reserved.
-.. _prefixes:
.. index:: Prefixes
+.. _prefixes:
Prefixes
========
diff --git a/user/start/index.rst b/user/start/index.rst
index efbe6c6..7282a5d 100644
--- a/user/start/index.rst
+++ b/user/start/index.rst
@@ -3,6 +3,8 @@
.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
.. comment: All rights reserved.
+.. index:: Quick Start
+
Quick Start
***********
@@ -18,9 +20,9 @@ to complete successfully. :ref:`host-computer` details what is needed for the
supported host operating systems. If Windows is being used it is recommended
following the procedure in :ref:`microsoft-windows` first.
-Their are many ways and locations a suitable environment can be set up. A
+There are many ways and locations a suitable environment can be set up. A
common factor that defines the final location of tools and projects is the
-place you have suitable storage. :ref:`prefixes` and :ref:`project-sandboxing`
+place you have suitable storage. :ref:`Prefixes` and :ref:`project-sandboxing`
provide detailed examples of possible locations and set ups .
This procedure installs a developer set up using the RTEMS Git repositories on
diff --git a/user/tools/index.rst b/user/tools/index.rst
index 6cf3509..00d6b21 100644
--- a/user/tools/index.rst
+++ b/user/tools/index.rst
@@ -19,6 +19,5 @@ developers.
linker
symbols
exeinfo
- trace-linker
bsp-builder
tester
diff --git a/user/tools/simulation.rst b/user/tools/simulation.rst
deleted file mode 100644
index 134058c..0000000
--- a/user/tools/simulation.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-.. comment SPDX-License-Identifier: CC-BY-SA-4.0
-
-Simulation
-==========
-.. index:: Simulation Tools, rtems-run
-
-XXX: simulation
-
-
-rtems-run
----------
-
-XXX: rtems-run
diff --git a/user/tools/tester.rst b/user/tools/tester.rst
index 6e79799..0c07415 100644
--- a/user/tools/tester.rst
+++ b/user/tools/tester.rst
@@ -3,34 +3,34 @@
.. comment: Copyright (c) 2017 Chris Johns <chrisj@rtems.org>
.. comment: All rights reserved.
-RTEMS Tester
-============
+.. _rtems-tester-command:
-.. index:: Tools, rtems-tester
+RTEMS Tester and Run Commands
+=============================
-The RTEMS Tester is a test framework. It includes a command line interface to
-run tests on supported targets. The framework provides back-end support for
-common simulators and debuggers. The board support package (BSP) configurations
-for RTEMS are provided and can be used to run all the tests provided with
-RTEMS. The framework is not specific to RTEMS and can be configured to run any
-suitable application.
+.. index:: Tools, rtems-test, rtems-run
+
+The RTEMS Tester is a test tool that provides a command line interface to run
+test executable on supported targets. The tool provides back-end support for
+common simulators, debuggers and boot loaders. Board support package (BSP)
+configurations for RTEMS are provided and can be used to run all the tests in
+the RTEMS test suite. The tool and it's framework is not specific to RTEMS and
+can be configured to run any suitable application.
RTEMS is an embedded operating system and is cross-compiled on a range of host
machines. The executables run on the target hardware and this can vary widely
from open source simulators, commercial simulators, debuggers with simulators,
-to debuggers with hardware specific pods and devices. Testing RTEMS requires
-the cross-compiled test executable is transferred to the target hardware,
-executed and the output returned to the host where it is analyzed to determine
-the test result. The RTEMS Tester provides a framework to do this.
-
-Running all the RTEMS tests on your target is very important. It provides you
-with a traceable record showing that your RTEMS version and its tools are
-working at the level the RTEMS development team expect when releasing
-RTEMS. Being able to easily run the tests and verify the results is critical in
-maintaining a high standard.
-
-This document is for users of the RTEMS Tester as well as those wanting to
-develop, extend and investigate the RTEMS Tester.
+debuggers with hardware specific pods and devices to targe boot
+loaders. Testing RTEMS requires the cross-compiled test executable is
+transferred to the target hardware, executed and the output captured and
+returned to the test host where it is analyzed to determine the test
+result.
+
+Running the RTEMS tests on your target is very important. It provides you with
+a traceable record showing that your RTEMS version and its tools are working at
+the level the RTEMS development team expect when releasing RTEMS. Being able to
+easily run the tests and verify the results is critical in maintaining a high
+standard.
Available BSP testers
---------------------
@@ -42,9 +42,11 @@ You can list the available BSP testers with:
$ rtems-test --list-bsps
arm920
beagleboardxm
+ beagleboneblack
jmr3904-run
jmr3904
mcf5235
+ pc
psim-run
psim
realview_pbx_a9_qemu
@@ -54,6 +56,7 @@ You can list the available BSP testers with:
xilinx_zynq_a9_qemu_smp
xilinx_zynq_zc706
xilinx_zynq_zc706_qemu
+ xilinx_zynq_zedboard
.. note:: The list is growing all the time and if your BSP is not supported we
encourage you to add it and submit the configuration back to the
@@ -70,7 +73,7 @@ Building RTEMS Tests
--------------------
Build the RTEMS Kernel (See :ref:`rtems-kernel`) by cloning the repository,
-running the ``bootstrap`` procecure, building and finally installing the
+running the ``bootstrap`` procedure, building and finally installing the
kernel. Be sure to enable tests by using ``--enable-tests`` option with
configure after running ``bootstrap``.
@@ -80,15 +83,20 @@ configure after running ``bootstrap``.
--enable-tests --enable-rtemsbsp=erc32
$ make
-Add the -j option to the make command with the number of cores to run the
-build parallel where it can.
+Add the `-j` option to the make command with the number of cores to run a
+parallel build.
Building all the tests takes time and it uses more disk so be patient. When
-finished all the tests will be built and ready to run. Before running all the
-tests it is a good idea to run the ``hello`` test. The ``hello`` test is an
-RTEMS version of the classic "Hello World" example and running it shows you
-have a working tool chain and build of RTEMS ready to run the tests. Using the
-run command:
+finished all the tests will have been built. Some BSPs may require a post-build
+process to be run on the RTEMS ELF executable to create an image suitable for
+execution. This can be built into the configuration script and the tester will
+perform a pre-test command to covert the executable to a suitable format for
+your target.
+
+Before running all the tests it is a good idea to run the ``hello`` test. The
+``hello`` test is an RTEMS version of the classic "Hello World" example and
+running it shows you have a working tool chain and build of RTEMS ready to run
+the tests. Using the run with the ERC32 BSP the command is:
.. code-block:: shell
@@ -186,8 +194,6 @@ BSP build tree:
Average test time: 0:00:27.963000
Testing time : 0:06:03.519012
-
-
* The RTEMS Tester's test command. In this example we are using an absolute
path.
* The ``--log`` option sends the output to a log file. By default only failed