cpukit: Format list items using -

The `mdformat` tool used for the documentation formatting uses `-` instead of `*` for list items. Harmonize the format especially for the files generated from specification items. Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
2026-09-21 07:25:26 +08:00 · 2026-06-18 13:31:39 +02:00
parent 18e5aace1d
commit 141b39c1a4
13 changed files with 274 additions and 274 deletions
@@ -113,13 +113,13 @@ extern "C" {
 * #RTEMS_BARRIER_MANUAL_RELEASE and #RTEMS_BARRIER_AUTOMATIC_RELEASE
 * attributes.
 *
- * * The **manual release class** is the default and can be emphasized through
+ * - The **manual release class** is the default and can be emphasized through
 *   use of the #RTEMS_BARRIER_MANUAL_RELEASE attribute.  For this class, there
 *   is no limit on the number of tasks that will block at the barrier. Only
 *   when the rtems_barrier_release() directive is invoked, are the tasks
 *   waiting at the barrier unblocked.
 *
- * * The **automatic release class** is selected by the
+ * - The **automatic release class** is selected by the
 *   #RTEMS_BARRIER_AUTOMATIC_RELEASE attribute.  For this class, tasks calling
 *   the rtems_barrier_wait() directive will block until there are
 *   ``maximum_waiters`` minus one tasks waiting at the barrier.  When the
@@ -676,7 +676,7 @@ static inline rtems_status_code rtems_event_transient_send( rtems_id id )
 * identified by ``id``.  Based upon the state of the target task, one of the
 * following situations applies:
 *
- * * The target task is blocked waiting for events, then
+ * - The target task is blocked waiting for events, then
 *
 *   * if the waiting task's input event condition is satisfied, then the task
 *     is made ready for execution, or
@@ -684,7 +684,7 @@ static inline rtems_status_code rtems_event_transient_send( rtems_id id )
 *   * otherwise, the event set is posted but left pending and the task remains
 *     blocked.
 *
- * * The target task is not waiting for events, then the event set is posted
+ * - The target task is not waiting for events, then the event set is posted
 *   and left pending.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -753,9 +753,9 @@ rtems_status_code rtems_event_send( rtems_id id, rtems_event_set event_in );
 *
 * This directive can be used to
 *
- * * get the pending events of the calling task, or
+ * - get the pending events of the calling task, or
 *
- * * receive events.
+ * - receive events.
 *
 * To **get the pending events** use the constant #RTEMS_PENDING_EVENTS for the
 * ``event_in`` parameter.  The pending events are returned to the calling task
@@ -774,28 +774,28 @@ rtems_status_code rtems_event_send( rtems_id id, rtems_event_set event_in );
 * Default options can be selected by using the #RTEMS_DEFAULT_OPTIONS
 * constant.  The option set defines
 *
- * * if the calling task will wait or poll for the events, and
+ * - if the calling task will wait or poll for the events, and
 *
- * * if the calling task wants to receive all or any of the input events.
+ * - if the calling task wants to receive all or any of the input events.
 *
 * The calling task can **wait** or **poll** for the events.
 *
- * * **Waiting** for events is the default and can be emphasized through the
+ * - **Waiting** for events is the default and can be emphasized through the
 *   use of the #RTEMS_WAIT option.  The ``ticks`` parameter defines how long
 *   the calling task is willing to wait.  Use #RTEMS_NO_TIMEOUT to wait
 *   potentially forever, otherwise set a timeout interval in clock ticks.
 *
- * * Not waiting for events (**polling**) is selected by the #RTEMS_NO_WAIT
+ * - Not waiting for events (**polling**) is selected by the #RTEMS_NO_WAIT
 *   option.  If this option is defined, then the ``ticks`` parameter is
 *   ignored.
 *
 * The calling task can receive **all** or **any** of the input events
 * specified in ``event_in``.
 *
- * * Receiving **all** input events is the default and can be emphasized
+ * - Receiving **all** input events is the default and can be emphasized
 *   through the use of the #RTEMS_EVENT_ALL option.
 *
- * * Receiving **any** of the input events is selected by the #RTEMS_EVENT_ANY
+ * - Receiving **any** of the input events is selected by the #RTEMS_EVENT_ANY
 *   option.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -1166,9 +1166,9 @@ static inline void rtems_interrupt_entry_initialize(
 *
 * One of the following mutually exclusive options
 *
- * * #RTEMS_INTERRUPT_UNIQUE, and
+ * - #RTEMS_INTERRUPT_UNIQUE, and
 *
- * * #RTEMS_INTERRUPT_SHARED
+ * - #RTEMS_INTERRUPT_SHARED
 *
 * shall be set in the ``options`` parameter.
 *
@@ -1311,11 +1311,11 @@ rtems_status_code rtems_interrupt_entry_remove(
 *
 * One of the following mutually exclusive options
 *
- * * #RTEMS_INTERRUPT_UNIQUE,
+ * - #RTEMS_INTERRUPT_UNIQUE,
 *
- * * #RTEMS_INTERRUPT_SHARED, and
+ * - #RTEMS_INTERRUPT_SHARED, and
 *
- * * #RTEMS_INTERRUPT_REPLACE
+ * - #RTEMS_INTERRUPT_REPLACE
 *
 * shall be set in the ``options`` parameter.
 *
@@ -172,10 +172,10 @@ typedef struct {
 * directive and have no effect.  Default attributes can be selected by using
 * the #RTEMS_DEFAULT_ATTRIBUTES constant.  The attribute set defines
 *
- * * the scope of the message queue: #RTEMS_LOCAL (default) or #RTEMS_GLOBAL
+ * - the scope of the message queue: #RTEMS_LOCAL (default) or #RTEMS_GLOBAL
 *   and
 *
- * * the task wait queue discipline used by the message queue: #RTEMS_FIFO
+ * - the task wait queue discipline used by the message queue: #RTEMS_FIFO
 *   (default) or #RTEMS_PRIORITY.
 *
 * The message queue has a local or global **scope** in a multiprocessing
@@ -183,11 +183,11 @@ typedef struct {
 * selected by the mutually exclusive #RTEMS_LOCAL and #RTEMS_GLOBAL
 * attributes.
 *
- * * A **local scope** is the default and can be emphasized through the use of
+ * - A **local scope** is the default and can be emphasized through the use of
 *   the #RTEMS_LOCAL attribute.  A local message queue can be only used by the
 *   node which created it.
 *
- * * A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
+ * - A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
 *   Setting the global attribute in a single node system has no effect.
 *
 * The **task wait queue discipline** is selected by the mutually exclusive
@@ -195,10 +195,10 @@ typedef struct {
 * in which tasks wait for a message to receive on a currently empty message
 * queue.
 *
- * * The **FIFO discipline** is the default and can be emphasized through use
+ * - The **FIFO discipline** is the default and can be emphasized through use
 *   of the #RTEMS_FIFO attribute.
 *
- * * The **priority discipline** is selected by the #RTEMS_PRIORITY attribute.
+ * - The **priority discipline** is selected by the #RTEMS_PRIORITY attribute.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
@@ -400,13 +400,13 @@ rtems_status_code rtems_message_queue_construct(
 *
 * The node to search is specified in ``node``.  It shall be
 *
- * * a valid node number,
+ * - a valid node number,
 *
- * * the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
+ * - the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
 *
- * * the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
+ * - the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
 *
- * * the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
+ * - the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
 *   local node.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -747,13 +747,13 @@ rtems_status_code rtems_message_queue_broadcast(
 * The calling task can **wait** or **try to receive** a message from the queue
 * according to the mutually exclusive #RTEMS_WAIT and #RTEMS_NO_WAIT options.
 *
- * * **Waiting to receive** a message from the queue is the default and can be
+ * - **Waiting to receive** a message from the queue is the default and can be
 *   emphasized through the use of the #RTEMS_WAIT option. The ``timeout``
 *   parameter defines how long the calling task is willing to wait.  Use
 *   #RTEMS_NO_TIMEOUT to wait potentially forever, otherwise set a timeout
 *   interval in clock ticks.
 *
- * * **Trying to receive** a message from the queue is selected by the
+ * - **Trying to receive** a message from the queue is selected by the
 *   #RTEMS_NO_WAIT option.  If this option is defined, then the ``timeout``
 *   parameter is ignored.  When a message from the queue cannot be immediately
 *   received, then the ::RTEMS_UNSATISFIED status is returned.
@@ -136,11 +136,11 @@ extern "C" {
 * (this attribute does not refer to SMP systems).  The scope is selected by
 * the mutually exclusive #RTEMS_LOCAL and #RTEMS_GLOBAL attributes.
 *
- * * A **local scope** is the default and can be emphasized through the use of
+ * - A **local scope** is the default and can be emphasized through the use of
 *   the #RTEMS_LOCAL attribute.  A local partition can be only used by the
 *   node which created it.
 *
- * * A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
+ * - A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
 *   The memory space used for the partition must reside in shared memory.
 *   Setting the global attribute in a single node system has no effect.
 *
@@ -261,13 +261,13 @@ rtems_status_code rtems_partition_create(
 *
 * The node to search is specified in ``node``.  It shall be
 *
- * * a valid node number,
+ * - a valid node number,
 *
- * * the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
+ * - the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
 *
- * * the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
+ * - the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
 *
- * * the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
+ * - the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
 *   local node.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -482,15 +482,15 @@ rtems_status_code rtems_rate_monotonic_period(
 * specified by ``id``.  The detailed status of the period will be returned in
 * the members of the period status object referenced by ``status``:
 *
- * * The `owner` member is set to the identifier of the owner task of the
+ * - The `owner` member is set to the identifier of the owner task of the
 *   period.
 *
- * * The `state` member is set to the current state of the period.
+ * - The `state` member is set to the current state of the period.
 *
- * * The `postponed_jobs_count` member is set to the count of jobs which are
+ * - The `postponed_jobs_count` member is set to the count of jobs which are
 *   not released yet.
 *
- * * If the current state of the period is ::RATE_MONOTONIC_INACTIVE, the
+ * - If the current state of the period is ::RATE_MONOTONIC_INACTIVE, the
 *   `since_last_period` and `executed_since_last_period` members will be set
 *   to zero.  Otherwise, both members will contain time information since the
 *   last successful invocation of the rtems_rate_monotonic_period() directive
@@ -539,26 +539,26 @@ rtems_status_code rtems_rate_monotonic_get_status(
 * by ``id``.  The statistics of the period will be returned in the members of
 * the period statistics object referenced by ``status``:
 *
- * * The `count` member is set to the number of periods executed.
+ * - The `count` member is set to the number of periods executed.
 *
- * * The `missed_count` member is set to the number of periods missed.
+ * - The `missed_count` member is set to the number of periods missed.
 *
- * * The `min_cpu_time` member is set to the least amount of processor time
+ * - The `min_cpu_time` member is set to the least amount of processor time
 *   used in the period.
 *
- * * The `max_cpu_time` member is set to the highest amount of processor time
+ * - The `max_cpu_time` member is set to the highest amount of processor time
 *   used in the period.
 *
- * * The `total_cpu_time` member is set to the total amount of processor time
+ * - The `total_cpu_time` member is set to the total amount of processor time
 *   used in the period.
 *
- * * The `min_wall_time` member is set to the least amount of CLOCK_MONOTONIC
+ * - The `min_wall_time` member is set to the least amount of CLOCK_MONOTONIC
 *   time used in the period.
 *
- * * The `max_wall_time` member is set to the highest amount of CLOCK_MONOTONIC
+ * - The `max_wall_time` member is set to the highest amount of CLOCK_MONOTONIC
 *   time used in the period.
 *
- * * The `total_wall_time` member is set to the total amount of CLOCK_MONOTONIC
+ * - The `total_wall_time` member is set to the total amount of CLOCK_MONOTONIC
 *   time used in the period.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -180,10 +180,10 @@ rtems_status_code rtems_region_get_segment_size(
 * #RTEMS_FIFO and #RTEMS_PRIORITY attributes. The discipline defines the order
 * in which tasks wait for allocatable segments on a currently empty region.
 *
- * * The **FIFO discipline** is the default and can be emphasized through use
+ * - The **FIFO discipline** is the default and can be emphasized through use
 *   of the #RTEMS_FIFO attribute.
 *
- * * The **priority discipline** is selected by the #RTEMS_PRIORITY attribute.
+ * - The **priority discipline** is selected by the #RTEMS_PRIORITY attribute.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
@@ -420,13 +420,13 @@ rtems_status_code rtems_region_extend(
 * The calling task can **wait** or **try to get** a segment from the region
 * according to the mutually exclusive #RTEMS_WAIT and #RTEMS_NO_WAIT options.
 *
- * * **Waiting to get** a segment from the region is the default and can be
+ * - **Waiting to get** a segment from the region is the default and can be
 *   emphasized through the use of the #RTEMS_WAIT option. The ``timeout``
 *   parameter defines how long the calling task is willing to wait.  Use
 *   #RTEMS_NO_TIMEOUT to wait potentially forever, otherwise set a timeout
 *   interval in clock ticks.
 *
- * * **Trying to get** a segment from the region is selected by the
+ * - **Trying to get** a segment from the region is selected by the
 *   #RTEMS_NO_WAIT option.  If this option is defined, then the ``timeout``
 *   parameter is ignored.  When a segment from the region cannot be
 *   immediately allocated, then the ::RTEMS_UNSATISFIED status is returned.
@@ -524,9 +524,9 @@ rtems_status_code rtems_region_get_segment(
 * This directive will cause the calling task to be preempted if one or more
 * local tasks are waiting for a segment and the following conditions exist:
 *
- * * A waiting task has a higher priority than the calling task.
+ * - A waiting task has a higher priority than the calling task.
 *
- * * The size of the segment required by the waiting task is less than or equal
+ * - The size of the segment required by the waiting task is less than or equal
 *   to the size of the segment returned.
 * @endparblock
 *
@@ -115,15 +115,15 @@ extern "C" {
 * directive and have no effect.  Default attributes can be selected by using
 * the #RTEMS_DEFAULT_ATTRIBUTES constant.  The attribute set defines
 *
- * * the scope of the semaphore: #RTEMS_LOCAL (default) or #RTEMS_GLOBAL,
+ * - the scope of the semaphore: #RTEMS_LOCAL (default) or #RTEMS_GLOBAL,
 *
- * * the task wait queue discipline used by the semaphore: #RTEMS_FIFO
+ * - the task wait queue discipline used by the semaphore: #RTEMS_FIFO
 *   (default) or #RTEMS_PRIORITY,
 *
- * * the class of the semaphore: #RTEMS_COUNTING_SEMAPHORE (default),
+ * - the class of the semaphore: #RTEMS_COUNTING_SEMAPHORE (default),
 *   #RTEMS_BINARY_SEMAPHORE, or #RTEMS_SIMPLE_BINARY_SEMAPHORE, and
 *
- * * the locking protocol of a binary semaphore: no locking protocol (default),
+ * - the locking protocol of a binary semaphore: no locking protocol (default),
 *   #RTEMS_INHERIT_PRIORITY, #RTEMS_PRIORITY_CEILING, or
 *   #RTEMS_MULTIPROCESSOR_RESOURCE_SHARING.
 *
@@ -131,35 +131,35 @@ extern "C" {
 * (this attribute does not refer to SMP systems).  The scope is selected by
 * the mutually exclusive #RTEMS_LOCAL and #RTEMS_GLOBAL attributes.
 *
- * * A **local scope** is the default and can be emphasized through the use of
+ * - A **local scope** is the default and can be emphasized through the use of
 *   the #RTEMS_LOCAL attribute.  A local semaphore can be only used by the
 *   node which created it.
 *
- * * A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
+ * - A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
 *   Setting the global attribute in a single node system has no effect.
 *
 * The **task wait queue discipline** is selected by the mutually exclusive
 * #RTEMS_FIFO and #RTEMS_PRIORITY attributes.
 *
- * * The **FIFO discipline** is the default and can be emphasized through use
+ * - The **FIFO discipline** is the default and can be emphasized through use
 *   of the #RTEMS_FIFO attribute.
 *
- * * The **priority discipline** is selected by the #RTEMS_PRIORITY attribute.
+ * - The **priority discipline** is selected by the #RTEMS_PRIORITY attribute.
 *   The locking protocols require the priority discipline.
 *
 * The **semaphore class** is selected by the mutually exclusive
 * #RTEMS_COUNTING_SEMAPHORE, #RTEMS_BINARY_SEMAPHORE, and
 * #RTEMS_SIMPLE_BINARY_SEMAPHORE attributes.
 *
- * * The **counting semaphore class** is the default and can be emphasized
+ * - The **counting semaphore class** is the default and can be emphasized
 *   through use of the #RTEMS_COUNTING_SEMAPHORE attribute.
 *
- * * The **binary semaphore class** is selected by the #RTEMS_BINARY_SEMAPHORE
+ * - The **binary semaphore class** is selected by the #RTEMS_BINARY_SEMAPHORE
 *   attribute.  Binary semaphores are mutual exclusion (mutex) synchronization
 *   primitives which may have an owner.  The count of a binary semaphore is
 *   restricted to 0 and 1 values.
 *
- * * The **simple binary semaphore class** is selected by the
+ * - The **simple binary semaphore class** is selected by the
 *   #RTEMS_SIMPLE_BINARY_SEMAPHORE attribute.  Simple binary semaphores have
 *   no owner.  They may be used for task and interrupt synchronization.  The
 *   count of a simple binary semaphore is restricted to 0 and 1 values.
@@ -170,19 +170,19 @@ extern "C" {
 * mutually exclusive #RTEMS_INHERIT_PRIORITY, #RTEMS_PRIORITY_CEILING, and
 * #RTEMS_MULTIPROCESSOR_RESOURCE_SHARING attributes.
 *
- * * The default is **no locking protocol**.  This can be emphasized through
+ * - The default is **no locking protocol**.  This can be emphasized through
 *   use of the #RTEMS_NO_INHERIT_PRIORITY,
 *   #RTEMS_NO_MULTIPROCESSOR_RESOURCE_SHARING, and #RTEMS_NO_PRIORITY_CEILING
 *   attributes.
 *
- * * The **priority inheritance locking protocol** is selected by the
+ * - The **priority inheritance locking protocol** is selected by the
 *   #RTEMS_INHERIT_PRIORITY attribute.
 *
- * * The **priority ceiling locking protocol** is selected by the
+ * - The **priority ceiling locking protocol** is selected by the
 *   #RTEMS_PRIORITY_CEILING attribute.  For this locking protocol a priority
 *   ceiling shall be specified in ``priority_ceiling``.
 *
- * * The **MrsP locking protocol** is selected by the
+ * - The **MrsP locking protocol** is selected by the
 *   #RTEMS_MULTIPROCESSOR_RESOURCE_SHARING attribute in SMP configurations,
 *   otherwise this attribute selects the **priority ceiling locking
 *   protocol**.  For these locking protocols a priority ceiling shall be
@@ -283,13 +283,13 @@ rtems_status_code rtems_semaphore_create(
 *
 * The node to search is specified in ``node``.  It shall be
 *
- * * a valid node number,
+ * - a valid node number,
 *
- * * the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
+ * - the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
 *
- * * the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
+ * - the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
 *
- * * the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
+ * - the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
 *   local node.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -434,13 +434,13 @@ rtems_status_code rtems_semaphore_delete( rtems_id id );
 * The calling task can **wait** or **try to obtain** the semaphore according
 * to the mutually exclusive #RTEMS_WAIT and #RTEMS_NO_WAIT options.
 *
- * * **Waiting to obtain** the semaphore is the default and can be emphasized
+ * - **Waiting to obtain** the semaphore is the default and can be emphasized
 *   through the use of the #RTEMS_WAIT option.  The ``timeout`` parameter
 *   defines how long the calling task is willing to wait.  Use
 *   #RTEMS_NO_TIMEOUT to wait potentially forever, otherwise set a timeout
 *   interval in clock ticks.
 *
- * * **Trying to obtain** the semaphore is selected by the #RTEMS_NO_WAIT
+ * - **Trying to obtain** the semaphore is selected by the #RTEMS_NO_WAIT
 *   option.  If this option is defined, then the ``timeout`` parameter is
 *   ignored.  When the semaphore cannot be immediately obtained, then the
 *   ::RTEMS_UNSATISFIED status is returned.
@@ -567,10 +567,10 @@ rtems_status_code rtems_semaphore_obtain(
 * This directive releases the semaphore specified by ``id``.  If the
 * semaphore's wait queue is not empty, then
 *
- * * the first task on the wait queue is removed and unblocked, the semaphore's
+ * - the first task on the wait queue is removed and unblocked, the semaphore's
 *   count is not changed, otherwise
 *
- * * the semaphore's count is incremented by one for counting semaphores and
+ * - the semaphore's count is incremented by one for counting semaphores and
 *   set to one for binary and simple binary semaphores.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -753,13 +753,13 @@ rtems_status_code rtems_semaphore_flush( rtems_id id );
 * The availability and use of a priority depends on the class and locking
 * protocol of the semaphore:
 *
- * * For local, binary semaphores using the MrsP locking protocol, the ceiling
+ * - For local, binary semaphores using the MrsP locking protocol, the ceiling
 *   priority for each scheduler can be set by this directive.
 *
- * * For local, binary semaphores using the priority ceiling protocol, the
+ * - For local, binary semaphores using the priority ceiling protocol, the
 *   ceiling priority can be set by this directive.
 *
- * * For other semaphore classes and locking protocols, setting a priority is
+ * - For other semaphore classes and locking protocols, setting a priority is
 *   undefined behaviour.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -459,7 +459,7 @@ typedef bool ( *rtems_task_visitor )( rtems_tcb *, void * );
 * addition to being able to specify the task stack size as a integer, there
 * are two constants which may be specified:
 *
- * * The #RTEMS_MINIMUM_STACK_SIZE constant can be specified to use the
+ * - The #RTEMS_MINIMUM_STACK_SIZE constant can be specified to use the
 *   **recommended minimum stack size** for the target processor.  This value
 *   is selected by the RTEMS maintainers conservatively to minimize the risk
 *   of blown stacks for most user applications.  Using this constant when
@@ -468,7 +468,7 @@ typedef bool ( *rtems_task_visitor )( rtems_tcb *, void * );
 *   minimum stack size is larger than the recommended minimum, then it will be
 *   used.
 *
- * * The #RTEMS_CONFIGURED_MINIMUM_STACK_SIZE constant can be specified to use
+ * - The #RTEMS_CONFIGURED_MINIMUM_STACK_SIZE constant can be specified to use
 *   the minimum stack size that was configured by the application.  If not
 *   explicitly configured by the application, the default configured minimum
 *   stack size is the target processor dependent value
@@ -485,48 +485,48 @@ typedef bool ( *rtems_task_visitor )( rtems_tcb *, void * );
 * modes can be selected by using the #RTEMS_DEFAULT_MODES constant.  The task
 * mode set defines
 *
- * * the preemption mode of the task: #RTEMS_PREEMPT (default) or
+ * - the preemption mode of the task: #RTEMS_PREEMPT (default) or
 *   #RTEMS_NO_PREEMPT,
 *
- * * the timeslicing mode of the task: #RTEMS_TIMESLICE or #RTEMS_NO_TIMESLICE
+ * - the timeslicing mode of the task: #RTEMS_TIMESLICE or #RTEMS_NO_TIMESLICE
 *   (default),
 *
- * * the ASR processing mode of the task: #RTEMS_ASR (default) or
+ * - the ASR processing mode of the task: #RTEMS_ASR (default) or
 *   #RTEMS_NO_ASR,
 *
- * * the interrupt level of the task: RTEMS_INTERRUPT_LEVEL() with a default of
+ * - the interrupt level of the task: RTEMS_INTERRUPT_LEVEL() with a default of
 *   `RTEMS_INTERRUPT_LEVEL( 0 )` which is associated with enabled interrupts.
 *
 * The **initial preemption mode** of the task is enabled or disabled.
 *
- * * An **enabled preemption** is the default and can be emphasized through the
+ * - An **enabled preemption** is the default and can be emphasized through the
 *   use of the #RTEMS_PREEMPT mode constant.
 *
- * * A **disabled preemption** is set by the #RTEMS_NO_PREEMPT mode constant.
+ * - A **disabled preemption** is set by the #RTEMS_NO_PREEMPT mode constant.
 *
 * The **initial timeslicing mode** of the task is enabled or disabled.
 *
- * * A **disabled timeslicing** is the default and can be emphasized through
+ * - A **disabled timeslicing** is the default and can be emphasized through
 *   the use of the #RTEMS_NO_TIMESLICE mode constant.
 *
- * * An **enabled timeslicing** is set by the #RTEMS_TIMESLICE mode constant.
+ * - An **enabled timeslicing** is set by the #RTEMS_TIMESLICE mode constant.
 *
 * The **initial ASR processing mode** of the task is enabled or disabled.
 *
- * * An **enabled ASR processing** is the default and can be emphasized through
+ * - An **enabled ASR processing** is the default and can be emphasized through
 *   the use of the #RTEMS_ASR mode constant.
 *
- * * A **disabled ASR processing** is set by the #RTEMS_NO_ASR mode constant.
+ * - A **disabled ASR processing** is set by the #RTEMS_NO_ASR mode constant.
 *
 * The **initial interrupt level mode** of the task is defined by
 * RTEMS_INTERRUPT_LEVEL().
 *
- * * Task execution with **interrupts enabled** the default and can be
+ * - Task execution with **interrupts enabled** the default and can be
 *   emphasized through the use of the RTEMS_INTERRUPT_LEVEL() mode macro with
 *   a value of zero (0) for the parameter.  An interrupt level of zero is
 *   associated with enabled interrupts on all target processors.
 *
- * * Task execution at a **non-zero interrupt level** can be specified by the
+ * - Task execution at a **non-zero interrupt level** can be specified by the
 *   RTEMS_INTERRUPT_LEVEL() mode macro with a non-zero value for the
 *   parameter.  The interrupt level portion of the task mode supports a
 *   maximum of 256 interrupt levels.  These levels are mapped onto the
@@ -541,20 +541,20 @@ typedef bool ( *rtems_task_visitor )( rtems_tcb *, void * );
 * directive and have no effect.  Default attributes can be selected by using
 * the #RTEMS_DEFAULT_ATTRIBUTES constant.  The attribute set defines
 *
- * * the scope of the task: #RTEMS_LOCAL (default) or #RTEMS_GLOBAL and
+ * - the scope of the task: #RTEMS_LOCAL (default) or #RTEMS_GLOBAL and
 *
- * * the floating-point unit use of the task: #RTEMS_FLOATING_POINT or
+ * - the floating-point unit use of the task: #RTEMS_FLOATING_POINT or
 *   #RTEMS_NO_FLOATING_POINT (default).
 *
 * The task has a local or global **scope** in a multiprocessing network (this
 * attribute does not refer to SMP systems).  The scope is selected by the
 * mutually exclusive #RTEMS_LOCAL and #RTEMS_GLOBAL attributes.
 *
- * * A **local scope** is the default and can be emphasized through the use of
+ * - A **local scope** is the default and can be emphasized through the use of
 *   the #RTEMS_LOCAL attribute.  A local task can be only used by the node
 *   which created it.
 *
- * * A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
+ * - A **global scope** is established if the #RTEMS_GLOBAL attribute is set.
 *   Setting the global attribute in a single node system has no effect.the
 *
 * The **use of the floating-point unit** is selected by the mutually exclusive
@@ -564,12 +564,12 @@ typedef bool ( *rtems_task_visitor )( rtems_tcb *, void * );
 * floating-point unit or enable the use of the floating-point unit for all
 * tasks.  Consult the *RTEMS CPU Architecture Supplement* for the details.
 *
- * * A **disabled floating-point unit** is the default and can be emphasized
+ * - A **disabled floating-point unit** is the default and can be emphasized
 *   through use of the #RTEMS_NO_FLOATING_POINT attribute.  For performance
 *   reasons, it is recommended that tasks not using the floating-point unit
 *   should specify this attribute.
 *
- * * An **enabled floating-point unit** is selected by the
+ * - An **enabled floating-point unit** is selected by the
 *   #RTEMS_FLOATING_POINT attribute.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -800,13 +800,13 @@ rtems_status_code rtems_task_construct(
 *
 * The node to search is specified in ``node``.  It shall be
 *
- * * a valid node number,
+ * - a valid node number,
 *
- * * the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
+ * - the constant #RTEMS_SEARCH_ALL_NODES to search in all nodes,
 *
- * * the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
+ * - the constant #RTEMS_SEARCH_LOCAL_NODE to search in the local node only, or
 *
- * * the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
+ * - the constant #RTEMS_SEARCH_OTHER_NODES to search in all nodes except the
 *   local node.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
@@ -1450,16 +1450,16 @@ rtems_status_code rtems_task_get_priority(
 * selected by using the #RTEMS_DEFAULT_MODES constant.  The task mode set
 * defines
 *
- * * the preemption mode of the task: #RTEMS_PREEMPT (default) or
+ * - the preemption mode of the task: #RTEMS_PREEMPT (default) or
 *   #RTEMS_NO_PREEMPT,
 *
- * * the timeslicing mode of the task: #RTEMS_TIMESLICE or #RTEMS_NO_TIMESLICE
+ * - the timeslicing mode of the task: #RTEMS_TIMESLICE or #RTEMS_NO_TIMESLICE
 *   (default),
 *
- * * the ASR processing mode of the task: #RTEMS_ASR (default) or
+ * - the ASR processing mode of the task: #RTEMS_ASR (default) or
 *   #RTEMS_NO_ASR,
 *
- * * the interrupt level of the task: RTEMS_INTERRUPT_LEVEL() with a default of
+ * - the interrupt level of the task: RTEMS_INTERRUPT_LEVEL() with a default of
 *   `RTEMS_INTERRUPT_LEVEL( 0 )` which is associated with enabled interrupts.
 *
 * The **mode mask** specified in ``mask`` is built through a *bitwise or* of
@@ -1468,16 +1468,16 @@ rtems_status_code rtems_task_get_priority(
 * When the #RTEMS_PREEMPT_MASK is set in ``mask``, the **preemption mode** of
 * the calling task is
 *
- * * enabled by using the #RTEMS_PREEMPT mode constant in ``mode_set`` and
+ * - enabled by using the #RTEMS_PREEMPT mode constant in ``mode_set`` and
 *
- * * disabled by using the #RTEMS_NO_PREEMPT mode constant in ``mode_set``.
+ * - disabled by using the #RTEMS_NO_PREEMPT mode constant in ``mode_set``.
 *
 * When the #RTEMS_TIMESLICE_MASK is set in ``mask``, the **timeslicing mode**
 * of the calling task is
 *
- * * enabled by using the #RTEMS_TIMESLICE mode constant in ``mode_set`` and
+ * - enabled by using the #RTEMS_TIMESLICE mode constant in ``mode_set`` and
 *
- * * disabled by using the #RTEMS_NO_TIMESLICE mode constant in ``mode_set``.
+ * - disabled by using the #RTEMS_NO_TIMESLICE mode constant in ``mode_set``.
 *
 * Enabling timeslicing has no effect if preemption is disabled.  For a task to
 * be timesliced, that task must have both preemption and timeslicing enabled.
@@ -1485,17 +1485,17 @@ rtems_status_code rtems_task_get_priority(
 * When the #RTEMS_ASR_MASK is set in ``mask``, the **ASR processing mode** of
 * the calling task is
 *
- * * enabled by using the #RTEMS_ASR mode constant in ``mode_set`` and
+ * - enabled by using the #RTEMS_ASR mode constant in ``mode_set`` and
 *
- * * disabled by using the #RTEMS_NO_ASR mode constant in ``mode_set``.
+ * - disabled by using the #RTEMS_NO_ASR mode constant in ``mode_set``.
 *
 * When the #RTEMS_INTERRUPT_MASK is set in ``mask``, **interrupts** of the
 * calling task are
 *
- * * enabled by using the RTEMS_INTERRUPT_LEVEL() mode macro with a value of
+ * - enabled by using the RTEMS_INTERRUPT_LEVEL() mode macro with a value of
 *   zero (0) in ``mode_set`` and
 *
- * * disabled up to the specified level by using the RTEMS_INTERRUPT_LEVEL()
+ * - disabled up to the specified level by using the RTEMS_INTERRUPT_LEVEL()
 *   mode macro with a positive value in ``mode_set``.
 *
 * An interrupt level of zero is associated with enabled interrupts on all
@@ -63,11 +63,11 @@ extern "C" {
 * Schedulers are used by the system to manage sets of threads that are ready
 * for execution.  A scheduler consists of
 *
- * * a scheduler algorithm implementation,
+ * - a scheduler algorithm implementation,
 *
- * * a scheduler index and an associated name, and
+ * - a scheduler index and an associated name, and
 *
- * * a set of processors owned by the scheduler (may be empty, but never
+ * - a set of processors owned by the scheduler (may be empty, but never
 *   overlaps with a set owned by another scheduler).
 *
 * Each thread uses exactly one scheduler as its home scheduler.  Threads may
@@ -84,7 +84,7 @@ void _Thread_MP_Handler_initialization( uint32_t maximum_proxies );
 * @note This function returns a thread control pointer
 *       because proxies are substitutes for remote threads.
 *
- * * @param the_state The state for the allocated MP proxy control block.
+ * - @param the_state The state for the allocated MP proxy control block.
 */
 Thread_Control *_Thread_MP_Allocate_proxy( States_Control the_state );

@@ -548,13 +548,13 @@ typedef Thread_Control *( *Thread_queue_First_operation )(
 *
 * The standard thread queue operation variants are:
 *
- * * ::_Thread_queue_Operations_default
+ * - ::_Thread_queue_Operations_default
 *
- * * ::_Thread_queue_Operations_FIFO
+ * - ::_Thread_queue_Operations_FIFO
 *
- * * ::_Thread_queue_Operations_priority
+ * - ::_Thread_queue_Operations_priority
 *
- * * ::_Thread_queue_Operations_priority_inherit
+ * - ::_Thread_queue_Operations_priority_inherit
 *
 * @see _Thread_wait_Set_operations().
 */