Changeset 96ea30f0 in rtems


Ignore:
Timestamp:
07/03/20 10:41:47 (4 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
5353ea89
Parents:
031f8124
git-author:
Sebastian Huber <sebastian.huber@…> (07/03/20 10:41:47)
git-committer:
Sebastian Huber <sebastian.huber@…> (09/18/20 16:52:49)
Message:

score: Improve Scheduler Handler documentation

Location:
cpukit/include/rtems/score
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/scheduler.h

    r031f8124 r96ea30f0  
    3131
    3232/**
    33  * @defgroup RTEMSScoreScheduler Scheduler Handler
    34  *
    35  * @ingroup RTEMSScore
    36  *
    37  * This handler encapsulates functionality related to managing sets of threads
    38  * that are ready for execution.
     33 * @addtogroup RTEMSScoreScheduler
    3934 *
    4035 * @{
     
    301296
    302297/**
    303  * @brief Registered schedulers.
    304  *
    305  * Application provided via <rtems/confdefs.h>.
     298 * @brief This table contains the configured schedulers.
     299 *
     300 * The table is defined by <rtems/confdefs.h> through the
     301 * #CONFIGURE_SCHEDULER_TABLE_ENTRIES application configuration option.
    306302 *
    307303 * @see _Scheduler_Count.
     
    310306
    311307/**
    312  * @brief Count of registered schedulers.
    313  *
    314  * Application provided via <rtems/confdefs.h> on SMP configurations.
    315  *
    316  * It is very important that this is a compile-time constant on uni-processor
    317  * configurations (in this case RTEMS_SMP is not defined) so that the compiler
    318  * can optimize the some loops away
     308 * @brief This constant contains the count of configured schedulers.
     309 *
     310 * In SMP configurations, the constant is defined by <rtems/confdefs.h> through
     311 * the count of entries of the #CONFIGURE_SCHEDULER_TABLE_ENTRIES application
     312 * configuration option.
     313 *
     314 * In uniprocessor configurations, this is a compile time constant set to one.
     315 * This is important so that the compiler can optimize some loops away.
    319316 *
    320317 * @see _Scheduler_Table.
  • cpukit/include/rtems/score/schedulerimpl.h

    r031f8124 r96ea30f0  
    3535
    3636/**
    37  * @addtogroup RTEMSScoreScheduler
     37 * @defgroup RTEMSScoreScheduler Scheduler Handler
     38 *
     39 * @ingroup RTEMSScore
     40 *
     41 * @brief This handler encapsulates functionality related to managing sets of
     42 *   threads that are ready for execution.
     43 *
     44 * Schedulers are used by the system to manage sets of threads that are ready
     45 * for execution.  A scheduler consists of
     46 *
     47 * * a scheduler algorithm implementation,
     48 *
     49 * * a scheduler index and an associated name, and
     50 *
     51 * * a set of processors owned by the scheduler (may be empty, but never
     52 *   overlaps with a set owned by another scheduler).
     53 *
     54 * Each thread uses exactly one scheduler as its home scheduler.  Threads may
     55 * temporarily use another scheduler due to actions of locking protocols.
     56 *
     57 * All properties of a scheduler can be configured and controlled by the user.
     58 * Some properties are fixed at link time (defined by application configuration
     59 * options), other properties can be changed at runtime through directive
     60 * calls.
     61 *
     62 * The scheduler index, name, and initial processor set are defined for a
     63 * particular application by the application configuration.  The schedulers are
     64 * registered in the ::_Scheduler_Table which has ::_Scheduler_Count entries.
    3865 *
    3966 * @{
Note: See TracChangeset for help on using the changeset viewer.