From 34eb70292335b5de0b290b3787701cbf1ba0ef8e Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 10 May 2021 08:32:18 +0200 Subject: cpukit/doxygen/appl-config.h --- cpukit/doxygen/appl-config.h | 112 +++++++++++++++++++++---------------------- 1 file changed, 56 insertions(+), 56 deletions(-) diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index bbeb438bec..310eea5a74 100644 --- a/cpukit/doxygen/appl-config.h +++ b/cpukit/doxygen/appl-config.h @@ -625,7 +625,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_BARRIERS @@ -662,7 +662,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. You have to account for the memory used to store the messages * of each message queue, see #CONFIGURE_MESSAGE_BUFFER_MEMORY. */ @@ -700,7 +700,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_PARTITIONS @@ -737,7 +737,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_PERIODS @@ -774,7 +774,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_PORTS @@ -811,7 +811,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_REGIONS @@ -849,14 +849,14 @@ * @par Notes * @parblock * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * * In SMP configurations, the size of a Semaphore Control Block depends on the * scheduler count (see Configuration + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html#configuration-step-3-scheduler-table">Configuration * Step 3 - Scheduler Table). The semaphores using the Multiprocessor + * href="https://docs.rtems.org/branches/master/c-user/key_concepts.html#multiprocessor-resource-sharing-protocol-mrsp">Multiprocessor * Resource Sharing Protocol (MrsP) need a ceiling priority per scheduler. * @endparblock */ @@ -899,7 +899,7 @@ * @par Notes * @parblock * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * * The calculations for the required memory in the RTEMS Workspace for tasks @@ -997,7 +997,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_TIMERS @@ -1897,7 +1897,7 @@ * * then the event records are dumped in Base64 encoding in a fatal error * extension (see Announcing + * href="https://docs.rtems.org/branches/master/c-user/fatal_error.html#announcing-a-fatal-error">Announcing * a Fatal Error). * * @par Default Configuration @@ -1922,7 +1922,7 @@ * * then the event records are compressed by zlib and dumped in Base64 encoding * in a fatal error extension (see Announcing + * href="https://docs.rtems.org/branches/master/c-user/fatal_error.html#announcing-a-fatal-error">Announcing * a Fatal Error). * * @par Default Configuration @@ -2850,8 +2850,8 @@ * * @par Notes * @parblock - * The default value was chosen for Linux compatibility, see PTHREAD_SETNAME_NP(3). + * The default value was chosen for Linux compatibility, see + * pthread_setname_np(). * * The size of the thread control block is increased by the maximum thread name * size. @@ -3144,7 +3144,7 @@ * pool is very undesirable. * * In high memory environments, this is desirable when you want to use the Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects option. You will be able to create objects until you run out of * all available memory rather then just until you run out of RTEMS Workspace. * @endparblock @@ -3159,7 +3159,7 @@ * If #CONFIGURE_UNLIMITED_OBJECTS is defined, then the value of this * configuration option defines the default objects maximum of all object * classes supporting Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects to ``rtems_resource_unlimited( * CONFIGURE_UNLIMITED_ALLOCATION_SIZE )``. * @@ -3522,7 +3522,7 @@ * Since a proxy is used to represent a remote task/thread which is blocking on * this node. This configuration parameter reflects the maximum number of * remote tasks/threads which can be blocked on objects on this node, see Proxies. + * href="https://docs.rtems.org/branches/master/c-user/multiprocessing.html#proxies">Proxies. * * This configuration option is only evaluated if #CONFIGURE_MP_APPLICATION is * defined. @@ -3641,7 +3641,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_POSIX_KEYS @@ -3680,7 +3680,7 @@ * @par Notes * @parblock * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * * A key value pair is created by pthread_setspecific() if the value is not Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. You have to account for the memory used to store the messages * of each message queue, see #CONFIGURE_MESSAGE_BUFFER_MEMORY. */ @@ -3810,7 +3810,7 @@ * @par Notes * @parblock * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * * Named semaphores are created with sem_open(). Semaphores initialized with @@ -3856,7 +3856,7 @@ * * @par Notes * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. */ #define CONFIGURE_MAXIMUM_POSIX_SHMS @@ -3893,7 +3893,7 @@ * @par Notes * @parblock * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * * This calculations for the required memory in the RTEMS Workspace for threads @@ -3947,7 +3947,7 @@ * @par Notes * @parblock * This object class can be configured in unlimited allocation mode, see Unlimited + * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * * Timers are only available if RTEMS was built with the ``--enable-posix`` @@ -4090,16 +4090,16 @@ * described in this section. * * By default, the Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#deterministic-priority-scheduler">Deterministic * Priority Scheduler algorithm is used in uniprocessor configurations. In * case SMP is enabled and the configured maximum processors * (#CONFIGURE_MAXIMUM_PROCESSORS) is greater than one, then the Earliest + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#earliest-deadline-first-smp-scheduler">Earliest * Deadline First SMP Scheduler is selected as the default scheduler * algorithm. * * For the schedulers provided by RTEMS (see Scheduling + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/index.html">Scheduling * Concepts), the configuration is straightforward. All that is required * is to define the configuration option which specifies which scheduler you * want for in your application. @@ -4151,18 +4151,18 @@ * For the following schedulers * * * Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#deterministic-priority-scheduler">Deterministic * Priority Scheduler, which is the default in uniprocessor * configurations and can be configured through the * #CONFIGURE_SCHEDULER_PRIORITY configuration option, * * * Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#deterministic-priority-smp-scheduler">Deterministic * Priority SMP Scheduler which can be configured through the * #CONFIGURE_SCHEDULER_PRIORITY_SMP configuration option, and * * * Arbitrary + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#arbitrary-processor-affinity-priority-smp-scheduler">Arbitrary * Processor Affinity Priority SMP Scheduler which can be configured * through the #CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP configuration * option @@ -4232,7 +4232,7 @@ * This configuration option is only evaluated in SMP configurations. * * This is an advanced configuration option, see Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration. * @endparblock */ @@ -4244,7 +4244,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Constant + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#constant-bandwidth-server-scheduling-cbs">Constant * Bandwidth Server Scheduling (CBS) algorithm is made available to the * application. * @@ -4258,7 +4258,7 @@ * Think twice before you use it. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * exactly one processor. * @endparblock @@ -4271,7 +4271,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Earliest + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#earliest-deadline-first-scheduler">Earliest * Deadline First Scheduler algorithm is made available to the application. * * @par Default Configuration @@ -4284,7 +4284,7 @@ * Think twice before you use it. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * exactly one processor. * @endparblock @@ -4297,7 +4297,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Earliest + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#earliest-deadline-first-smp-scheduler">Earliest * Deadline First SMP Scheduler algorithm is made available to the * application. * @@ -4314,7 +4314,7 @@ * support enabled. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * up to 32 processors. * @@ -4337,35 +4337,35 @@ * The default value is * * * ``"MEDF"`` for the Earliest + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#earliest-deadline-first-smp-scheduler">Earliest * Deadline First SMP Scheduler, * * * ``"MPA "`` for the Arbitrary + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#arbitrary-processor-affinity-priority-smp-scheduler">Arbitrary * Processor Affinity Priority SMP Scheduler, * * * ``"MPD "`` for the Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#deterministic-priority-smp-scheduler">Deterministic * Priority SMP Scheduler, * * * ``"MPS "`` for the Simple + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#simple-priority-smp-scheduler">Simple * Priority SMP Scheduler, * * * ``"UCBS"`` for the Constant + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#constant-bandwidth-server-scheduling-cbs">Constant * Bandwidth Server Scheduling (CBS), * * * ``"UEDF"`` for the Earliest + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#earliest-deadline-first-scheduler">Earliest * Deadline First Scheduler, * * * ``"UPD "`` for the Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#deterministic-priority-scheduler">Deterministic * Priority Scheduler, and * * * ``"UPS "`` for the Simple + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#simple-priority-scheduler">Simple * Priority Scheduler. * @endparblock * @@ -4391,7 +4391,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#deterministic-priority-scheduler">Deterministic * Priority Scheduler algorithm is made available to the application. * * @par Default Configuration @@ -4404,7 +4404,7 @@ * Think twice before you use it. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * exactly one processor. * @@ -4423,7 +4423,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Arbitrary + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#arbitrary-processor-affinity-priority-smp-scheduler">Arbitrary * Processor Affinity Priority SMP Scheduler algorithm is made available to * the application. * @@ -4440,7 +4440,7 @@ * support enabled. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * up to 32 processors. * @@ -4456,7 +4456,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Deterministic + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#deterministic-priority-smp-scheduler">Deterministic * Priority SMP Scheduler algorithm is made available to the application. * * @par Default Configuration @@ -4472,7 +4472,7 @@ * support enabled. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * up to 32 processors. * @@ -4488,7 +4488,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Simple + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/uniprocessor-schedulers.html#simple-priority-scheduler">Simple * Priority Scheduler algorithm is made available to the application. * * @par Default Configuration @@ -4501,7 +4501,7 @@ * Think twice before you use it. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * exactly one processor. * @endparblock @@ -4514,7 +4514,7 @@ * @brief This configuration option is a boolean feature define. * * In case this configuration option is defined, then the Simple + * href="https://docs.rtems.org/branches/master/c-user/scheduling-concepts/smp-schedulers.html#simple-priority-smp-scheduler">Simple * Priority SMP Scheduler algorithm is made available to the application. * * @par Default Configuration @@ -4530,7 +4530,7 @@ * support enabled. * * In case no explicit Clustered + * href="https://docs.rtems.org/branches/master/c-user/config/scheduler-clustered.html">Clustered * Scheduler Configuration is present, then it is used as the scheduler for * up to 32 processors. * @endparblock -- cgit v1.2.3