[rtems commit] c_user: Remove errors and warnings.
Chris Johns
chrisj at rtems.org
Fri Oct 28 12:56:04 UTC 2016
Module: rtems
Branch: master
Commit: 9aafb39c8845e254209476b9f0ce642aec12d9ae
Changeset: http://git.rtems.org/rtems/commit/?id=9aafb39c8845e254209476b9f0ce642aec12d9ae
Author: Chris Johns <chrisj at rtems.org>
Date: Fri Oct 28 05:56:02 2016 -0700
c_user: Remove errors and warnings.
---
c_user/board_support_packages.rst | 2 +-
c_user/clock_manager.rst | 1 +
c_user/configuring_a_system.rst | 295 +++++++++++++++++++++++++-
c_user/fatal_error.rst | 2 +
c_user/glossary.rst | 2 +-
c_user/key_concepts.rst | 2 +-
c_user/linker_sets.rst | 2 +
c_user/overview.rst | 2 +-
c_user/semaphore_manager.rst | 22 ++
c_user/symmetric_multiprocessing_services.rst | 28 +--
c_user/user_extensions.rst | 2 +
11 files changed, 338 insertions(+), 22 deletions(-)
diff --git a/c_user/board_support_packages.rst b/c_user/board_support_packages.rst
index a253aa8..872ff71 100644
--- a/c_user/board_support_packages.rst
+++ b/c_user/board_support_packages.rst
@@ -207,7 +207,7 @@ deallocating the context area, the task initiation and reinitiation extensions
would be responsible for priming the context area, and the task context switch
extension would save and restore the context of the device.
-For more information on user extensions, refer to `User Extensions Manager`_.
+For more information on user extensions, refer to :ref:`User Extensions Manager`.
Multiprocessor Communications Interface (MPCI)
==============================================
diff --git a/c_user/clock_manager.rst b/c_user/clock_manager.rst
index de96010..559864f 100644
--- a/c_user/clock_manager.rst
+++ b/c_user/clock_manager.rst
@@ -62,6 +62,7 @@ tick has occurred. Elapsed time is measured in ticks. A tick is defined to be
an integral number of microseconds which is specified by the user in the
Configuration Table.
+.. _Time and Date Data Structures:
Time and Date Data Structures
-----------------------------
diff --git a/c_user/configuring_a_system.rst b/c_user/configuring_a_system.rst
index 1da51df..fdd255a 100644
--- a/c_user/configuring_a_system.rst
+++ b/c_user/configuring_a_system.rst
@@ -4,10 +4,12 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. _Configuring a System:
+
Configuring a System
####################
-.. COMMENT: === Introduction ===
+.. index:: configuring a system
Introduction
============
@@ -68,6 +70,8 @@ tables is configured.
.. COMMENT: === Sizing the RTEMS Workspace ===
+.. _Sizing the RTEMS Workspace:
+
Sizing the RTEMS Workspace
==========================
@@ -183,7 +187,7 @@ Format to be followed for making changes in this file
- If the data type is an integer, then it can have numbers, characters (in
case the value is defined using another macro) and arithmetic operations
- (+, -, *, /).
+ (+, -, \*, /).
- If the data type is a function pointer the first character should be an
alphabet or an underscore. The rest of the string can be alphanumeric.
@@ -296,6 +300,8 @@ things, the application implicitly used the following defaults:
.. COMMENT: === Unlimited Objects ===
+.. _Unlimited Objects:
+
Unlimited Objects
-----------------
@@ -395,6 +401,8 @@ largely unpredictable time in the field.
.. COMMENT: === Per Object Class Unlimited Object Instances ===
+.. _Per Object Class Unlimited Object Instances:
+
Per Object Class Unlimited Object Instances
-------------------------------------------
.. index:: rtems_resource_unlimited
@@ -424,6 +432,8 @@ macros.
.. COMMENT: === Unlimited Object Instances ===
+.. _Unlimited Object Instances:
+
Unlimited Object Instances
--------------------------
@@ -434,6 +444,8 @@ responsible for enabling unlimited objects and specifying the allocation size.
.. COMMENT: === CONFIGURE_UNLIMITED_OBJECTS ===
+.. _Enable Unlimited Object Instances:
+
Enable Unlimited Object Instances
---------------------------------
.. index:: CONFIGURE_UNLIMITED_OBJECTS
@@ -464,6 +476,8 @@ memory for both RTEMS and application memory allocations.
.. COMMENT: === CONFIGURE_UNLIMITED_ALLOCATION_SIZE ===
+.. _Specify Unlimited Objects Allocation Size:
+
Specify Unlimited Objects Allocation Size
-----------------------------------------
@@ -507,6 +521,8 @@ supported by ``<rtems/confdefs.h>``.
.. COMMENT: === CONFIGURE_MAXIMUM_TASKS ===
+.. _Specify Maximum Classic API Tasks:
+
Specify Maximum Classic API Tasks
---------------------------------
.. index:: CONFIGURE_MAXIMUM_TASKS
@@ -551,6 +567,8 @@ enable floating point support.
.. COMMENT: === CONFIGURE_MAXIMUM_TIMERS ===
+.. _Specify Maximum Classic API Timers:
+
Specify Maximum Classic API Timers
----------------------------------
.. index:: CONFIGURE_MAXIMUM_TIMERS
@@ -578,6 +596,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_SEMAPHORES ===
+.. _Specify Maximum Classic API Semaphores:
+
Specify Maximum Classic API Semaphores
--------------------------------------
.. index:: CONFIGURE_MAXIMUM_SEMAPHORES
@@ -605,6 +625,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_MRSP_SEMAPHORES ===
+.. _Specify Maximum Classic API Semaphores usable with MrsP:
+
Specify Maximum Classic API Semaphores usable with MrsP
-------------------------------------------------------
.. index:: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
@@ -635,6 +657,8 @@ thus no extra memory is necessary.
.. COMMENT: === CONFIGURE_MAXIMUM_MESSAGE_QUEUES ===
+.. _Specify Maximum Classic API Message Queues:
+
Specify Maximum Classic API Message Queues
------------------------------------------
.. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
@@ -662,6 +686,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_BARRIERS ===
+.. _Specify Maximum Classic API Barriers:
+
Specify Maximum Classic API Barriers
------------------------------------
.. index:: CONFIGURE_MAXIMUM_BARRIERS
@@ -689,6 +715,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_PERIODS ===
+.. _Specify Maximum Classic API Periods:
+
Specify Maximum Classic API Periods
-----------------------------------
.. index:: CONFIGURE_MAXIMUM_PERIODS
@@ -716,6 +744,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_PARTITIONS ===
+.. _Specify Maximum Classic API Partitions:
+
Specify Maximum Classic API Partitions
--------------------------------------
.. index:: CONFIGURE_MAXIMUM_PARTITIONS
@@ -743,6 +773,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_REGIONS ===
+.. _Specify Maximum Classic API Regions:
+
Specify Maximum Classic API Regions
-----------------------------------
.. index:: CONFIGURE_MAXIMUM_REGIONS
@@ -770,6 +802,8 @@ None.
.. COMMENT: === CONFIGURE_MAXIMUM_PORTS ===
+.. _Specify Maximum Classic API Ports:
+
Specify Maximum Classic API Ports
---------------------------------
.. index:: CONFIGURE_MAXIMUM_PORTS
@@ -797,6 +831,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_USER_EXTENSIONS ===
+.. _Specify Maximum Classic API User Extensions:
+
Specify Maximum Classic API User Extensions
-------------------------------------------
.. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
@@ -833,6 +869,8 @@ The following parameters control the generation of that table.
.. COMMENT: === CONFIGURE_RTEMS_INIT_TASKS_TABLE ===
+.. _Instantiate Classic API Initialization Task Table:
+
Instantiate Classic API Initialization Task Table
-------------------------------------------------
.. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
@@ -869,6 +907,8 @@ initialization tasks or threads.
.. COMMENT: === CONFIGURE_INIT_TASK_ENTRY_POINT ===
+.. _Specifying Classic API Initialization Task Entry Point:
+
Specifying Classic API Initialization Task Entry Point
------------------------------------------------------
.. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
@@ -898,6 +938,8 @@ this configuration parameter.
.. COMMENT: === CONFIGURE_INIT_TASK_NAME ===
+.. _Specifying Classic API Initialization Task Name:
+
Specifying Classic API Initialization Task Name
-----------------------------------------------
.. index:: CONFIGURE_INIT_TASK_NAME
@@ -925,6 +967,8 @@ None.
.. COMMENT: === CONFIGURE_INIT_TASK_STACK_SIZE ===
+.. _Specifying Classic API Initialization Task Stack Size:
+
Specifying Classic API Initialization Task Stack Size
-----------------------------------------------------
.. index:: CONFIGURE_INIT_TASK_STACK_SIZE
@@ -955,6 +999,8 @@ Task/Thread Stack Memory Above Minimum` for more information about
.. COMMENT: === CONFIGURE_INIT_TASK_PRIORITY ===
+.. _Specifying Classic API Initialization Task Priority:
+
Specifying Classic API Initialization Task Priority
---------------------------------------------------
.. index:: CONFIGURE_INIT_TASK_PRIORITY
@@ -983,6 +1029,8 @@ None.
.. COMMENT: === CONFIGURE_INIT_TASK_ATTRIBUTES ===
+.. _Specifying Classic API Initialization Task Attributes:
+
Specifying Classic API Initialization Task Attributes
-----------------------------------------------------
.. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
@@ -1010,6 +1058,8 @@ None.
.. COMMENT: === CONFIGURE_INIT_TASK_INITIAL_MODES ===
+.. _Specifying Classic API Initialization Task Modes:
+
Specifying Classic API Initialization Task Modes
------------------------------------------------
.. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
@@ -1038,6 +1088,8 @@ None.
.. COMMENT: === CONFIGURE_INIT_TASK_ARGUMENTS ===
+.. _Specifying Classic API Initialization Task Arguments:
+
Specifying Classic API Initialization Task Arguments
----------------------------------------------------
.. index:: CONFIGURE_INIT_TASK_ARGUMENTS
@@ -1065,6 +1117,8 @@ None.
.. COMMENT: === CONFIGURE_HAS_OWN_INIT_TASK_TABLE ===
+.. _Not Using Generated Initialization Tasks Table:
+
Not Using Generated Initialization Tasks Table
----------------------------------------------
.. index:: CONFIGURE_HAS_OWN_INIT_TASK_TABLE
@@ -1103,6 +1157,8 @@ time using the ``--enable-posix`` option.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_THREADS ===
+.. _Specify Maximum POSIX API Threads:
+
Specify Maximum POSIX API Threads
---------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
@@ -1144,6 +1200,8 @@ All POSIX threads have floating point enabled.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MUTEXES ===
+.. _Specify Maximum POSIX API Mutexes:
+
Specify Maximum POSIX API Mutexes
---------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_MUTEXES
@@ -1171,6 +1229,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES ===
+.. _Specify Maximum POSIX API Condition Variables:
+
Specify Maximum POSIX API Condition Variables
---------------------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES
@@ -1198,6 +1258,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_KEYS ===
+.. _Specify Maximum POSIX API Keys:
+
Specify Maximum POSIX API Keys
------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
@@ -1227,6 +1289,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_TIMERS ===
+.. _Specify Maximum POSIX API Timers:
+
Specify Maximum POSIX API Timers
--------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
@@ -1254,6 +1318,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS ===
+.. _Specify Maximum POSIX API Queued Signals:
+
Specify Maximum POSIX API Queued Signals
----------------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
@@ -1281,6 +1347,8 @@ None.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES ===
+.. _Specify Maximum POSIX API Message Queues:
+
Specify Maximum POSIX API Message Queues
----------------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
@@ -1310,6 +1378,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS ===
+.. _Specify Maximum POSIX API Message Queue Descriptors:
+
Specify Maximum POSIX API Message Queue Descriptors
---------------------------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS
@@ -1340,6 +1410,8 @@ equal to ``CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES``.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_SEMAPHORES ===
+.. _Specify Maximum POSIX API Semaphores:
+
Specify Maximum POSIX API Semaphores
------------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
@@ -1367,6 +1439,8 @@ None.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_BARRIERS ===
+.. _Specify Maximum POSIX API Barriers:
+
Specify Maximum POSIX API Barriers
----------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_BARRIERS
@@ -1394,6 +1468,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_SPINLOCKS ===
+.. _Specify Maximum POSIX API Spinlocks:
+
Specify Maximum POSIX API Spinlocks
-----------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_SPINLOCKS
@@ -1421,6 +1497,8 @@ This object class can be configured in unlimited allocation mode.
.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_RWLOCKS ===
+.. _Specify Maximum POSIX API Read/Write Locks:
+
Specify Maximum POSIX API Read/Write Locks
------------------------------------------
.. index:: CONFIGURE_MAXIMUM_POSIX_RWLOCKS
@@ -1457,6 +1535,8 @@ a single entry. The following parameters control the generation of that table.
.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_TABLE ===
+.. _Instantiate POSIX API Initialization Thread Table:
+
Instantiate POSIX API Initialization Thread Table
-------------------------------------------------
.. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
@@ -1494,6 +1574,8 @@ initialization tasks or threads.
.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT ===
+.. _Specifying POSIX API Initialization Thread Entry Point:
+
Specifying POSIX API Initialization Thread Entry Point
------------------------------------------------------
.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
@@ -1523,6 +1605,8 @@ provided in this configuration parameter.
.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE ===
+.. _Specifying POSIX API Initialization Thread Stack Size:
+
Specifying POSIX API Initialization Thread Stack Size
-----------------------------------------------------
.. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
@@ -1537,7 +1621,7 @@ Specifying POSIX API Initialization Thread Stack Size
Zero or positive.
*DEFAULT VALUE:*
- The default value is 2 * RTEMS_MINIMUM_STACK_SIZE.
+ The default value is 2 \* RTEMS_MINIMUM_STACK_SIZE.
**DESCRIPTION:**
@@ -1547,12 +1631,14 @@ initialization thread defined by the POSIX API Initialization Threads Table.
**NOTES:**
If the stack size specified is greater than the configured minimum, it must be
-accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``. See `Reserve Task/Thread
-Stack Memory Above Minimum`_ for more information about
+accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``. See :ref:`Reserve
+Task/Thread Stack Memory Above Minimum` for more information about
``CONFIGURE_EXTRA_TASK_STACKS``.
.. COMMENT: === CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE ===
+.. _Not Using Generated POSIX Initialization Threads Table:
+
Not Using Generated POSIX Initialization Threads Table
------------------------------------------------------
.. index:: CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
@@ -1590,6 +1676,7 @@ This section defines the general system configuration parameters supported by
.. COMMENT: === CONFIGURE_UNIFIED_WORK_AREAS ===
+.. _Separate or Unified Work Areas:
Separate or Unified Work Areas
------------------------------
@@ -1634,6 +1721,8 @@ Workspace.
.. COMMENT: === CONFIGURE_MICROSECONDS_PER_TICK ===
+.. _Length of Each Clock Tick:
+
Length of Each Clock Tick
-------------------------
.. index:: CONFIGURE_MICROSECONDS_PER_TICK
@@ -1679,6 +1768,8 @@ tick quantum.
.. COMMENT: === CONFIGURE_TICKS_PER_TIMESLICE ===
+.. _Specifying Timeslicing Quantum:
+
Specifying Timeslicing Quantum
------------------------------
.. index:: CONFIGURE_TICKS_PER_TIMESLICE
@@ -1708,6 +1799,8 @@ not configured.
.. COMMENT: === CONFIGURE_MAXIMUM_PRIORITY ===
+.. _Specifying the Number of Thread Priority Levels:
+
Specifying the Number of Thread Priority Levels
-----------------------------------------------
.. index:: CONFIGURE_MAXIMUM_PRIORITY
@@ -1754,6 +1847,8 @@ reduce memory usage by about three (3) kilobytes.
.. COMMENT: === CONFIGURE_MINIMUM_TASK_STACK_SIZE ===
+.. _Specifying the Minimum Task Size:
+
Specifying the Minimum Task Size
--------------------------------
.. index:: CONFIGURE_MINIMUM_TASK_STACK_SIZE
@@ -1793,6 +1888,8 @@ without performing analysis on actual consumption.
.. COMMENT: === CONFIGURE_INTERRUPT_STACK_SIZE ===
+.. _Configuring the Size of the Interrupt Stack:
+
Configuring the Size of the Interrupt Stack
-------------------------------------------
.. index:: CONFIGURE_INTERRUPT_STACK_SIZE
@@ -1828,6 +1925,7 @@ would be welcomed by the RTEMS Project.
.. COMMENT: === CONFIGURE_EXTRA_TASK_STACKS ===
+.. _Reserve Task/Thread Stack Memory Above Minimum:
Reserve Task/Thread Stack Memory Above Minimum
----------------------------------------------
@@ -1860,6 +1958,8 @@ larger then the minimum, then that memory is NOT accounted for by
.. COMMENT: === CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY ===
+.. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
+
Automatically Zeroing the RTEMS Workspace and C Program Heap
------------------------------------------------------------
.. index:: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
@@ -1894,6 +1994,8 @@ for RTEMS but is often assumed by support libraries.
.. COMMENT: === CONFIGURE_STACK_CHECKER_ENABLED ===
+.. _Enable The Task Stack Usage Checker:
+
Enable The Task Stack Usage Checker
-----------------------------------
.. index:: CONFIGURE_STACK_CHECKER_ENABLED
@@ -1924,6 +2026,8 @@ each context switch.
.. COMMENT: === CONFIGURE_INITIAL_EXTENSIONS ===
+.. _Specify Application Specific User Extensions:
+
Specify Application Specific User Extensions
--------------------------------------------
.. index:: CONFIGURE_INITIAL_EXTENSIONS
@@ -1962,6 +2066,8 @@ overflows are detected in hardware.
.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR_INIT ===
+.. _Custom Task Stack Allocator Initialization:
+
Custom Task Stack Allocator Initialization
------------------------------------------
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
@@ -1996,6 +2102,8 @@ A correctly configured system must configure the following to be consistent:
.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR ===
+.. _Custom Task Stack Allocator:
+
Custom Task Stack Allocator
---------------------------
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR
@@ -2032,6 +2140,8 @@ A correctly configured system must configure the following to be consistent:
.. COMMENT: === CONFIGURE_TASK_STACK_DEALLOCATOR ===
+.. _Custom Task Stack Deallocator:
+
Custom Task Stack Deallocator
-----------------------------
.. index:: CONFIGURE_TASK_STACK_DEALLOCATOR
@@ -2075,6 +2185,8 @@ 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:
+
Calculate Memory for a Single Classic Message API Message Queue
---------------------------------------------------------------
.. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
@@ -2113,6 +2225,8 @@ This macro is only used in support of ``CONFIGURE_MESSAGE_BUFFER_MEMORY``.
.. COMMENT: === CONFIGURE_MESSAGE_BUFFER_MEMORY ===
+.. _Reserve Memory for All Classic Message API Message Queues:
+
Reserve Memory for All Classic Message API Message Queues
---------------------------------------------------------
.. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY
@@ -2167,6 +2281,7 @@ work-arounds when the memory estimated by ``<rtems/confdefs.h>`` is incorrect.
.. COMMENT: === CONFIGURE_MEMORY_OVERHEAD ===
+.. _Specify Memory Overhead:
Specify Memory Overhead
-----------------------
@@ -2198,6 +2313,8 @@ all message queue buffers or task stacks.
.. COMMENT: === CONFIGURE_HAS_OWN_CONFIGURATION_TABLE ===
+.. _Do Not Generate Configuration Information:
+
Do Not Generate Configuration Information
-----------------------------------------
.. index:: CONFIGURE_HAS_OWN_CONFIGURATION_TABLE
@@ -2233,6 +2350,8 @@ parameters supported by ``<rtems/confdefs.h>``.
.. COMMENT: === CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS ===
+.. _Specify Maximum Number of File Descriptors:
+
Specify Maximum Number of File Descriptors
------------------------------------------
.. index:: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
@@ -2264,6 +2383,8 @@ None.
.. COMMENT: === CONFIGURE_TERMIOS_DISABLED ===
+.. _Disable POSIX Termios Support:
+
Disable POSIX Termios Support
-----------------------------
.. index:: CONFIGURE_TERMIOS_DISABLED
@@ -2293,6 +2414,8 @@ unless it is directly referenced by the application or a device driver.
.. COMMENT: === CONFIGURE_NUMBER_OF_TERMIOS_PORTS ===
+.. _Specify Maximum Termios Ports:
+
Specify Maximum Termios Ports
-----------------------------
.. index:: CONFIGURE_NUMBER_OF_TERMIOS_PORTS
@@ -2329,6 +2452,8 @@ This section defines File System related configuration parameters.
.. COMMENT: === CONFIGURE_HAS_OWN_MOUNT_TABLE ===
+.. _Providing Application Specific Mount Table:
+
Providing Application Specific Mount Table
------------------------------------------
.. index:: CONFIGURE_HAS_OWN_MOUNT_TABLE
@@ -2363,6 +2488,8 @@ None.
.. COMMENT: === CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM ===
+.. _Configure devFS as Root File System:
+
Configure devFS as Root File System
-----------------------------------
.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
@@ -2395,6 +2522,8 @@ provided before RTEMS release 4.5.0.
.. COMMENT: === CONFIGURE_MAXIMUM_DEVICES ===
+.. _Specifying Maximum Devices for devFS:
+
Specifying Maximum Devices for devFS
------------------------------------
.. index:: CONFIGURE_MAXIMUM_DEVICES
@@ -2426,6 +2555,8 @@ impacts the devFS and thus is only used by ``<rtems/confdefs.h>`` when
.. COMMENT: === CONFIGURE_APPLICATION_DISABLE_FILESYSTEM ===
+.. _Disable File System Support:
+
Disable File System Support
---------------------------
.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
@@ -2455,6 +2586,8 @@ None.
.. COMMENT: === CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM ===
+.. _Use a Root IMFS with a Minimalistic Feature Set:
+
Use a Root IMFS with a Minimalistic Feature Set
-----------------------------------------------
.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
@@ -2494,6 +2627,8 @@ options will be defined as well
.. COMMENT: === CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK ===
+.. _Specify Block Size for IMFS:
+
Specify Block Size for IMFS
---------------------------
.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
@@ -2543,6 +2678,8 @@ based on the configured block size:
.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHOWN ===
+.. _Disable Change Owner Support of Root IMFS:
+
Disable Change Owner Support of Root IMFS
-----------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
@@ -2566,6 +2703,8 @@ owner is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHMOD ===
+.. _Disable Change Mode Support of Root IMFS:
+
Disable Change Mode Support of Root IMFS
----------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
@@ -2589,6 +2728,8 @@ mode is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_UTIME ===
+.. _Disable Change Times Support of Root IMFS:
+
Disable Change Times Support of Root IMFS
-----------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_UTIME
@@ -2612,6 +2753,8 @@ is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_LINK ===
+.. _Disable Create Hard Link Support of Root IMFS:
+
Disable Create Hard Link Support of Root IMFS
---------------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_LINK
@@ -2635,6 +2778,8 @@ links is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_SYMLINK ===
+.. _Disable Create Symbolic Link Support of Root IMFS:
+
Disable Create Symbolic Link Support of Root IMFS
-------------------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
@@ -2658,6 +2803,8 @@ symbolic links is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_READLINK ===
+.. _Disable Read Symbolic Link Support of Root IMFS:
+
Disable Read Symbolic Link Support of Root IMFS
-----------------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_READLINK
@@ -2681,6 +2828,8 @@ links is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_RENAME ===
+.. _Disable Rename Support of Root IMFS:
+
Disable Rename Support of Root IMFS
-----------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_RENAME
@@ -2704,6 +2853,8 @@ is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_READDIR ===
+.. _Disable Directory Read Support of Root IMFS:
+
Disable Directory Read Support of Root IMFS
-------------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_READDIR
@@ -2728,6 +2879,8 @@ a directory.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_MOUNT ===
+.. _Disable Mount Support of Root IMFS:
+
Disable Mount Support of Root IMFS
----------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
@@ -2751,6 +2904,8 @@ file systems is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_UNMOUNT ===
+.. _Disable Unmount Support of Root IMFS:
+
Disable Unmount Support of Root IMFS
------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
@@ -2774,6 +2929,8 @@ systems is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD ===
+.. _Disable Make Nodes Support of Root IMFS:
+
Disable Make Nodes Support of Root IMFS
---------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
@@ -2797,6 +2954,8 @@ directories, devices, regular files and FIFOs is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD_FILE ===
+.. _Disable Make Files Support of Root IMFS:
+
Disable Make Files Support of Root IMFS
---------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
@@ -2820,6 +2979,8 @@ files is disabled in the root IMFS.
.. COMMENT: === CONFIGURE_IMFS_DISABLE_RMNOD ===
+.. _Disable Remove Nodes Support of Root IMFS:
+
Disable Remove Nodes Support of Root IMFS
-----------------------------------------
.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
@@ -2851,6 +3012,8 @@ parameters.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_LIBBLOCK ===
+.. _Enable Block Device Cache:
+
Enable Block Device Cache
-------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
@@ -2879,6 +3042,8 @@ for example by the RFS and DOSFS file systems.
.. COMMENT: === CONFIGURE_BDBUF_CACHE_MEMORY_SIZE ===
+.. _Size of the Cache Memory:
+
Size of the Cache Memory
------------------------
.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
@@ -2905,6 +3070,8 @@ None.
.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MIN_SIZE ===
+.. _Minimum Size of a Buffer:
+
Minimum Size of a Buffer
------------------------
.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
@@ -2931,6 +3098,8 @@ None.
.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MAX_SIZE ===
+.. _Maximum Size of a Buffer:
+
Maximum Size of a Buffer
------------------------
.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
@@ -2957,6 +3126,8 @@ None.
.. COMMENT: === CONFIGURE_SWAPOUT_SWAP_PERIOD ===
+.. _Swapout Task Swap Period:
+
Swapout Task Swap Period
------------------------
.. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
@@ -2983,6 +3154,8 @@ None.
.. COMMENT: === CONFIGURE_SWAPOUT_BLOCK_HOLD ===
+.. _Swapout Task Maximum Block Hold Time:
+
Swapout Task Maximum Block Hold Time
------------------------------------
.. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
@@ -3009,6 +3182,8 @@ None.
.. COMMENT: === CONFIGURE_SWAPOUT_TASK_PRIORITY ===
+.. _Swapout Task Priority:
+
Swapout Task Priority
---------------------
.. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
@@ -3035,6 +3210,8 @@ None.
.. COMMENT: === CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS ===
+.. _Maximum Blocks per Read-Ahead Request:
+
Maximum Blocks per Read-Ahead Request
-------------------------------------
.. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
@@ -3063,6 +3240,8 @@ This can improve the performance on some systems.
.. COMMENT: === CONFIGURE_BDBUF_MAX_WRITE_BLOCKS ===
+.. _Maximum Blocks per Write Request:
+
Maximum Blocks per Write Request
--------------------------------
.. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
@@ -3089,6 +3268,8 @@ None.
.. COMMENT: === CONFIGURE_BDBUF_TASK_STACK_SIZE ===
+.. _Task Stack Size of the Block Device Cache Tasks:
+
Task Stack Size of the Block Device Cache Tasks
-----------------------------------------------
.. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
@@ -3115,6 +3296,8 @@ None.
.. COMMENT: === CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY ===
+.. _Read-Ahead Task Priority:
+
Read-Ahead Task Priority
------------------------
.. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
@@ -3141,6 +3324,8 @@ None.
.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASKS ===
+.. _Swapout Worker Task Count:
+
Swapout Worker Task Count
-------------------------
.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
@@ -3167,6 +3352,8 @@ None.
.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY ===
+.. _Swapout Worker Task Priority:
+
Swapout Worker Task Priority
----------------------------
.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
@@ -3202,6 +3389,8 @@ This section describes BSP specific configuration settings used by
.. COMMENT: === Disable BSP Settings ===
+.. _Disable BSP Configuration Settings:
+
Disable BSP Configuration Settings
----------------------------------
.. index:: CONFIGURE_DISABLE_BSP_SETTINGS
@@ -3229,6 +3418,8 @@ None.
.. COMMENT: === CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK ===
+.. _Specify BSP Supports sbrk():
+
Specify BSP Supports sbrk()
---------------------------
.. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
@@ -3261,6 +3452,8 @@ it allocates memory to the C Program Heap.
.. COMMENT: === BSP_IDLE_TASK_BODY ===
+.. _Specify BSP Specific Idle Task:
+
Specify BSP Specific Idle Task
------------------------------
.. index:: BSP_IDLE_TASK_BODY
@@ -3291,6 +3484,8 @@ off to save power during extended periods of no task activity
.. COMMENT: === BSP_IDLE_TASK_STACK_SIZE ===
+.. _Specify BSP Suggested Value for IDLE Task Stack Size:
+
Specify BSP Suggested Value for IDLE Task Stack Size
----------------------------------------------------
.. index:: BSP_IDLE_TASK_STACK_SIZE
@@ -3329,6 +3524,8 @@ The order of precedence for configuring the IDLE task stack size is:
.. COMMENT: === BSP_INITIAL_EXTENSION ===
+.. _Specify BSP Specific User Extensions:
+
Specify BSP Specific User Extensions
------------------------------------
.. index:: BSP_INITIAL_EXTENSION
@@ -3357,6 +3554,8 @@ None.
.. COMMENT: === BSP_INTERRUPT_STACK_SIZE ===
+.. _Specifying BSP Specific Interrupt Stack Size:
+
Specifying BSP Specific Interrupt Stack Size
--------------------------------------------
.. index:: BSP_INTERRUPT_STACK_SIZE
@@ -3385,6 +3584,8 @@ None.
.. COMMENT: === BSP_MAXIMUM_DEVICES ===
+.. _Specifying BSP Specific Maximum Devices:
+
Specifying BSP Specific Maximum Devices
---------------------------------------
.. index:: BSP_MAXIMUM_DEVICES
@@ -3416,6 +3617,8 @@ impacts the devFS and thus is only used by ``<rtems/confdefs.h>`` when
.. COMMENT: === BSP_ZERO_WORKSPACE_AUTOMATICALLY ===
+.. _BSP Recommends RTEMS Workspace be Cleared:
+
BSP Recommends RTEMS Workspace be Cleared
-----------------------------------------
.. index:: BSP_ZERO_WORKSPACE_AUTOMATICALLY
@@ -3445,6 +3648,8 @@ for RTEMS but is often assumed by support libraries.
.. COMMENT: === CONFIGURE_BSP_PREREQUISITE_DRIVERS ===
+.. _Specify BSP Prerequisite Drivers:
+
Specify BSP Prerequisite Drivers
--------------------------------
.. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
@@ -3484,6 +3689,8 @@ by ``<rtems/confdefs.h>``.
.. COMMENT: === CONFIGURE_IDLE_TASK_BODY ===
+.. _Specify Application Specific Idle Task Body:
+
Specify Application Specific Idle Task Body
-------------------------------------------
.. index:: CONFIGURE_IDLE_TASK_BODY
@@ -3512,6 +3719,8 @@ None.
.. COMMENT: === CONFIGURE_IDLE_TASK_STACK_SIZE ===
+.. _Specify Idle Task Stack Size:
+
Specify Idle Task Stack Size
----------------------------
.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
@@ -3539,6 +3748,8 @@ None.
.. COMMENT: === CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION ===
+.. _Specify Idle Task Performs Application Initialization:
+
Specify Idle Task Performs Application Initialization
-----------------------------------------------------
.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
@@ -3588,6 +3799,8 @@ configuration macros.
.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY ===
+.. _Use Deterministic Priority Scheduler:
+
Use Deterministic Priority Scheduler
------------------------------------
.. index:: CONFIGURE_SCHEDULER_PRIORITY
@@ -3621,6 +3834,8 @@ behavior.
.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE ===
+.. _Use Simple Priority Scheduler:
+
Use Simple Priority Scheduler
-----------------------------
.. index:: CONFIGURE_SCHEDULER_SIMPLE
@@ -3656,6 +3871,8 @@ This scheduler is appropriate for use in small systems where RAM is limited.
.. COMMENT: === CONFIGURE_SCHEDULER_EDF ===
+.. _Use Earliest Deadline First Scheduler:
+
Use Earliest Deadline First Scheduler
-------------------------------------
.. index:: CONFIGURE_SCHEDULER_EDF
@@ -3693,6 +3910,8 @@ None.
.. COMMENT: === CONFIGURE_SCHEDULER_CBS ===
+.. _Use Constant Bandwidth Server Scheduler:
+
Use Constant Bandwidth Server Scheduler
---------------------------------------
.. index:: CONFIGURE_SCHEDULER_CBS
@@ -3728,6 +3947,8 @@ None.
.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY_SMP ===
+.. _Use Deterministic Priority SMP Scheduler:
+
Use Deterministic Priority SMP Scheduler
----------------------------------------
.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
@@ -3763,6 +3984,8 @@ selected when ``CONFIGURE_SMP_APPLICATION`` is defined.
.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE_SMP ===
+.. _Use Simple SMP Priority Scheduler:
+
Use Simple SMP Priority Scheduler
---------------------------------
.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
@@ -3804,6 +4027,8 @@ enabled.
.. COMMENT: === Configuring a Scheduler Name ===
+.. _Configuring a Scheduler Name:
+
Configuring a Scheduler Name
----------------------------
.. index:: CONFIGURE_SCHEDULER_NAME
@@ -3838,6 +4063,8 @@ None.
.. COMMENT: === Configuring a User Scheduler ===
+.. _Configuring a User Provided Scheduler:
+
Configuring a User Provided Scheduler
-------------------------------------
.. index:: CONFIGURE_SCHEDULER_USER
@@ -3882,6 +4109,7 @@ these are defined for the Deterministic Priority Scheduler.
.. COMMENT: === Configuring Clustered Schedulers ===
+.. _Configuring Clustered Schedulers:
Configuring Clustered Schedulers
--------------------------------
@@ -4055,6 +4283,7 @@ configuration parameters which apply.
.. COMMENT: === CONFIGURE_SMP_APPLICATION ===
+.. _Enable SMP Support for Applications:
Enable SMP Support for Applications
-----------------------------------
@@ -4084,6 +4313,8 @@ ready. This configuration define is ignored on uni-processor configurations.
.. COMMENT: === CONFIGURE_SMP_MAXIMUM_PROCESSORS ===
+.. _Specify Maximum Processors in SMP System:
+
Specify Maximum Processors in SMP System
----------------------------------------
.. index:: CONFIGURE_SMP_MAXIMUM_PROCESSORS
@@ -4124,6 +4355,8 @@ Note that network device drivers are not configured in the Device Driver Table.
.. COMMENT: === CONFIGURE_MAXIMUM_DRIVERS ===
+.. _Specifying the Maximum Number of Device Drivers:
+
Specifying the Maximum Number of Device Drivers
-----------------------------------------------
.. index:: CONFIGURE_MAXIMUM_DRIVERS
@@ -4157,6 +4390,8 @@ statically installed.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER ===
+.. _Enable Console Device Driver:
+
Enable Console Device Driver
----------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
@@ -4188,6 +4423,8 @@ properly without the need for the console driver to be configured.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER ===
+.. _Enable Clock Driver:
+
Enable Clock Driver
-------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
@@ -4220,6 +4457,8 @@ not defined, then a compile time error will occur.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER ===
+.. _Enable the Benchmark Timer Driver:
+
Enable the Benchmark Timer Driver
---------------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
@@ -4250,6 +4489,8 @@ not defined, then a compile time error will occur.
.. COMMENT: === 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
--------------------------------------------------------
.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
@@ -4281,6 +4522,8 @@ out a clock tick source.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER ===
+.. _Enable Real-Time Clock Driver:
+
Enable Real-Time Clock Driver
-----------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
@@ -4312,6 +4555,8 @@ will get a link time error for an undefined symbol.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER ===
+.. _Enable the Watchdog Device Driver:
+
Enable the Watchdog Device Driver
---------------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
@@ -4343,6 +4588,8 @@ will get a link time error for an undefined symbol.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER ===
+.. _Enable the Graphics Frame Buffer Device Driver:
+
Enable the Graphics Frame Buffer Device Driver
----------------------------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
@@ -4374,6 +4621,8 @@ will get a link time error for an undefined symbol.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER ===
+.. _Enable Stub Device Driver:
+
Enable Stub Device Driver
-------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
@@ -4402,6 +4651,8 @@ primarily a test fixture. It is supported by all BSPs.
.. COMMENT: === CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS ===
+.. _Specify Application Prerequisite Device Drivers:
+
Specify Application Prerequisite Device Drivers
-----------------------------------------------
.. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
@@ -4438,6 +4689,8 @@ configured via this configuration parameter.
.. COMMENT: === CONFIGURE_APPLICATION_EXTRA_DRIVERS ===
+.. _Specify Extra Application Device Drivers:
+
Specify Extra Application Device Drivers
----------------------------------------
.. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
@@ -4467,6 +4720,8 @@ None.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER ===
+.. _Enable /dev/null Device Driver:
+
Enable /dev/null Device Driver
------------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
@@ -4494,6 +4749,8 @@ This device driver is supported by all BSPs.
.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER ===
+.. _Enable /dev/zero Device Driver:
+
Enable /dev/zero Device Driver
------------------------------
.. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
@@ -4521,6 +4778,8 @@ This device driver is supported by all BSPs.
.. COMMENT: === CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE ===
+.. _Specifying Application Defined Device Driver Table:
+
Specifying Application Defined Device Driver Table
--------------------------------------------------
.. index:: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
@@ -4567,6 +4826,8 @@ Additionally, this class of Configuration Constants are only applicable if
.. COMMENT: === CONFIGURE_MP_APPLICATION ===
+.. _Specify Application Will Use Multiprocessing:
+
Specify Application Will Use Multiprocessing
--------------------------------------------
.. index:: CONFIGURE_MP_APPLICATION
@@ -4596,6 +4857,8 @@ This has no impact unless RTEMS was configured and built using the
.. COMMENT: === CONFIGURE_MP_NODE_NUMBER ===
+.. _Configure Node Number in Multiprocessor Configuration:
+
Configure Node Number in Multiprocessor Configuration
-----------------------------------------------------
.. index:: CONFIGURE_MP_NODE_NUMBER
@@ -4627,6 +4890,8 @@ based upon their node number.
.. COMMENT: === CONFIGURE_MP_MAXIMUM_NODES ===
+.. _Configure Maximum Node in Multiprocessor Configuration:
+
Configure Maximum Node in Multiprocessor Configuration
------------------------------------------------------
.. index:: CONFIGURE_MP_MAXIMUM_NODES
@@ -4654,6 +4919,8 @@ None.
.. COMMENT: === CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS ===
+.. _Configure Maximum Global Objects in Multiprocessor Configuration:
+
Configure Maximum Global Objects in Multiprocessor Configuration
----------------------------------------------------------------
.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
@@ -4682,6 +4949,8 @@ the ``RTEMS_GLOBAL`` attribute.
.. COMMENT: === CONFIGURE_MP_MAXIMUM_PROXIES ===
+.. _Configure Maximum Proxies in Multiprocessor Configuration:
+
Configure Maximum Proxies in Multiprocessor Configuration
---------------------------------------------------------
.. index:: CONFIGURE_MP_MAXIMUM_PROXIES
@@ -4713,6 +4982,8 @@ tasks/threads which can be blocked on objects on this node.
.. COMMENT: === CONFIGURE_MP_MPCI_TABLE_POINTER ===
+.. _Configure MPCI in Multiprocessor Configuration:
+
Configure MPCI in Multiprocessor Configuration
----------------------------------------------
.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
@@ -4742,6 +5013,8 @@ methods.
.. COMMENT: === CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE ===
+.. _Do Not Generate Multiprocessor Configuration Table:
+
Do Not Generate Multiprocessor Configuration Table
--------------------------------------------------
.. index:: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
@@ -4789,6 +5062,8 @@ has a test suite. This test suite is enabled only when``--enable-tests`` and
.. COMMENT: === CONFIGURE_GNAT_RTEMS ===
+.. _Specify Application Includes Ada Code:
+
Specify Application Includes Ada Code
-------------------------------------
.. index:: CONFIGURE_GNAT_RTEMS
@@ -4818,6 +5093,8 @@ Keys) used implicitly by the GNAT run-time.
.. COMMENT: === CONFIGURE_MAXIMUM_ADA_TASKS ===
+.. _Specify the Maximum Number of Ada Tasks.:
+
Specify the Maximum Number of Ada Tasks.
----------------------------------------
.. index:: CONFIGURE_MAXIMUM_ADA_TASKS
@@ -4846,6 +5123,8 @@ None.
.. COMMENT: === CONFIGURE_MAXIMUM_FAKE_ADA_TASKS ===
+.. _Specify the Maximum Fake Ada Tasks:
+
Specify the Maximum Fake Ada Tasks
----------------------------------
.. index:: CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
@@ -4933,6 +5212,8 @@ Go Tasks
.. COMMENT: === CONFIGURE_ENABLE_GO ===
+.. _Specify Application Includes Go Code:
+
Specify Application Includes Go Code
------------------------------------
.. index:: CONFIGURE_ENABLE_GO
@@ -4960,6 +5241,8 @@ The Go language support is experimental
.. COMMENT: === CONFIGURE_MAXIMUM_GOROUTINES ===
+.. _Specify the maximum number of Go routines:
+
Specify the maximum number of Go routines
-----------------------------------------
.. index:: CONFIGURE_MAXIMUM_GOROUTINES
@@ -4987,6 +5270,8 @@ The Go language support is experimental
.. COMMENT: === CONFIGURE_MAXIMUM_GO_CHANNELS ===
+.. _Specify the maximum number of Go Channels:
+
Specify the maximum number of Go Channels
-----------------------------------------
.. index:: CONFIGURE_MAXIMUM_GO_CHANNELS
diff --git a/c_user/fatal_error.rst b/c_user/fatal_error.rst
index 63fba60..6ffd43b 100644
--- a/c_user/fatal_error.rst
+++ b/c_user/fatal_error.rst
@@ -65,6 +65,8 @@ Applications Supplement document for a specific target processor.
Operations
==========
+.. _Announcing a Fatal Error:
+
Announcing a Fatal Error
------------------------
.. index:: _Internal_errors_What_happened
diff --git a/c_user/glossary.rst b/c_user/glossary.rst
index bc35548..e7fd794 100644
--- a/c_user/glossary.rst
+++ b/c_user/glossary.rst
@@ -575,7 +575,7 @@ Glossary
context to store its internal state. Each processor in the system is owned
by at most one scheduler instance. The processor to scheduler instance
assignment is determined at application configuration time. See
- `Configuring a System`_.
+ :ref:`Configuring a System`.
:dfn:`segments`
Variable sized memory blocks allocated from a region.
diff --git a/c_user/key_concepts.rst b/c_user/key_concepts.rst
index ee07281..ef464bb 100644
--- a/c_user/key_concepts.rst
+++ b/c_user/key_concepts.rst
@@ -278,7 +278,7 @@ the current date and time. This allows selected time operations to be
scheduled at an actual calendar date and time. For example, a task could
request to delay until midnight on New Year's Eve before lowering the ball at
Times Square. The data type ``rtems_time_of_day`` is used to specify calendar
-time in RTEMS services. See `Time and Date Data Structures`_
+time in RTEMS services. See :ref:`Time and Date Data Structures`.
.. index:: rtems_time_of_day
diff --git a/c_user/linker_sets.rst b/c_user/linker_sets.rst
index 2622b29..ad45fea 100644
--- a/c_user/linker_sets.rst
+++ b/c_user/linker_sets.rst
@@ -4,6 +4,8 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. _Linker Sets:
+
Linker Sets
###########
diff --git a/c_user/overview.rst b/c_user/overview.rst
index 586dd31..273e5ed 100644
--- a/c_user/overview.rst
+++ b/c_user/overview.rst
@@ -231,7 +231,7 @@ dependent.
RTEMS requires RAM to manage each instance of an RTEMS object that is created.
Thus the more RTEMS objects an application needs, the more memory that must be
-reserved. See Configuring a System_.
+reserved. See :ref:`Configuring a System`.
RTEMS utilizes memory for both code and data space. Although RTEMS' data space
must be in RAM, its code space can be located in either ROM or RAM.
diff --git a/c_user/semaphore_manager.rst b/c_user/semaphore_manager.rst
index 16ae2d1..b328e00 100644
--- a/c_user/semaphore_manager.rst
+++ b/c_user/semaphore_manager.rst
@@ -68,6 +68,8 @@ count of zero. One task waits for the arrival of another task by issuing a
The other task performs a corresponding ``rtems_semaphore_release`` operation
when it reaches its synchronization point, thus unblocking the pending task.
+.. _Nested Resource Access:
+
Nested Resource Access
----------------------
@@ -87,6 +89,8 @@ matched with a ``rtems_semaphore_release``.
Simple binary semaphores do not allow nested access and so can be used for task
synchronization.
+.. _Priority Inversion:
+
Priority Inversion
------------------
@@ -100,6 +104,7 @@ 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.
+.. _Priority Inheritance:
Priority Inheritance
--------------------
@@ -130,6 +135,8 @@ priority or at the priority of the highest priority task blocked waiting for
any of the semaphores the task holds. Only when the task releases ALL of the
binary semaphores it holds will its priority be restored to the normal value.
+.. _Priority Ceiling:
+
Priority Ceiling
----------------
@@ -166,6 +173,7 @@ or at the priority of the highest priority task blocked waiting for any of the
semaphores the task holds. Only when the task releases ALL of the binary
semaphores it holds will its priority be restored to the normal value.
+.. _Multiprocessor Resource Sharing Protocol:
Multiprocessor Resource Sharing Protocol
----------------------------------------
@@ -184,6 +192,8 @@ owner of a MrsP semaphore gets preempted it can ask all tasks waiting for this
semaphore to help out and temporarily borrow the right to execute on one of
their assigned processors.
+.. _Building a Semaphore Attribute Set:
+
Building a Semaphore Attribute Set
----------------------------------
@@ -248,6 +258,8 @@ following tree figure illustrates the valid combinations.
:align: center
:alt: Semaphore Attributes
+.. _Building a SEMAPHORE_OBTAIN Option Set:
+
Building a SEMAPHORE_OBTAIN Option Set
--------------------------------------
@@ -277,6 +289,8 @@ be ``RTEMS_NO_WAIT``.
Operations
==========
+.. _Creating a Semaphore:
+
Creating a Semaphore
--------------------
@@ -295,6 +309,8 @@ free list. This data structure is used by RTEMS to manage the newly created
semaphore. Also, a unique semaphore ID is generated and returned to the
calling task.
+.. _Obtaining Semaphore IDs:
+
Obtaining Semaphore IDs
-----------------------
@@ -306,6 +322,8 @@ provided location. Second, the semaphore ID may be obtained later using the
``rtems_semaphore_ident`` directive. The semaphore ID is used by other
semaphore manager directives to access this semaphore.
+.. _Acquiring a Semaphore:
+
Acquiring a Semaphore
---------------------
@@ -340,6 +358,8 @@ When a task successfully obtains a semaphore using priority ceiling and the
priority ceiling for this semaphore is greater than that of the holder, then
the holder's priority will be elevated.
+.. _Releasing a Semaphore:
+
Releasing a Semaphore
---------------------
@@ -356,6 +376,8 @@ inheritance or priority ceiling and the task does not currently hold any other
binary semaphores, then the task performing the ``rtems_semaphore_release``
will have its priority restored to its normal value.
+.. _Deleting a Semaphore:
+
Deleting a Semaphore
--------------------
diff --git a/c_user/symmetric_multiprocessing_services.rst b/c_user/symmetric_multiprocessing_services.rst
index 2f7e0b8..ac9cb6b 100644
--- a/c_user/symmetric_multiprocessing_services.rst
+++ b/c_user/symmetric_multiprocessing_services.rst
@@ -20,16 +20,16 @@ on
- SPARC.
It must be explicitly enabled via the ``--enable-smp`` configure command line
-option. To enable SMP in the application configuration see `Enable SMP Support
-for Applications`_. The default scheduler for SMP applications supports up to
-32 processors and is a global fixed priority scheduler, see also
+option. To enable SMP in the application configuration see :ref:`Enable SMP
+Support for Applications`. The default scheduler for SMP applications supports
+up to 32 processors and is a global fixed priority scheduler, see also
:ref:`Configuring Clustered Schedulers`. For example applications
see:file:`testsuites/smptests`.
.. warning::
- The SMP support in RTEMS is a work in progress. Before you start using this
- RTEMS version for SMP ask on the RTEMS mailing list.
+ The SMP support in the release of RTEMS is a work in progress. Before you
+ start using this RTEMS version for SMP ask on the RTEMS mailing list.
This chapter describes the services related to Symmetric Multiprocessing
provided by RTEMS.
@@ -197,21 +197,21 @@ available
- message queues,
-- semaphores using the `Priority Inheritance`_ protocol (priority boosting),
- and
+- semaphores using the :ref:`Priority Inheritance` protocol (priority
+ boosting), and
-- semaphores using the `Multiprocessor Resource Sharing Protocol`_ (MrsP).
+- semaphores using the :ref:`Multiprocessor Resource Sharing Protocol` (MrsP).
The clustered scheduling approach enables separation of functions with
real-time requirements and functions that profit from fairness and high
throughput provided the scheduler instances are fully decoupled and adequate
inter-cluster synchronization primitives are used. This is work in progress.
-For the configuration of clustered schedulers see `Configuring Clustered
-Schedulers`_.
+For the configuration of clustered schedulers see :ref:`Configuring Clustered
+Schedulers`.
-To set the scheduler of a task see `SCHEDULER_IDENT - Get ID of a scheduler`_
-and `TASK_SET_SCHEDULER - Set scheduler of a task`_.
+To set the scheduler of a task see :ref:`SCHEDULER_IDENT - Get ID of a
+scheduler` and :ref:`TASK_SET_SCHEDULER - Set scheduler of a task`.
Task Priority Queues
--------------------
@@ -718,6 +718,7 @@ thread dispatching disabled.
None.
.. _rtems_scheduler_ident:
+.. _SCHEDULER_IDENT - Get ID of a scheduler:
SCHEDULER_IDENT - Get ID of a scheduler
---------------------------------------
@@ -749,7 +750,7 @@ SCHEDULER_IDENT - Get ID of a scheduler
**DESCRIPTION:**
Identifies a scheduler by its name. The scheduler name is determined by the
-scheduler configuration. See `Configuring a System`_.
+scheduler configuration. See :ref:`Configuring a System`.
**NOTES:**
@@ -831,6 +832,7 @@ Returns the scheduler identifier of a task identified by ``task_id`` in
None.
.. _rtems_task_set_scheduler:
+.. _TASK_SET_SCHEDULER - Set scheduler of a task:
TASK_SET_SCHEDULER - Set scheduler of a task
--------------------------------------------
diff --git a/c_user/user_extensions.rst b/c_user/user_extensions.rst
index c421cc5..664d70a 100644
--- a/c_user/user_extensions.rst
+++ b/c_user/user_extensions.rst
@@ -4,6 +4,8 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. _User Extensions Manager:
+
User Extensions Manager
#######################
More information about the vc
mailing list