Changeset 3384994 in rtems-docs


Ignore:
Timestamp:
Nov 13, 2017, 2:25:18 AM (3 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
c6066d4
Parents:
ac0eaff
Message:

Clean up sphinx warnings.

  • Fix minor formatting issues.
  • Fix reference the gloassary TLS using ':term:'.
  • Make sure nothing is between an anchor and the heading where ':ref:' references the anchor. This meant moving all the recently added '.. index::' entries.

Update #3232.
Update #3229.

Files:
2 deleted
33 edited

Legend:

Unmodified
Added
Removed
  • c-user/ada_support.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
    7 .. _ada_support
    8 
    97.. index:: Ada
     8.. _ada_support:
    109
    1110Ada Support
  • c-user/board_support_packages.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
    7 Board Support Packages
    8 **********************
    9 
    107.. index:: Board Support Packages
    118.. index:: BSPs
    129.. index:: BSP, definition
     10
     11Board Support Packages
     12**********************
    1313
    1414Introduction
  • c-user/chains.rst

    rac0eaff r3384994  
    44.. COMMENT: All rights reserved.
    55
     6.. index:: chains
     7
    68Chains
    79******
    8 
    9 .. index:: chains
    1010
    1111Introduction
  • c-user/clock_manager.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: clock
     8
    79Clock Manager
    810*************
    9 
    10 .. index:: clock
    1111
    1212Introduction
  • c-user/configuring_a_system.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: configuring a system
    78.. _Configuring a System:
    8 
    9 .. index:: configuring a system
    109
    1110Configuring a System
     
    443442.. COMMENT: === CONFIGURE_UNLIMITED_OBJECTS ===
    444443
     444.. index:: CONFIGURE_UNLIMITED_OBJECTS
     445
    445446.. _Enable Unlimited Object Instances:
    446 .. index:: CONFIGURE_UNLIMITED_OBJECTS
    447447
    448448Enable Unlimited Object Instances
     
    518518.. COMMENT: === CONFIGURE_MAXIMUM_TASKS ===
    519519
     520.. index:: CONFIGURE_MAXIMUM_TASKS
     521
    520522.. _Specify Maximum Classic API Tasks:
    521 .. index:: CONFIGURE_MAXIMUM_TASKS
    522523
    523524Specify Maximum Classic API Tasks
     
    563564.. COMMENT: === CONFIGURE_MAXIMUM_TIMERS ===
    564565
     566.. index:: CONFIGURE_MAXIMUM_TIMERS
     567
    565568.. _Specify Maximum Classic API Timers:
    566 .. index:: CONFIGURE_MAXIMUM_TIMERS
    567569
    568570Specify Maximum Classic API Timers
     
    590592.. COMMENT: === CONFIGURE_MAXIMUM_SEMAPHORES ===
    591593
     594.. index:: CONFIGURE_MAXIMUM_SEMAPHORES
     595
    592596.. _Specify Maximum Classic API Semaphores:
    593 .. index:: CONFIGURE_MAXIMUM_SEMAPHORES
    594597
    595598Specify Maximum Classic API Semaphores
     
    617620.. COMMENT: === CONFIGURE_MAXIMUM_MRSP_SEMAPHORES ===
    618621
     622.. index:: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
     623
    619624.. _Specify Maximum Classic API Semaphores usable with MrsP:
    620 .. index:: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
    621625
    622626Specify Maximum Classic API Semaphores usable with MrsP
     
    646650.. COMMENT: === CONFIGURE_MAXIMUM_MESSAGE_QUEUES ===
    647651
     652.. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
     653
    648654.. _Specify Maximum Classic API Message Queues:
    649 .. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    650655
    651656Specify Maximum Classic API Message Queues
     
    673678.. COMMENT: === CONFIGURE_MAXIMUM_BARRIERS ===
    674679
     680.. index:: CONFIGURE_MAXIMUM_BARRIERS
     681
    675682.. _Specify Maximum Classic API Barriers:
    676 .. index:: CONFIGURE_MAXIMUM_BARRIERS
    677683
    678684Specify Maximum Classic API Barriers
     
    700706.. COMMENT: === CONFIGURE_MAXIMUM_PERIODS ===
    701707
     708.. index:: CONFIGURE_MAXIMUM_PERIODS
     709
    702710.. _Specify Maximum Classic API Periods:
    703 .. index:: CONFIGURE_MAXIMUM_PERIODS
    704711
    705712Specify Maximum Classic API Periods
     
    727734.. COMMENT: === CONFIGURE_MAXIMUM_PARTITIONS ===
    728735
     736.. index:: CONFIGURE_MAXIMUM_PARTITIONS
     737
    729738.. _Specify Maximum Classic API Partitions:
    730 .. index:: CONFIGURE_MAXIMUM_PARTITIONS
    731739
    732740Specify Maximum Classic API Partitions
     
    754762.. COMMENT: === CONFIGURE_MAXIMUM_REGIONS ===
    755763
     764.. index:: CONFIGURE_MAXIMUM_REGIONS
     765
    756766.. _Specify Maximum Classic API Regions:
    757 .. index:: CONFIGURE_MAXIMUM_REGIONS
    758767
    759768Specify Maximum Classic API Regions
     
    781790.. COMMENT: === CONFIGURE_MAXIMUM_PORTS ===
    782791
     792.. index:: CONFIGURE_MAXIMUM_PORTS
     793
    783794.. _Specify Maximum Classic API Ports:
    784 .. index:: CONFIGURE_MAXIMUM_PORTS
    785795
    786796Specify Maximum Classic API Ports
     
    808818.. COMMENT: === CONFIGURE_MAXIMUM_USER_EXTENSIONS ===
    809819
     820.. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
     821
    810822.. _Specify Maximum Classic API User Extensions:
    811 .. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
    812823
    813824Specify Maximum Classic API User Extensions
     
    844855.. COMMENT: === CONFIGURE_RTEMS_INIT_TASKS_TABLE ===
    845856
     857.. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
     858
    846859.. _Instantiate Classic API Initialization Task Table:
    847 .. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
    848860
    849861Instantiate Classic API Initialization Task Table
     
    881893.. COMMENT: === CONFIGURE_INIT_TASK_ENTRY_POINT ===
    882894
     895.. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
     896
    883897.. _Specifying Classic API Initialization Task Entry Point:
    884 .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
    885898
    886899Specifying Classic API Initialization Task Entry Point
     
    910923.. COMMENT: === CONFIGURE_INIT_TASK_NAME ===
    911924
     925.. index:: CONFIGURE_INIT_TASK_NAME
     926
    912927.. _Specifying Classic API Initialization Task Name:
    913 .. index:: CONFIGURE_INIT_TASK_NAME
    914928
    915929Specifying Classic API Initialization Task Name
     
    937951.. COMMENT: === CONFIGURE_INIT_TASK_STACK_SIZE ===
    938952
     953.. index:: CONFIGURE_INIT_TASK_STACK_SIZE
     954
    939955.. _Specifying Classic API Initialization Task Stack Size:
    940 .. index:: CONFIGURE_INIT_TASK_STACK_SIZE
    941956
    942957Specifying Classic API Initialization Task Stack Size
     
    967982.. COMMENT: === CONFIGURE_INIT_TASK_PRIORITY ===
    968983
     984.. index:: CONFIGURE_INIT_TASK_PRIORITY
     985
    969986.. _Specifying Classic API Initialization Task Priority:
    970 .. index:: CONFIGURE_INIT_TASK_PRIORITY
    971987
    972988Specifying Classic API Initialization Task Priority
     
    9941010.. COMMENT: === CONFIGURE_INIT_TASK_ATTRIBUTES ===
    9951011
     1012.. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
     1013
    9961014.. _Specifying Classic API Initialization Task Attributes:
    997 .. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
    9981015
    9991016Specifying Classic API Initialization Task Attributes
     
    10211038.. COMMENT: === CONFIGURE_INIT_TASK_INITIAL_MODES ===
    10221039
     1040.. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
     1041
    10231042.. _Specifying Classic API Initialization Task Modes:
    1024 .. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
    10251043
    10261044Specifying Classic API Initialization Task Modes
     
    10491067.. COMMENT: === CONFIGURE_INIT_TASK_ARGUMENTS ===
    10501068
     1069.. index:: CONFIGURE_INIT_TASK_ARGUMENTS
     1070
    10511071.. _Specifying Classic API Initialization Task Arguments:
    1052 .. index:: CONFIGURE_INIT_TASK_ARGUMENTS
    10531072
    10541073Specifying Classic API Initialization Task Arguments
     
    10761095.. COMMENT: === CONFIGURE_HAS_OWN_INIT_TASK_TABLE ===
    10771096
     1097.. index:: CONFIGURE_HAS_OWN_INIT_TASK_TABLE
     1098
    10781099.. _Not Using Generated Initialization Tasks Table:
    1079 .. index:: CONFIGURE_HAS_OWN_INIT_TASK_TABLE
    10801100
    10811101Not Using Generated Initialization Tasks Table
     
    11141134.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_THREADS ===
    11151135
     1136.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
     1137
    11161138.. _Specify Maximum POSIX API Threads:
    1117 .. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
    11181139
    11191140Specify Maximum POSIX API Threads
     
    11541175.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_KEYS ===
    11551176
     1177.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
     1178
    11561179.. _Specify Maximum POSIX API Keys:
    1157 .. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
    11581180
    11591181Specify Maximum POSIX API Keys
     
    11831205.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_TIMERS ===
    11841206
     1207.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
     1208
    11851209.. _Specify Maximum POSIX API Timers:
    1186 .. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
    11871210
    11881211Specify Maximum POSIX API Timers
     
    12101233.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS ===
    12111234
     1235.. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
     1236
    12121237.. _Specify Maximum POSIX API Queued Signals:
    1213 .. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
    12141238
    12151239Specify Maximum POSIX API Queued Signals
     
    12371261.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES ===
    12381262
     1263.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
     1264
    12391265.. _Specify Maximum POSIX API Message Queues:
    1240 .. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
    12411266
    12421267Specify Maximum POSIX API Message Queues
     
    12641289.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_SEMAPHORES ===
    12651290
     1291.. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
     1292
    12661293.. _Specify Maximum POSIX API Semaphores:
    1267 .. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
    12681294
    12691295Specify Maximum POSIX API Named Semaphores
     
    13031329.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_TABLE ===
    13041330
     1331.. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
     1332
    13051333.. _Instantiate POSIX API Initialization Thread Table:
    1306 .. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
    13071334
    13081335Instantiate POSIX API Initialization Thread Table
     
    13421369.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT ===
    13431370
     1371.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
     1372
    13441373.. _Specifying POSIX API Initialization Thread Entry Point:
    1345 .. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    13461374
    13471375Specifying POSIX API Initialization Thread Entry Point
     
    13711399.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE ===
    13721400
     1401.. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
     1402
    13731403.. _Specifying POSIX API Initialization Thread Stack Size:
    1374 .. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    13751404
    13761405Specifying POSIX API Initialization Thread Stack Size
     
    14021431.. COMMENT: === CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE ===
    14031432
     1433.. index:: CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
     1434
    14041435.. _Not Using Generated POSIX Initialization Threads Table:
    1405 .. index:: CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
    14061436
    14071437Not Using Generated POSIX Initialization Threads Table
     
    14391469.. COMMENT: === CONFIGURE_UNIFIED_WORK_AREAS ===
    14401470
    1441 .. _Separate or Unified Work Areas:
    14421471.. index:: CONFIGURE_UNIFIED_WORK_AREAS
    14431472.. index:: unified work areas
     
    14461475.. index:: C Program Heap
    14471476
     1477.. _Separate or Unified Work Areas:
     1478
    14481479Separate or Unified Work Areas
    14491480------------------------------
     
    14821513.. COMMENT: === CONFIGURE_MAXIMUM_PROCESSORS ===
    14831514
     1515.. index:: CONFIGURE_MAXIMUM_PROCESSORS
     1516
    14841517.. _CONFIGURE_MAXIMUM_PROCESSORS:
    1485 .. index:: CONFIGURE_MAXIMUM_PROCESSORS
    14861518
    14871519Specify Maximum Processors
     
    15151547.. COMMENT: === CONFIGURE_MICROSECONDS_PER_TICK ===
    15161548
    1517 .. _CONFIGURE_MICROSECONDS_PER_TICK:
    15181549.. index:: CONFIGURE_MICROSECONDS_PER_TICK
    15191550.. index:: tick quantum
     1551
     1552.. _CONFIGURE_MICROSECONDS_PER_TICK:
    15201553
    15211554Length of Each Clock Tick
     
    15621595.. COMMENT: === CONFIGURE_TICKS_PER_TIMESLICE ===
    15631596
    1564 .. _Specifying Timeslicing Quantum:
    15651597.. index:: CONFIGURE_TICKS_PER_TIMESLICE
    15661598.. index:: ticks per timeslice
    15671599
     1600.. _Specifying Timeslicing Quantum:
     1601
    15681602Specifying Timeslicing Quantum
    15691603------------------------------
     
    15911625.. COMMENT: === CONFIGURE_MAXIMUM_PRIORITY ===
    15921626
    1593 .. _Specifying the Number of Thread Priority Levels:
    15941627.. index:: CONFIGURE_MAXIMUM_PRIORITY
    15951628.. index:: maximum priority
    15961629.. index:: number of priority levels
     1630
     1631.. _Specifying the Number of Thread Priority Levels:
    15971632
    15981633Specifying the Number of Thread Priority Levels
     
    16381673.. COMMENT: === CONFIGURE_MAXIMUM_THREAD_NAME_SIZE ===
    16391674
    1640 .. _CONFIGURE_MAXIMUM_THREAD_NAME_SIZE:
    16411675.. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE
    16421676.. index:: maximum thread name size
     1677
     1678.. _CONFIGURE_MAXIMUM_THREAD_NAME_SIZE:
    16431679
    16441680Specifying the Maximum Thread Name Size
     
    16691705.. COMMENT: === CONFIGURE_MINIMUM_TASK_STACK_SIZE ===
    16701706
    1671 .. _Specifying the Minimum Task Size:
    16721707.. index:: CONFIGURE_MINIMUM_TASK_STACK_SIZE
    16731708.. index:: minimum task stack size
     1709
     1710.. _Specifying the Minimum Task Size:
    16741711
    16751712Specifying the Minimum Task Size
     
    17081745.. COMMENT: === CONFIGURE_INTERRUPT_STACK_SIZE ===
    17091746
    1710 .. _Configuring the Size of the Interrupt Stack:
    17111747.. index:: CONFIGURE_INTERRUPT_STACK_SIZE
    17121748.. index:: interrupt stack size
     1749
     1750.. _Configuring the Size of the Interrupt Stack:
    17131751
    17141752Configuring the Size of the Interrupt Stack
     
    17431781.. COMMENT: === CONFIGURE_EXTRA_TASK_STACKS ===
    17441782
    1745 .. _Reserve Task/Thread Stack Memory Above Minimum:
    17461783.. index:: CONFIGURE_EXTRA_TASK_STACKS
    17471784.. index:: memory for task tasks
     1785
     1786.. _Reserve Task/Thread Stack Memory Above Minimum:
    17481787
    17491788Reserve Task/Thread Stack Memory Above Minimum
     
    17741813.. COMMENT: === CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY ===
    17751814
    1776 .. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
    17771815.. index:: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
    17781816.. index:: clear C Program Heap
     
    17811819.. index:: zero RTEMS Workspace
    17821820
     1821.. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
     1822
    17831823Automatically Zeroing the RTEMS Workspace and C Program Heap
    17841824------------------------------------------------------------
     
    18081848.. COMMENT: === CONFIGURE_STACK_CHECKER_ENABLED ===
    18091849
     1850.. index:: CONFIGURE_STACK_CHECKER_ENABLED
     1851
    18101852.. _Enable The Task Stack Usage Checker:
    1811 .. index:: CONFIGURE_STACK_CHECKER_ENABLED
    18121853
    18131854Enable The Task Stack Usage Checker
     
    18381879.. COMMENT: === CONFIGURE_INITIAL_EXTENSIONS ===
    18391880
     1881.. index:: CONFIGURE_INITIAL_EXTENSIONS
     1882
    18401883.. _CONFIGURE_INITIAL_EXTENSIONS:
    1841 .. index:: CONFIGURE_INITIAL_EXTENSIONS
    18421884
    18431885Specify Application Specific User Extensions
     
    18761918.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR_INIT ===
    18771919
     1920.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
     1921
    18781922.. _Custom Task Stack Allocator Initialization:
    1879 .. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
    18801923
    18811924Custom Task Stack Allocator Initialization
     
    19111954.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR ===
    19121955
    1913 .. _Custom Task Stack Allocator:
    19141956.. index:: CONFIGURE_TASK_STACK_ALLOCATOR
    19151957.. index:: task stack allocator
    19161958
     1959.. _Custom Task Stack Allocator:
     1960
    19171961Custom Task Stack Allocator
    19181962---------------------------
     
    19461990.. COMMENT: === CONFIGURE_TASK_STACK_DEALLOCATOR ===
    19471991
    1948 .. _Custom Task Stack Deallocator:
    19491992.. index:: CONFIGURE_TASK_STACK_DEALLOCATOR
    19501993.. index:: task stack deallocator
    19511994
     1995.. _Custom Task Stack Deallocator:
     1996
    19521997Custom Task Stack Deallocator
    19531998-----------------------------
     
    19892034.. COMMENT: === CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE ===
    19902035
    1991 .. _Calculate Memory for a Single Classic Message API Message Queue:
    19922036.. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
    19932037.. index:: memory for a single message queue's buffers
     2038
     2039.. _Calculate Memory for a Single Classic Message API Message Queue:
    19942040
    19952041Calculate Memory for a Single Classic Message API Message Queue
     
    20292075.. COMMENT: === CONFIGURE_MESSAGE_BUFFER_MEMORY ===
    20302076
    2031 .. _Reserve Memory for All Classic Message API Message Queues:
    20322077.. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY
    20332078.. index:: configure message queue buffer memory
     2079
     2080.. _Reserve Memory for All Classic Message API Message Queues:
    20342081
    20352082Reserve Memory for All Classic Message API Message Queues
     
    20842131.. COMMENT: === CONFIGURE_MEMORY_OVERHEAD ===
    20852132
     2133.. index:: CONFIGURE_MEMORY_OVERHEAD
     2134
    20862135.. _Specify Memory Overhead:
    2087 .. index:: CONFIGURE_MEMORY_OVERHEAD
    20882136
    20892137Specify Memory Overhead
     
    21142162.. COMMENT: === CONFIGURE_HAS_OWN_CONFIGURATION_TABLE ===
    21152163
     2164.. index:: CONFIGURE_HAS_OWN_CONFIGURATION_TABLE
     2165
    21162166.. _Do Not Generate Configuration Information:
    2117 .. index:: CONFIGURE_HAS_OWN_CONFIGURATION_TABLE
    21182167
    21192168Do Not Generate Configuration Information
     
    21492198.. COMMENT: === CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS ===
    21502199
    2151 .. _Specify Maximum Number of File Descriptors:
    21522200.. index:: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
    21532201.. index:: maximum file descriptors
     2202
     2203.. _Specify Maximum Number of File Descriptors:
    21542204
    21552205Specify Maximum Number of File Descriptors
     
    21802230.. COMMENT: === CONFIGURE_TERMIOS_DISABLED ===
    21812231
     2232.. index:: CONFIGURE_TERMIOS_DISABLED
     2233
    21822234.. _Disable POSIX Termios Support:
    2183 .. index:: CONFIGURE_TERMIOS_DISABLED
    21842235
    21852236Disable POSIX Termios Support
     
    22102261.. COMMENT: === CONFIGURE_NUMBER_OF_TERMIOS_PORTS ===
    22112262
     2263.. index:: CONFIGURE_NUMBER_OF_TERMIOS_PORTS
     2264
    22122265.. _Specify Maximum Termios Ports:
    2213 .. index:: CONFIGURE_NUMBER_OF_TERMIOS_PORTS
    22142266
    22152267Specify Maximum Termios Ports
     
    22482300.. COMMENT: === CONFIGURE_HAS_OWN_MOUNT_TABLE ===
    22492301
     2302.. index:: CONFIGURE_HAS_OWN_MOUNT_TABLE
     2303
    22502304.. _Providing Application Specific Mount Table:
    2251 .. index:: CONFIGURE_HAS_OWN_MOUNT_TABLE
    22522305
    22532306Providing Application Specific Mount Table
     
    22822335.. COMMENT: === CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM ===
    22832336
     2337.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
     2338
    22842339.. _Configure devFS as Root File System:
    2285 .. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
    22862340
    22872341Configure devFS as Root File System
     
    23142368.. COMMENT: === CONFIGURE_MAXIMUM_DEVICES ===
    23152369
     2370.. index:: CONFIGURE_MAXIMUM_DEVICES
     2371
    23162372.. _Specifying Maximum Devices for devFS:
    2317 .. index:: CONFIGURE_MAXIMUM_DEVICES
    23182373
    23192374Specifying Maximum Devices for devFS
     
    23452400.. COMMENT: === CONFIGURE_APPLICATION_DISABLE_FILESYSTEM ===
    23462401
     2402.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
     2403
    23472404.. _Disable File System Support:
    2348 .. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
    23492405
    23502406Disable File System Support
     
    23742430.. COMMENT: === CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM ===
    23752431
     2432.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
     2433
    23762434.. _Use a Root IMFS with a Minimalistic Feature Set:
    2377 .. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
    23782435
    23792436Use a Root IMFS with a Minimalistic Feature Set
     
    24142471.. COMMENT: === CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK ===
    24152472
     2473.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
     2474
    24162475.. _Specify Block Size for IMFS:
    2417 .. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
    24182476
    24192477Specify Block Size for IMFS
     
    24642522.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHOWN ===
    24652523
     2524.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
     2525
    24662526.. _Disable Change Owner Support of Root IMFS:
    2467 .. index:: CONFIGURE_IMFS_DISABLE_CHOWN
    24682527
    24692528Disable Change Owner Support of Root IMFS
     
    24882547.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHMOD ===
    24892548
     2549.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
     2550
    24902551.. _Disable Change Mode Support of Root IMFS:
    2491 .. index:: CONFIGURE_IMFS_DISABLE_CHMOD
    24922552
    24932553Disable Change Mode Support of Root IMFS
     
    25122572.. COMMENT: === CONFIGURE_IMFS_DISABLE_UTIME ===
    25132573
     2574.. index:: CONFIGURE_IMFS_DISABLE_UTIME
     2575
    25142576.. _Disable Change Times Support of Root IMFS:
    2515 .. index:: CONFIGURE_IMFS_DISABLE_UTIME
    25162577
    25172578Disable Change Times Support of Root IMFS
     
    25362597.. COMMENT: === CONFIGURE_IMFS_DISABLE_LINK ===
    25372598
     2599.. index:: CONFIGURE_IMFS_DISABLE_LINK
     2600
    25382601.. _Disable Create Hard Link Support of Root IMFS:
    2539 .. index:: CONFIGURE_IMFS_DISABLE_LINK
    25402602
    25412603Disable Create Hard Link Support of Root IMFS
     
    25602622.. COMMENT: === CONFIGURE_IMFS_DISABLE_SYMLINK ===
    25612623
     2624.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
     2625
    25622626.. _Disable Create Symbolic Link Support of Root IMFS:
    2563 .. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
    25642627
    25652628Disable Create Symbolic Link Support of Root IMFS
     
    25842647.. COMMENT: === CONFIGURE_IMFS_DISABLE_READLINK ===
    25852648
     2649.. index:: CONFIGURE_IMFS_DISABLE_READLINK
     2650
    25862651.. _Disable Read Symbolic Link Support of Root IMFS:
    2587 .. index:: CONFIGURE_IMFS_DISABLE_READLINK
    25882652
    25892653Disable Read Symbolic Link Support of Root IMFS
     
    26082672.. COMMENT: === CONFIGURE_IMFS_DISABLE_RENAME ===
    26092673
     2674.. index:: CONFIGURE_IMFS_DISABLE_RENAME
     2675
    26102676.. _Disable Rename Support of Root IMFS:
    2611 .. index:: CONFIGURE_IMFS_DISABLE_RENAME
    26122677
    26132678Disable Rename Support of Root IMFS
     
    26322697.. COMMENT: === CONFIGURE_IMFS_DISABLE_READDIR ===
    26332698
     2699.. index:: CONFIGURE_IMFS_DISABLE_READDIR
     2700
    26342701.. _Disable Directory Read Support of Root IMFS:
    2635 .. index:: CONFIGURE_IMFS_DISABLE_READDIR
    26362702
    26372703Disable Directory Read Support of Root IMFS
     
    26572723.. COMMENT: === CONFIGURE_IMFS_DISABLE_MOUNT ===
    26582724
     2725.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
     2726
    26592727.. _Disable Mount Support of Root IMFS:
    2660 .. index:: CONFIGURE_IMFS_DISABLE_MOUNT
    26612728
    26622729Disable Mount Support of Root IMFS
     
    26812748.. COMMENT: === CONFIGURE_IMFS_DISABLE_UNMOUNT ===
    26822749
     2750.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
     2751
    26832752.. _Disable Unmount Support of Root IMFS:
    2684 .. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
    26852753
    26862754Disable Unmount Support of Root IMFS
     
    27052773.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD ===
    27062774
     2775.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
     2776
    27072777.. _Disable Make Nodes Support of Root IMFS:
    2708 .. index:: CONFIGURE_IMFS_DISABLE_MKNOD
    27092778
    27102779Disable Make Nodes Support of Root IMFS
     
    27292798.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD_FILE ===
    27302799
     2800.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
     2801
    27312802.. _Disable Make Files Support of Root IMFS:
    2732 .. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
    27332803
    27342804Disable Make Files Support of Root IMFS
     
    27532823.. COMMENT: === CONFIGURE_IMFS_DISABLE_RMNOD ===
    27542824
     2825.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
     2826
    27552827.. _Disable Remove Nodes Support of Root IMFS:
    2756 .. index:: CONFIGURE_IMFS_DISABLE_RMNOD
    27572828
    27582829Disable Remove Nodes Support of Root IMFS
     
    27852856.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_LIBBLOCK ===
    27862857
     2858.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
     2859
    27872860.. _Enable Block Device Cache:
    2788 .. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
    27892861
    27902862Enable Block Device Cache
     
    28132885.. COMMENT: === CONFIGURE_BDBUF_CACHE_MEMORY_SIZE ===
    28142886
     2887.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
     2888
    28152889.. _Size of the Cache Memory:
    2816 .. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
    28172890
    28182891Size of the Cache Memory
     
    28392912.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MIN_SIZE ===
    28402913
     2914.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
     2915
    28412916.. _Minimum Size of a Buffer:
    2842 .. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
    28432917
    28442918Minimum Size of a Buffer
     
    28652939.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MAX_SIZE ===
    28662940
     2941.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
     2942
    28672943.. _Maximum Size of a Buffer:
    2868 .. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    28692944
    28702945Maximum Size of a Buffer
     
    28912966.. COMMENT: === CONFIGURE_SWAPOUT_SWAP_PERIOD ===
    28922967
     2968.. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
     2969
    28932970.. _Swapout Task Swap Period:
    2894 .. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
    28952971
    28962972Swapout Task Swap Period
     
    29172993.. COMMENT: === CONFIGURE_SWAPOUT_BLOCK_HOLD ===
    29182994
     2995.. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
     2996
    29192997.. _Swapout Task Maximum Block Hold Time:
    2920 .. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
    29212998
    29222999Swapout Task Maximum Block Hold Time
     
    29433020.. COMMENT: === CONFIGURE_SWAPOUT_TASK_PRIORITY ===
    29443021
     3022.. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
     3023
    29453024.. _Swapout Task Priority:
    2946 .. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
    29473025
    29483026Swapout Task Priority
     
    29693047.. COMMENT: === CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS ===
    29703048
     3049.. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
     3050
    29713051.. _Maximum Blocks per Read-Ahead Request:
    2972 .. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
    29733052
    29743053Maximum Blocks per Read-Ahead Request
     
    29973076.. COMMENT: === CONFIGURE_BDBUF_MAX_WRITE_BLOCKS ===
    29983077
     3078.. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
     3079
    29993080.. _Maximum Blocks per Write Request:
    3000 .. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
    30013081
    30023082Maximum Blocks per Write Request
     
    30233103.. COMMENT: === CONFIGURE_BDBUF_TASK_STACK_SIZE ===
    30243104
     3105.. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
     3106
    30253107.. _Task Stack Size of the Block Device Cache Tasks:
    3026 .. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
    30273108
    30283109Task Stack Size of the Block Device Cache Tasks
     
    30493130.. COMMENT: === CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY ===
    30503131
     3132.. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
     3133
    30513134.. _Read-Ahead Task Priority:
    3052 .. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    30533135
    30543136Read-Ahead Task Priority
     
    30753157.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASKS ===
    30763158
     3159.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
     3160
    30773161.. _Swapout Worker Task Count:
    3078 .. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
    30793162
    30803163Swapout Worker Task Count
     
    31013184.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY ===
    31023185
     3186.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
     3187
    31033188.. _Swapout Worker Task Priority:
    3104 .. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    31053189
    31063190Swapout Worker Task Priority
     
    31363220.. COMMENT: === Disable BSP Settings ===
    31373221
     3222.. index:: CONFIGURE_DISABLE_BSP_SETTINGS
     3223
    31383224.. _Disable BSP Configuration Settings:
    3139 .. index:: CONFIGURE_DISABLE_BSP_SETTINGS
    31403225
    31413226Disable BSP Configuration Settings
     
    31633248.. COMMENT: === CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK ===
    31643249
     3250.. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
     3251
    31653252.. _Specify BSP Supports sbrk():
    3166 .. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    31673253
    31683254Specify BSP Supports sbrk()
     
    31953281.. COMMENT: === BSP_IDLE_TASK_BODY ===
    31963282
     3283.. index:: BSP_IDLE_TASK_BODY
     3284
    31973285.. _Specify BSP Specific Idle Task:
    3198 .. index:: BSP_IDLE_TASK_BODY
    31993286
    32003287Specify BSP Specific Idle Task
     
    32253312.. COMMENT: === BSP_IDLE_TASK_STACK_SIZE ===
    32263313
     3314.. index:: BSP_IDLE_TASK_STACK_SIZE
     3315
    32273316.. _Specify BSP Suggested Value for IDLE Task Stack Size:
    3228 .. index:: BSP_IDLE_TASK_STACK_SIZE
    32293317
    32303318Specify BSP Suggested Value for IDLE Task Stack Size
     
    32633351.. COMMENT: === BSP_INITIAL_EXTENSION ===
    32643352
     3353.. index:: BSP_INITIAL_EXTENSION
     3354
    32653355.. _Specify BSP Specific User Extensions:
    3266 .. index:: BSP_INITIAL_EXTENSION
    32673356
    32683357Specify BSP Specific User Extensions
     
    32913380.. COMMENT: === BSP_INTERRUPT_STACK_SIZE ===
    32923381
     3382.. index:: BSP_INTERRUPT_STACK_SIZE
     3383
    32933384.. _Specifying BSP Specific Interrupt Stack Size:
    3294 .. index:: BSP_INTERRUPT_STACK_SIZE
    32953385
    32963386Specifying BSP Specific Interrupt Stack Size
     
    33193409.. COMMENT: === BSP_MAXIMUM_DEVICES ===
    33203410
     3411.. index:: BSP_MAXIMUM_DEVICES
     3412
    33213413.. _Specifying BSP Specific Maximum Devices:
    3322 .. index:: BSP_MAXIMUM_DEVICES
    33233414
    33243415Specifying BSP Specific Maximum Devices
     
    33503441.. COMMENT: === BSP_ZERO_WORKSPACE_AUTOMATICALLY ===
    33513442
     3443.. index:: BSP_ZERO_WORKSPACE_AUTOMATICALLY
     3444
    33523445.. _BSP Recommends RTEMS Workspace be Cleared:
    3353 .. index:: BSP_ZERO_WORKSPACE_AUTOMATICALLY
    33543446
    33553447BSP Recommends RTEMS Workspace be Cleared
     
    33793471.. COMMENT: === CONFIGURE_BSP_PREREQUISITE_DRIVERS ===
    33803472
     3473.. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
     3474
    33813475.. _Specify BSP Prerequisite Drivers:
    3382 .. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
    33833476
    33843477Specify BSP Prerequisite Drivers
     
    34193512.. COMMENT: === CONFIGURE_IDLE_TASK_BODY ===
    34203513
     3514.. index:: CONFIGURE_IDLE_TASK_BODY
     3515
    34213516.. _Specify Application Specific Idle Task Body:
    3422 .. index:: CONFIGURE_IDLE_TASK_BODY
    34233517
    34243518Specify Application Specific Idle Task Body
     
    34473541.. COMMENT: === CONFIGURE_IDLE_TASK_STACK_SIZE ===
    34483542
     3543.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
     3544
    34493545.. _Specify Idle Task Stack Size:
    3450 .. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
    34513546
    34523547Specify Idle Task Stack Size
     
    34743569.. COMMENT: === CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION ===
    34753570
     3571.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
     3572
    34763573.. _Specify Idle Task Performs Application Initialization:
    3477 .. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
    34783574
    34793575Specify Idle Task Performs Application Initialization
     
    35243620.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY ===
    35253621
     3622.. index:: CONFIGURE_SCHEDULER_PRIORITY
     3623
    35263624.. _Use Deterministic Priority Scheduler:
    3527 .. index:: CONFIGURE_SCHEDULER_PRIORITY
    35283625
    35293626Use Deterministic Priority Scheduler
     
    35573654.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE ===
    35583655
     3656.. index:: CONFIGURE_SCHEDULER_SIMPLE
     3657
    35593658.. _Use Simple Priority Scheduler:
    3560 .. index:: CONFIGURE_SCHEDULER_SIMPLE
    35613659
    35623660Use Simple Priority Scheduler
     
    35923690.. COMMENT: === CONFIGURE_SCHEDULER_EDF ===
    35933691
     3692.. index:: CONFIGURE_SCHEDULER_EDF
     3693
    35943694.. _Use Earliest Deadline First Scheduler:
    3595 .. index:: CONFIGURE_SCHEDULER_EDF
    35963695
    35973696Use Earliest Deadline First Scheduler
     
    36293728.. COMMENT: === CONFIGURE_SCHEDULER_EDF_SMP ===
    36303729
     3730.. index:: CONFIGURE_SCHEDULER_EDF_SMP
     3731
    36313732.. _Use Earliest Deadline First SMP Scheduler:
    3632 .. index:: CONFIGURE_SCHEDULER_EDF_SMP
    36333733
    36343734Use Earliest Deadline First Scheduler
     
    36563756.. COMMENT: === CONFIGURE_SCHEDULER_CBS ===
    36573757
     3758.. index:: CONFIGURE_SCHEDULER_CBS
     3759
    36583760.. _Use Constant Bandwidth Server Scheduler:
    3659 .. index:: CONFIGURE_SCHEDULER_CBS
    36603761
    36613762Use Constant Bandwidth Server Scheduler
     
    36913792.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY_SMP ===
    36923793
     3794.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
     3795
    36933796.. _Use Deterministic Priority SMP Scheduler:
    3694 .. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
    36953797
    36963798Use Deterministic Priority SMP Scheduler
     
    37263828.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE_SMP ===
    37273829
     3830.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
     3831
    37283832.. _Use Simple SMP Priority Scheduler:
    3729 .. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
    37303833
    37313834Use Simple SMP Priority Scheduler
     
    37673870.. COMMENT: === Configuring a Scheduler Name ===
    37683871
     3872.. index:: CONFIGURE_SCHEDULER_NAME
     3873
    37693874.. _Configuring a Scheduler Name:
    3770 .. index:: CONFIGURE_SCHEDULER_NAME
    37713875
    37723876Configuring a Scheduler Name
     
    38013905.. COMMENT: === Configuring a User Scheduler ===
    38023906
     3907.. index:: CONFIGURE_SCHEDULER_USER
     3908
    38033909.. _Configuring a User Provided Scheduler:
    3804 .. index:: CONFIGURE_SCHEDULER_USER
    38053910
    38063911Configuring a User Provided Scheduler
     
    40304135.. COMMENT: === CONFIGURE_MAXIMUM_DRIVERS ===
    40314136
     4137.. index:: CONFIGURE_MAXIMUM_DRIVERS
     4138
    40324139.. _Specifying the Maximum Number of Device Drivers:
    4033 .. index:: CONFIGURE_MAXIMUM_DRIVERS
    40344140
    40354141Specifying the Maximum Number of Device Drivers
     
    40644170.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER ===
    40654171
     4172.. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
     4173
    40664174.. _Enable Console Device Driver:
    4067 .. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
    40684175
    40694176Enable Console Device Driver
     
    40954202.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER ===
    40964203
     4204.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
     4205
    40974206.. _Enable Clock Driver:
    4098 .. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    40994207
    41004208Enable Clock Driver
     
    41284236.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER ===
    41294237
     4238.. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
     4239
    41304240.. _Enable the Benchmark Timer Driver:
    4131 .. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    41324241
    41334242Enable the Benchmark Timer Driver
     
    41594268.. COMMENT: === CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER ===
    41604269
     4270.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
     4271
    41614272.. _Specify Clock and Benchmark Timer Drivers Are Not Needed:
    4162 .. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
    41634273
    41644274Specify Clock and Benchmark Timer Drivers Are Not Needed
     
    41904300.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER ===
    41914301
     4302.. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
     4303
    41924304.. _Enable Real-Time Clock Driver:
    4193 .. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
    41944305
    41954306Enable Real-Time Clock Driver
     
    42214332.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER ===
    42224333
     4334.. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
     4335
    42234336.. _Enable the Watchdog Device Driver:
    4224 .. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
    42254337
    42264338Enable the Watchdog Device Driver
     
    42524364.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER ===
    42534365
     4366.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
     4367
    42544368.. _Enable the Graphics Frame Buffer Device Driver:
    4255 .. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
    42564369
    42574370Enable the Graphics Frame Buffer Device Driver
     
    42834396.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER ===
    42844397
     4398.. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
     4399
    42854400.. _Enable Stub Device Driver:
    4286 .. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
    42874401
    42884402Enable Stub Device Driver
     
    43114425.. COMMENT: === CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS ===
    43124426
     4427.. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
     4428
    43134429.. _Specify Application Prerequisite Device Drivers:
    4314 .. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
    43154430
    43164431Specify Application Prerequisite Device Drivers
     
    43474462.. COMMENT: === CONFIGURE_APPLICATION_EXTRA_DRIVERS ===
    43484463
     4464.. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
     4465
    43494466.. _Specify Extra Application Device Drivers:
    4350 .. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
    43514467
    43524468Specify Extra Application Device Drivers
     
    43764492.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER ===
    43774493
    4378 .. _Enable /dev/null Device Driver:
    43794494.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
    43804495.. index:: /dev/null
    43814496
     4497.. _Enable /dev/null Device Driver:
     4498
    43824499Enable /dev/null Device Driver
    43834500------------------------------
     
    44034520.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER ===
    44044521
    4405 .. _Enable /dev/zero Device Driver:
    44064522.. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
    44074523.. index:: /dev/zero
    44084524
     4525.. _Enable /dev/zero Device Driver:
     4526
    44094527Enable /dev/zero Device Driver
    44104528------------------------------
     
    44304548.. COMMENT: === CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE ===
    44314549
     4550.. index:: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
     4551
    44324552.. _Specifying Application Defined Device Driver Table:
    4433 .. index:: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
    44344553
    44354554Specifying Application Defined Device Driver Table
     
    44764595.. COMMENT: === CONFIGURE_MP_APPLICATION ===
    44774596
     4597.. index:: CONFIGURE_MP_APPLICATION
     4598
    44784599.. _Specify Application Will Use Multiprocessing:
    4479 .. index:: CONFIGURE_MP_APPLICATION
    44804600
    44814601Specify Application Will Use Multiprocessing
     
    45064626.. COMMENT: === CONFIGURE_MP_NODE_NUMBER ===
    45074627
     4628.. index:: CONFIGURE_MP_NODE_NUMBER
     4629
    45084630.. _Configure Node Number in Multiprocessor Configuration:
    4509 .. index:: CONFIGURE_MP_NODE_NUMBER
    45104631
    45114632Configure Node Number in Multiprocessor Configuration
     
    45374658.. COMMENT: === CONFIGURE_MP_MAXIMUM_NODES ===
    45384659
     4660.. index:: CONFIGURE_MP_MAXIMUM_NODES
     4661
    45394662.. _Configure Maximum Node in Multiprocessor Configuration:
    4540 .. index:: CONFIGURE_MP_MAXIMUM_NODES
    45414663
    45424664Configure Maximum Node in Multiprocessor Configuration
     
    45644686.. COMMENT: === CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS ===
    45654687
     4688.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
     4689
    45664690.. _Configure Maximum Global Objects in Multiprocessor Configuration:
    4567 .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    45684691
    45694692Configure Maximum Global Objects in Multiprocessor Configuration
     
    45924715.. COMMENT: === CONFIGURE_MP_MAXIMUM_PROXIES ===
    45934716
     4717.. index:: CONFIGURE_MP_MAXIMUM_PROXIES
     4718
    45944719.. _Configure Maximum Proxies in Multiprocessor Configuration:
    4595 .. index:: CONFIGURE_MP_MAXIMUM_PROXIES
    45964720
    45974721Configure Maximum Proxies in Multiprocessor Configuration
     
    46234747.. COMMENT: === CONFIGURE_MP_MPCI_TABLE_POINTER ===
    46244748
     4749.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
     4750
    46254751.. _Configure MPCI in Multiprocessor Configuration:
    4626 .. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
    46274752
    46284753Configure MPCI in Multiprocessor Configuration
     
    46524777.. COMMENT: === CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE ===
    46534778
     4779.. index:: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
     4780
    46544781.. _Do Not Generate Multiprocessor Configuration Table:
    4655 .. index:: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
    46564782
    46574783Do Not Generate Multiprocessor Configuration Table
     
    46994825.. COMMENT: === CONFIGURE_GNAT_RTEMS ===
    47004826
     4827.. index:: CONFIGURE_GNAT_RTEMS
     4828
    47014829.. _Specify Application Includes Ada Code:
    4702 .. index:: CONFIGURE_GNAT_RTEMS
    47034830
    47044831Specify Application Includes Ada Code
     
    47284855.. COMMENT: === CONFIGURE_MAXIMUM_ADA_TASKS ===
    47294856
     4857.. index:: CONFIGURE_MAXIMUM_ADA_TASKS
     4858
    47304859.. _Specify the Maximum Number of Ada Tasks.:
    4731 .. index:: CONFIGURE_MAXIMUM_ADA_TASKS
    47324860
    47334861Specify the Maximum Number of Ada Tasks.
     
    47564884.. COMMENT: === CONFIGURE_MAXIMUM_FAKE_ADA_TASKS ===
    47574885
     4886.. index:: CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
     4887
    47584888.. _Specify the Maximum Fake Ada Tasks:
    4759 .. index:: CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
    47604889
    47614890Specify the Maximum Fake Ada Tasks
     
    48444973.. COMMENT: === CONFIGURE_ENABLE_GO ===
    48454974
     4975.. index:: CONFIGURE_ENABLE_GO
     4976
    48464977.. _Specify Application Includes Go Code:
    4847 .. index:: CONFIGURE_ENABLE_GO
    48484978
    48494979Specify Application Includes Go Code
     
    48715001.. COMMENT: === CONFIGURE_MAXIMUM_GOROUTINES ===
    48725002
     5003.. index:: CONFIGURE_MAXIMUM_GOROUTINES
     5004
    48735005.. _Specify the maximum number of Go routines:
    4874 .. index:: CONFIGURE_MAXIMUM_GOROUTINES
    48755006
    48765007Specify the maximum number of Go routines
     
    48985029.. COMMENT: === CONFIGURE_MAXIMUM_GO_CHANNELS ===
    48995030
     5031.. index:: CONFIGURE_MAXIMUM_GO_CHANNELS
     5032
    49005033.. _Specify the maximum number of Go Channels:
    4901 .. index:: CONFIGURE_MAXIMUM_GO_CHANNELS
    49025034
    49035035Specify the maximum number of Go Channels
  • c-user/constant_bandwidth_server.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: cbs
     8
    79Constant Bandwidth Server Scheduler API
    810***************************************
    9 
    10 .. index:: cbs
    1111
    1212Introduction
     
    4141- rtems_cbs_get_approved_budget_ - Get scheduler approved execution time
    4242
     43.. index:: CBS parameters
     44.. index:: rtems_cbs_parameters
     45
    4346Background
    4447==========
    45 .. index:: CBS parameters
    46 .. index:: rtems_cbs_parameters
    4748
    4849Constant Bandwidth Server Definitions
     
    233234   \clearpage
    234235
    235 .. _rtems_cbs_initialize:
    236236.. index:: initialize the CBS library
    237237.. index:: rtems_cbs_initialize
     238.. _rtems_cbs_initialize:
    238239
    239240CBS_INITIALIZE - Initialize the CBS library
     
    271272   \clearpage
    272273
    273 .. _rtems_cbs_cleanup:
    274274.. index:: cleanup the CBS library
    275275.. index:: rtems_cbs_cleanup
    276276
     277.. _rtems_cbs_cleanup:
     278
    277279CBS_CLEANUP - Cleanup the CBS library
    278280-------------------------------------
     
    301303   \clearpage
    302304
    303 .. _rtems_cbs_create_server:
    304305.. index:: create a new bandwidth server
    305306.. index:: rtems_cbs_create_server
     307
     308.. _rtems_cbs_create_server:
    306309
    307310CBS_CREATE_SERVER - Create a new bandwidth server
     
    349352   \clearpage
    350353
    351 .. _rtems_cbs_attach_thread:
    352354.. index:: attach a thread to server
    353355.. index:: rtems_cbs_attach_thread
     356
     357.. _rtems_cbs_attach_thread:
    354358
    355359CBS_ATTACH_THREAD - Attach a thread to server
     
    391395   \clearpage
    392396
    393 .. _rtems_cbs_detach_thread:
    394397.. index:: detach a thread from server
    395398.. index:: rtems_cbs_detach_thread
     399
     400.. _rtems_cbs_detach_thread:
    396401
    397402CBS_DETACH_THREAD - Detach a thread from server
     
    428433   \clearpage
    429434
    430 .. _rtems_cbs_destroy_server:
    431435.. index:: destroy a bandwidth server
    432436.. index:: rtems_cbs_destroy_server
     437
     438.. _rtems_cbs_destroy_server:
    433439
    434440CBS_DESTROY_SERVER - Destroy a bandwidth server
     
    465471   \clearpage
    466472
    467 .. _rtems_cbs_get_server_id:
    468473.. index:: get an ID of a server
    469474.. index:: rtems_cbs_get_server_id
     475
     476.. _rtems_cbs_get_server_id:
    470477
    471478CBS_GET_SERVER_ID - Get an ID of a server
     
    496503   \clearpage
    497504
    498 .. _rtems_cbs_get_parameters:
    499505.. index:: get scheduling parameters of a server
    500506.. index:: rtems_cbs_get_parameters
     507
     508.. _rtems_cbs_get_parameters:
    501509
    502510CBS_GET_PARAMETERS - Get scheduling parameters of a server
     
    533541   \clearpage
    534542
    535 .. _rtems_cbs_set_parameters:
    536543.. index:: set scheduling parameters
    537544.. index:: rtems_cbs_set_parameters
     545
     546.. _rtems_cbs_set_parameters:
    538547
    539548CBS_SET_PARAMETERS - Set scheduling parameters
     
    572581   \clearpage
    573582
    574 .. _rtems_cbs_get_execution_time:
    575583.. index:: get elapsed execution time
    576584.. index:: rtems_cbs_get_execution_time
     585
     586.. _rtems_cbs_get_execution_time:
    577587
    578588CBS_GET_EXECUTION_TIME - Get elapsed execution time
     
    610620   \clearpage
    611621
    612 .. _rtems_cbs_get_remaining_budget:
    613622.. index:: get remaining execution time
    614623.. index:: rtems_cbs_get_remaining_budget
     624
     625.. _rtems_cbs_get_remaining_budget:
    615626
    616627CBS_GET_REMAINING_BUDGET - Get remaining execution time
     
    648659   \clearpage
    649660
    650 .. _rtems_cbs_get_approved_budget:
    651661.. index:: get scheduler approved execution time
    652662.. index:: rtems_cbs_get_approved_budget
     663
     664.. _rtems_cbs_get_approved_budget:
    653665
    654666CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time
  • c-user/cpu_usage_statistics.rst

    rac0eaff r3384994  
    111111   \clearpage
    112112
     113.. index:: rtems_cpu_usage_report
     114
    113115.. _rtems_cpu_usage_report:
    114 .. index:: rtems_cpu_usage_report
    115116
    116117cpu_usage_report - Report CPU Usage Statistics
     
    136137   \clearpage
    137138
     139.. index:: rtems_cpu_usage_reset
     140
    138141.. _rtems_cpu_usage_reset:
    139 .. index:: rtems_cpu_usage_reset
    140142
    141143cpu_usage_reset - Reset CPU Usage Statistics
  • c-user/directive_status_codes.rst

    rac0eaff r3384994  
    8585   \clearpage
    8686
     87.. index:: rtems_status_text
     88
    8789.. _rtems_status_text:
    88 .. index:: rtems_status_text
    8990
    9091STATUS_TEXT - Returns the enumeration name for a status code
  • c-user/dual_ports_memory_manager.rst

    rac0eaff r3384994  
    100100   \clearpage
    101101
    102 .. _rtems_port_create:
    103102.. index:: create a port
    104103.. index:: rtems_port_create
     104
     105.. _rtems_port_create:
    105106
    106107PORT_CREATE - Create a port
     
    153154   \clearpage
    154155
    155 .. _rtems_port_ident:
    156156.. index:: get ID of a port
    157157.. index:: obtain ID of a port
    158158.. index:: rtems_port_ident
     159
     160.. _rtems_port_ident:
    159161
    160162PORT_IDENT - Get ID of a port
     
    194196   \clearpage
    195197
    196 .. _rtems_port_delete:
    197198.. index:: delete a port
    198199.. index:: rtems_port_delete
     200
     201.. _rtems_port_delete:
    199202
    200203PORT_DELETE - Delete a port
     
    231234   \clearpage
    232235
    233 .. _rtems_port_external_to_internal:
    234236.. index:: convert external to internal address
    235237.. index:: rtems_port_external_to_internal
     238
     239.. _rtems_port_external_to_internal:
    236240
    237241PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address
     
    271275   \clearpage
    272276
    273 .. _rtems_port_internal_to_external:
    274277.. index:: convert internal to external address
    275278.. index:: rtems_port_internal_to_external
     279
     280.. _rtems_port_internal_to_external:
    276281
    277282PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address
  • c-user/event_manager.rst

    rac0eaff r3384994  
    183183   \clearpage
    184184
    185 .. _rtems_event_send:
    186185.. index:: send event set to a task
    187186.. index:: rtems_event_send
     187
     188.. _rtems_event_send:
    188189
    189190EVENT_SEND - Send event set to a task
     
    234235   \clearpage
    235236
    236 .. _rtems_event_receive:
    237237.. index:: receive event condition
    238238.. index:: rtems_event_receive
     239
     240.. _rtems_event_receive:
    239241
    240242EVENT_RECEIVE - Receive event condition
  • c-user/fatal_error.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: fatal errors
     8
    79.. _fatal_error_manager:
    8 .. index:: fatal errors
    910
    1011Fatal Error Manager
     
    387388==========
    388389
     390.. index:: _Terminate
     391
    389392.. _Terminate:
    390 .. index:: _Terminate
    391393
    392394Announcing a Fatal Error
     
    442444   \clearpage
    443445
    444 .. _rtems_fatal:
    445446.. index:: announce fatal error
    446447.. index:: fatal error, announce
    447448.. index:: rtems_fatal
     449
     450.. _rtems_fatal:
    448451
    449452FATAL - Invoke the fatal error
     
    472475   \clearpage
    473476
    474 .. _rtems_shutdown_executive:
    475477.. index:: shutdown RTEMS
    476478.. index:: rtems_shutdown_executive
     479
     480.. _rtems_shutdown_executive:
    477481
    478482SHUTDOWN_EXECUTIVE - Shutdown RTEMS
     
    504508   \clearpage
    505509
    506 .. _rtems_exception_frame_print:
    507510.. index:: exception frame
    508511.. index:: rtems_exception_frame_print
     512
     513.. _rtems_exception_frame_print:
    509514
    510515EXCEPTION_FRAME_PRINT - Prints the exception frame
     
    528533   \clearpage
    529534
    530 .. _rtems_fatal_source_text:
    531535.. index:: fatal error
    532536.. index:: rtems_fatal_source_text
     537
     538.. _rtems_fatal_source_text:
    533539
    534540FATAL_SOURCE_TEXT - Returns a text for a fatal source
     
    553559   \clearpage
    554560
    555 .. _rtems_internal_error_text:
    556561.. index:: fatal error
    557562.. index:: rtems_internal_error_text
     563
     564.. _rtems_internal_error_text:
    558565
    559566INTERNAL_ERROR_TEXT - Returns a text for an internal error code
     
    578585   \clearpage
    579586
    580 .. _rtems_fatal_error_occurred:
    581587.. index:: announce fatal error
    582588.. index:: fatal error, announce
    583589.. index:: rtems_fatal_error_occurred
     590
     591.. _rtems_fatal_error_occurred:
    584592
    585593FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
  • c-user/initialization.rst

    rac0eaff r3384994  
    7272
    7373The Initialization Manager :c:func:`rtems_initialize_executive()` directives is
    74 called by the :c:ref:`boot_card()` routine which is invoked by the Board
     74called by the :c:func:`boot_card()` routine which is invoked by the Board
    7575Support Package once a basic C run-time environment is set up.  This consists
    7676of
     
    306306   \clearpage
    307307
    308 .. _rtems_initialize_executive:
    309308.. index:: initialize RTEMS
    310309.. index:: start multitasking
    311310.. index:: rtems_initialize_executive
    312311
     312.. _rtems_initialize_executive:
     313
    313314INITIALIZE_EXECUTIVE - Initialize RTEMS
    314315---------------------------------------
  • c-user/interrupt_manager.rst

    rac0eaff r3384994  
    269269   \clearpage
    270270
    271 .. _rtems_interrupt_catch:
    272271.. index:: establish an ISR
    273272.. index:: install an ISR
    274273.. index:: rtems_interrupt_catch
     274
     275.. _rtems_interrupt_catch:
    275276
    276277INTERRUPT_CATCH - Establish an ISR
     
    313314   \clearpage
    314315
    315 .. _rtems_interrupt_disable:
    316316.. index:: disable interrupts
    317317.. index:: rtems_interrupt_disable
     318
     319.. _rtems_interrupt_disable:
    318320
    319321INTERRUPT_DISABLE - Disable Interrupts
     
    351353   \clearpage
    352354
    353 .. _rtems_interrupt_enable:
    354355.. index:: enable interrupts
    355356.. index:: rtems_interrupt_enable
     357
     358.. _rtems_interrupt_enable:
    356359
    357360INTERRUPT_ENABLE - Enable Interrupts
     
    386389   \clearpage
    387390
    388 .. _rtems_interrupt_flash:
    389391.. index:: flash interrupts
    390392.. index:: rtems_interrupt_flash
     393
     394.. _rtems_interrupt_flash:
    391395
    392396INTERRUPT_FLASH - Flash Interrupts
     
    421425   \clearpage
    422426
    423 .. _rtems_interrupt_local_disable:
    424427.. index:: disable interrupts
    425428.. index:: rtems_interrupt_local_disable
     429
     430.. _rtems_interrupt_local_disable:
    426431
    427432INTERRUPT_LOCAL_DISABLE - Disable Interrupts on Current Processor
     
    458463   \clearpage
    459464
    460 .. _rtems_interrupt_local_enable:
    461465.. index:: enable interrupts
    462466.. index:: rtems_interrupt_local_enable
     467
     468.. _rtems_interrupt_local_enable:
    463469
    464470INTERRUPT_LOCAL_ENABLE - Enable Interrupts on Current Processor
     
    489495   \clearpage
    490496
     497.. index:: rtems_interrupt_lock_initialize
     498
    491499.. _rtems_interrupt_lock_initialize:
    492 .. index:: rtems_interrupt_lock_initialize
    493500
    494501INTERRUPT_LOCK_INITIALIZE - Initialize an ISR Lock
     
    517524   \clearpage
    518525
     526.. index:: rtems_interrupt_lock_acquire
     527
    519528.. _rtems_interrupt_lock_acquire:
    520 .. index:: rtems_interrupt_lock_acquire
    521529
    522530INTERRUPT_LOCK_ACQUIRE - Acquire an ISR Lock
     
    552560   \clearpage
    553561
     562.. index:: rtems_interrupt_lock_release
     563
    554564.. _rtems_interrupt_lock_release:
    555 .. index:: rtems_interrupt_lock_release
    556565
    557566INTERRUPT_LOCK_RELEASE - Release an ISR Lock
     
    584593   \clearpage
    585594
     595.. index:: rtems_interrupt_lock_acquire_isr
     596
    586597.. _rtems_interrupt_lock_acquire_isr:
    587 .. index:: rtems_interrupt_lock_acquire_isr
    588598
    589599INTERRUPT_LOCK_ACQUIRE_ISR - Acquire an ISR Lock from ISR
     
    622632   \clearpage
    623633
     634.. index:: rtems_interrupt_lock_release_isr
     635
    624636.. _rtems_interrupt_lock_release_isr:
    625 .. index:: rtems_interrupt_lock_release_isr
    626637
    627638INTERRUPT_LOCK_RELEASE_ISR - Release an ISR Lock from ISR
     
    654665   \clearpage
    655666
    656 .. _rtems_interrupt_is_in_progress:
    657667.. index:: is interrupt in progress
    658668.. index:: rtems_interrupt_is_in_progress
     669
     670.. _rtems_interrupt_is_in_progress:
    659671
    660672INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress
  • c-user/io_manager.rst

    rac0eaff r3384994  
    231231   \clearpage
    232232
    233 .. _rtems_io_register_driver:
    234233.. index:: register a device driver
    235234.. index:: rtems_io_register_driver
     235
     236.. _rtems_io_register_driver:
    236237
    237238IO_REGISTER_DRIVER - Register a device driver
     
    289290   \clearpage
    290291
    291 .. _rtems_io_unregister_driver:
    292292.. index:: unregister a device driver
    293293.. index:: rtems_io_unregister_driver
    294294
     295.. _rtems_io_unregister_driver:
     296
    295297IO_UNREGISTER_DRIVER - Unregister a device driver
    296298-------------------------------------------------
     
    322324   \clearpage
    323325
    324 .. _rtems_io_initialize:
    325326.. index:: initialize a device driver
    326327.. index:: rtems_io_initialize
     328
     329.. _rtems_io_initialize:
    327330
    328331IO_INITIALIZE - Initialize a device driver
     
    365368   \clearpage
    366369
    367 .. _rtems_io_register_name:
    368370.. index:: register device
    369371.. index:: rtems_io_register_name
     372
     373.. _rtems_io_register_name:
    370374
    371375IO_REGISTER_NAME - Register a device
     
    400404   \clearpage
    401405
    402 .. _rtems_io_lookup_name:
    403406.. index:: lookup device major and minor number
    404407.. index:: rtems_io_lookup_name
     408
     409.. _rtems_io_lookup_name:
    405410
    406411IO_LOOKUP_NAME - Lookup a device
     
    435440   \clearpage
    436441
    437 .. _rtems_io_open:
    438442.. index:: open a devive
    439443.. index:: rtems_io_open
     444
     445.. _rtems_io_open:
    440446
    441447IO_OPEN - Open a device
     
    473479   \clearpage
    474480
    475 .. _rtems_io_close:
    476481.. index:: close a device
    477482.. index:: rtems_io_close
     483
     484.. _rtems_io_close:
    478485
    479486IO_CLOSE - Close a device
     
    511518   \clearpage
    512519
    513 .. _rtems_io_read:
    514520.. index:: read from a device
    515521.. index:: rtems_io_read
     522
     523.. _rtems_io_read:
    516524
    517525IO_READ - Read from a device
     
    550558   \clearpage
    551559
    552 .. _rtems_io_write:
    553560.. index:: write to a device
    554561.. index:: rtems_io_write
     562
     563.. _rtems_io_write:
    555564
    556565IO_WRITE - Write to a device
     
    589598   \clearpage
    590599
    591 .. _rtems_io_control:
    592600.. index:: special device services
    593601.. index:: IO Control
    594602.. index:: rtems_io_control
     603
     604.. _rtems_io_control:
    595605
    596606IO_CONTROL - Special device services
  • c-user/key_concepts.rst

    rac0eaff r3384994  
    271271resource dependency graph.
    272272
     273.. index:: priority inversion
     274
    273275.. _PriorityInversion:
    274 .. index:: priority inversion
    275276
    276277Priority Inversion
     
    287288priority task is effectively prevented from executing by lower priority tasks.
    288289
    289 .. _PriorityCeiling:
    290290.. index:: priority ceiling protocol
    291291.. index:: immediate ceiling priority protocol
     292
     293.. _PriorityCeiling:
    292294
    293295Immediate Ceiling Priority Protocol (ICPP)
     
    313315information.
    314316
     317.. index:: priority inheritance protocol
     318
    315319.. _PriorityInheritance:
    316 .. index:: priority inheritance protocol
    317320
    318321Priority Inheritance Protocol
     
    324327take place immediately and are propagated recursively.
    325328
     329.. index:: Multiprocessor Resource Sharing Protocol (MrsP)
     330
    326331.. _MrsP:
    327 .. index:: Multiprocessor Resource Sharing Protocol (MrsP)
    328332
    329333Multiprocessor Resource Sharing Protocol (MrsP)
     
    345349:cite:`Catellani:2015:MrsP`.
    346350
     351.. index:: O(m) Independence-Preserving Protocol (OMIP)
     352
    347353.. _OMIP:
    348 .. index:: O(m) Independence-Preserving Protocol (OMIP)
    349354
    350355O(m) Independence-Preserving Protocol (OMIP)
  • c-user/linker_sets.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: linkersets
     8
    79.. _linker_sets:
    8 .. index:: linkersets
    910
    1011Linker Sets
     
    127128   \clearpage
    128129
     130.. index:: RTEMS_LINKER_SET_BEGIN
     131
    129132.. _RTEMS_LINKER_SET_BEGIN:
    130 .. index:: RTEMS_LINKER_SET_BEGIN
    131133
    132134RTEMS_LINKER_SET_BEGIN - Designator of the linker set begin marker
     
    160162   \clearpage
    161163
     164.. index:: RTEMS_LINKER_SET_END
     165
    162166.. _RTEMS_LINKER_SET_END:
    163 .. index:: RTEMS_LINKER_SET_END
    164167
    165168RTEMS_LINKER_SET_END - Designator of the linker set end marker
     
    182185   \clearpage
    183186
     187.. index:: RTEMS_LINKER_SET_SIZE
     188
    184189.. _RTEMS_LINKER_SET_SIZE:
    185 .. index:: RTEMS_LINKER_SET_SIZE
    186190
    187191RTEMS_LINKER_SET_SIZE - The linker set size in characters
     
    203207   \clearpage
    204208
     209.. index:: RTEMS_LINKER_SET_ITEM_COUNT
     210
    205211.. _RTEMS_LINKER_SET_ITEM_COUNT:
    206 .. index:: RTEMS_LINKER_SET_ITEM_COUNT
    207212
    208213RTEMS_LINKER_SET_ITEM_COUNT - The linker set item count
     
    223228   \clearpage
    224229
     230.. index:: RTEMS_LINKER_SET_IS_EMPTY
     231
    225232.. _RTEMS_LINKER_SET_IS_EMPTY:
    226 .. index:: RTEMS_LINKER_SET_IS_EMPTY
    227233
    228234RTEMS_LINKER_SET_IS_EMPTY - Is the linker set empty?
     
    244250   \clearpage
    245251
     252.. index:: RTEMS_LINKER_SET_FOREACH
     253
    246254.. _RTEMS_LINKER_SET_FOREACH:
    247 .. index:: RTEMS_LINKER_SET_FOREACH
    248255
    249256RTEMS_LINKER_SET_FOREACH - Iterate through the linker set items
     
    280287   \clearpage
    281288
     289.. index:: RTEMS_LINKER_ROSET_DECLARE
     290
    282291.. _RTEMS_LINKER_ROSET_DECLARE:
    283 .. index:: RTEMS_LINKER_ROSET_DECLARE
    284292
    285293RTEMS_LINKER_ROSET_DECLARE - Declares a read-only linker set
     
    303311   \clearpage
    304312
     313.. index:: RTEMS_LINKER_ROSET
     314
    305315.. _RTEMS_LINKER_ROSET:
    306 .. index:: RTEMS_LINKER_ROSET
    307316
    308317RTEMS_LINKER_ROSET - Defines a read-only linker set
     
    326335   \clearpage
    327336
     337.. index:: RTEMS_LINKER_ROSET_ITEM_DECLARE
     338
    328339.. _RTEMS_LINKER_ROSET_ITEM_DECLARE:
    329 .. index:: RTEMS_LINKER_ROSET_ITEM_DECLARE
    330340
    331341RTEMS_LINKER_ROSET_ITEM_DECLARE - Declares a read-only linker set item
     
    351361   \clearpage
    352362
     363.. index:: RTEMS_LINKER_ROSET_ITEM_REFERENCE
     364
    353365.. _RTEMS_LINKER_ROSET_ITEM_REFERENCE:
    354 .. index:: RTEMS_LINKER_ROSET_ITEM_REFERENCE
    355366
    356367RTEMS_LINKER_ROSET_ITEM_REFERENCE - References a read-only linker set item
     
    376387   \clearpage
    377388
     389.. index:: RTEMS_LINKER_ROSET_ITEM
     390
    378391.. _RTEMS_LINKER_ROSET_ITEM:
    379 .. index:: RTEMS_LINKER_ROSET_ITEM
    380392
    381393RTEMS_LINKER_ROSET_ITEM - Defines a read-only linker set item
     
    401413   \clearpage
    402414
     415.. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED
     416
    403417.. _RTEMS_LINKER_ROSET_ITEM_ORDERED:
    404 .. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED
    405418
    406419RTEMS_LINKER_ROSET_ITEM_ORDERED - Defines an ordered read-only linker set item
     
    458471   \clearpage
    459472
     473.. index:: RTEMS_LINKER_ROSET_CONTENT
     474
    460475.. _RTEMS_LINKER_ROSET_CONTENT:
    461 .. index:: RTEMS_LINKER_ROSET_CONTENT
    462476
    463477RTEMS_LINKER_ROSET_CONTENT - Marks a declaration as a read-only linker set content
     
    480494   \clearpage
    481495
     496.. index:: RTEMS_LINKER_RWSET_DECLARE
     497
    482498.. _RTEMS_LINKER_RWSET_DECLARE:
    483 .. index:: RTEMS_LINKER_RWSET_DECLARE
    484499
    485500RTEMS_LINKER_RWSET_DECLARE - Declares a read-write linker set
     
    503518   \clearpage
    504519
     520.. index:: RTEMS_LINKER_RWSET
     521
    505522.. _RTEMS_LINKER_RWSET:
    506 .. index:: RTEMS_LINKER_RWSET
    507523
    508524RTEMS_LINKER_RWSET - Defines a read-write linker set
     
    526542   \clearpage
    527543
     544.. index:: RTEMS_LINKER_RWSET_ITEM_DECLARE
     545
    528546.. _RTEMS_LINKER_RWSET_ITEM_DECLARE:
    529 .. index:: RTEMS_LINKER_RWSET_ITEM_DECLARE
    530547
    531548RTEMS_LINKER_RWSET_ITEM_DECLARE - Declares a read-write linker set item
     
    551568   \clearpage
    552569
     570.. index:: RTEMS_LINKER_RWSET_ITEM_REFERENCE
     571
    553572.. _RTEMS_LINKER_RWSET_ITEM_REFERENCE:
    554 .. index:: RTEMS_LINKER_RWSET_ITEM_REFERENCE
    555573
    556574RTEMS_LINKER_RWSET_ITEM_REFERENCE - References a read-write linker set item
     
    576594   \clearpage
    577595
     596.. index:: RTEMS_LINKER_RWSET_ITEM
     597
    578598.. _RTEMS_LINKER_RWSET_ITEM:
    579 .. index:: RTEMS_LINKER_RWSET_ITEM
    580599
    581600RTEMS_LINKER_RWSET_ITEM - Defines a read-write linker set item
     
    601620   \clearpage
    602621
     622.. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED
     623
    603624.. _RTEMS_LINKER_RWSET_ITEM_ORDERED:
    604 .. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED
    605625
    606626RTEMS_LINKER_RWSET_ITEM_ORDERED - Defines an ordered read-write linker set item
     
    658678   \clearpage
    659679
     680.. index:: RTEMS_LINKER_RWSET_CONTENT
     681
    660682.. _RTEMS_LINKER_RWSET_CONTENT:
    661 .. index:: RTEMS_LINKER_RWSET_CONTENT
    662683
    663684RTEMS_LINKER_RWSET_CONTENT - Marks a declaration as a read-write linker set content
  • c-user/message_manager.rst

    rac0eaff r3384994  
    221221   \clearpage
    222222
    223 .. _rtems_message_queue_create:
    224223.. index:: create a message queue
    225224.. index:: rtems_message_queue_create
     225
     226.. _rtems_message_queue_create:
    226227
    227228MESSAGE_QUEUE_CREATE - Create a queue
     
    308309   \clearpage
    309310
    310 .. _rtems_message_queue_ident:
    311311.. index:: get ID of a message queue
    312312.. index:: rtems_message_queue_ident
     313
     314.. _rtems_message_queue_ident:
    313315
    314316MESSAGE_QUEUE_IDENT - Get ID of a queue
     
    361363   \clearpage
    362364
    363 .. _rtems_message_queue_delete:
    364365.. index:: delete a message queue
    365366.. index:: rtems_message_queue_delete
     367
     368.. _rtems_message_queue_delete:
    366369
    367370MESSAGE_QUEUE_DELETE - Delete a queue
     
    419422   \clearpage
    420423
    421 .. _rtems_message_queue_send:
    422424.. index:: send message to a queue
    423425.. index:: rtems_message_queue_send
     426
     427.. _rtems_message_queue_send:
    424428
    425429MESSAGE_QUEUE_SEND - Put message at rear of a queue
     
    476480   \clearpage
    477481
    478 .. _rtems_message_queue_urgent:
    479482.. index:: put message at front of queue
    480483.. index:: rtems_message_queue_urgent
     484
     485.. _rtems_message_queue_urgent:
    481486
    482487MESSAGE_QUEUE_URGENT - Put message at front of a queue
     
    533538   \clearpage
    534539
    535 .. _rtems_message_queue_broadcast:
    536540.. index:: broadcast message to a queue
    537541.. index:: rtems_message_queue_broadcast
     542
     543.. _rtems_message_queue_broadcast:
    538544
    539545MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue
     
    593599   \clearpage
    594600
    595 .. _rtems_message_queue_receive:
    596601.. index:: receive message from a queue
    597602.. index:: rtems_message_queue_receive
     603
     604.. _rtems_message_queue_receive:
    598605
    599606MESSAGE_QUEUE_RECEIVE - Receive message from a queue
     
    680687   \clearpage
    681688
    682 .. _rtems_message_queue_get_number_pending:
    683689.. index:: get number of pending messages
    684690.. index:: rtems_message_queue_get_number_pending
     691
     692.. _rtems_message_queue_get_number_pending:
    685693
    686694MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
     
    719727   \clearpage
    720728
    721 .. _rtems_message_queue_flush:
    722729.. index:: flush messages on a queue
    723730.. index:: rtems_message_queue_flush
     731
     732.. _rtems_message_queue_flush:
    724733
    725734MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
  • c-user/multiprocessing.rst

    rac0eaff r3384994  
    482482   \clearpage
    483483
    484 .. _rtems_multiprocessing_announce:
    485484.. index:: announce arrival of package
    486485.. index:: rtems_multiprocessing_announce
     486
     487.. _rtems_multiprocessing_announce:
    487488
    488489MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
  • c-user/object_services.rst

    rac0eaff r3384994  
    181181   \clearpage
    182182
    183 .. _rtems_build_name:
    184183.. index:: build object name
    185184.. index:: rtems_build_name
     185
     186.. _rtems_build_name:
    186187
    187188BUILD_NAME - Build object name from characters
     
    213214   \clearpage
    214215
    215 .. _rtems_object_get_classic_name:
    216216.. index:: get name from id
    217217.. index:: obtain name from id
    218218.. index:: rtems_object_get_classic_name
     219
     220.. _rtems_object_get_classic_name:
    219221
    220222OBJECT_GET_CLASSIC_NAME - Lookup name from id
     
    251253   \clearpage
    252254
    253 .. _rtems_object_get_name:
    254255.. index:: get object name as string
    255256.. index:: obtain object name as string
    256257.. index:: rtems_object_get_name
     258
     259.. _rtems_object_get_name:
    257260
    258261OBJECT_GET_NAME - Obtain object name as string
     
    284287   \clearpage
    285288
    286 .. _rtems_object_set_name:
    287289.. index:: set object name
    288290.. index:: rtems_object_set_name
     291
     292.. _rtems_object_set_name:
    289293
    290294OBJECT_SET_NAME - Set object name
     
    331335   \clearpage
    332336
    333 .. _rtems_object_id_get_api:
    334337.. index:: obtain API from id
    335338.. index:: rtems_object_id_get_api
    336339
     340.. _rtems_object_id_get_api:
     341
    337342OBJECT_ID_GET_API - Obtain API from Id
    338343--------------------------------------
     
    360365   \clearpage
    361366
    362 .. _rtems_object_id_get_class:
    363367.. index:: obtain class from object id
    364368.. index:: rtems_object_id_get_class
    365369
     370.. _rtems_object_id_get_class:
     371
    366372OBJECT_ID_GET_CLASS - Obtain Class from Id
    367373------------------------------------------
     
    389395   \clearpage
    390396
    391 .. _rtems_object_id_get_node:
    392397.. index:: obtain node from object id
    393398.. index:: rtems_object_id_get_node
    394399
     400.. _rtems_object_id_get_node:
     401
    395402OBJECT_ID_GET_NODE - Obtain Node from Id
    396403----------------------------------------
     
    418425   \clearpage
    419426
    420 .. _rtems_object_id_get_index:
    421427.. index:: obtain index from object id
    422428.. index:: rtems_object_id_get_index
    423429
     430.. _rtems_object_id_get_index:
     431
    424432OBJECT_ID_GET_INDEX - Obtain Index from Id
    425433------------------------------------------
     
    447455   \clearpage
    448456
    449 .. _rtems_build_id:
    450457.. index:: build object id from components
    451458.. index:: rtems_build_id
     459
     460.. _rtems_build_id:
    452461
    453462BUILD_ID - Build Object Id From Components
     
    481490   \clearpage
    482491
    483 .. _rtems_object_id_api_minimum:
    484492.. index:: obtain minimum API value
    485493.. index:: rtems_object_id_api_minimum
    486494
     495.. _rtems_object_id_api_minimum:
     496
    487497OBJECT_ID_API_MINIMUM - Obtain Minimum API Value
    488498------------------------------------------------
     
    506516   \clearpage
    507517
    508 .. _rtems_object_id_api_maximum:
    509518.. index:: obtain maximum API value
    510519.. index:: rtems_object_id_api_maximum
    511520
     521.. _rtems_object_id_api_maximum:
     522
    512523OBJECT_ID_API_MAXIMUM - Obtain Maximum API Value
    513524------------------------------------------------
     
    531542   \clearpage
    532543
    533 .. _rtems_object_api_minimum_class:
    534544.. index:: obtain minimum class value
    535545.. index:: rtems_object_api_minimum_class
    536546
     547.. _rtems_object_api_minimum_class:
     548
    537549OBJECT_API_MINIMUM_CLASS - Obtain Minimum Class Value
    538550-----------------------------------------------------
     
    562574   \clearpage
    563575
    564 .. _rtems_object_api_maximum_class:
    565576.. index:: obtain maximum class value
    566577.. index:: rtems_object_api_maximum_class
    567578
     579.. _rtems_object_api_maximum_class:
     580
    568581OBJECT_API_MAXIMUM_CLASS - Obtain Maximum Class Value
    569582-----------------------------------------------------
     
    593606   \clearpage
    594607
    595 .. _rtems_object_id_api_minimum_class:
    596608.. index:: obtain minimum class value for an API
    597609.. index:: rtems_object_id_api_minimum_class
    598610
     611.. _rtems_object_id_api_minimum_class:
     612
    599613OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API
    600614-------------------------------------------------------------------
     
    624638   \clearpage
    625639
    626 .. _rtems_object_id_api_maximum_class:
    627640.. index:: obtain maximum class value for an API
    628641.. index:: rtems_object_id_api_maximum_class
    629642
     643.. _rtems_object_id_api_maximum_class:
     644
    630645OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API
    631646-------------------------------------------------------------------
     
    655670   \clearpage
    656671
    657 .. _rtems_object_get_api_name:
    658672.. index:: obtain API name
    659673.. index:: rtems_object_get_api_name
    660674
     675.. _rtems_object_get_api_name:
     676
    661677OBJECT_GET_API_NAME - Obtain API Name
    662678-------------------------------------
     
    687703   \clearpage
    688704
    689 .. _rtems_object_get_api_class_name:
    690705.. index:: obtain class name
    691706.. index:: rtems_object_get_api_class_name
     707
     708.. _rtems_object_get_api_class_name:
    692709
    693710OBJECT_GET_API_CLASS_NAME - Obtain Class Name
     
    723740   \clearpage
    724741
    725 .. _rtems_object_get_class_information:
    726742.. index:: obtain class information
    727743.. index:: rtems_object_get_class_information
     744
     745.. _rtems_object_get_class_information:
    728746
    729747OBJECT_GET_CLASS_INFORMATION - Obtain Class Information
  • c-user/partition_manager.rst

    rac0eaff r3384994  
    136136   \clearpage
    137137
    138 .. _rtems_partition_create:
    139138.. index:: create a partition
    140139.. index:: rtems_partition_create
     140
     141.. _rtems_partition_create:
    141142
    142143PARTITION_CREATE - Create a partition
     
    230231   \clearpage
    231232
    232 .. _rtems_partition_ident:
    233233.. index:: get ID of a partition
    234234.. index:: obtain ID of a partition
    235235.. index:: rtems_partition_ident
     236
     237.. _rtems_partition_ident:
    236238
    237239PARTITION_IDENT - Get ID of a partition
     
    284286   \clearpage
    285287
    286 .. _rtems_partition_delete:
    287288.. index:: delete a partition
    288289.. index:: rtems_partition_delete
     290
     291.. _rtems_partition_delete:
    289292
    290293PARTITION_DELETE - Delete a partition
     
    333336   \clearpage
    334337
    335 .. _rtems_partition_get_buffer:
    336338.. index:: get buffer from partition
    337339.. index:: obtain buffer from partition
    338340.. index:: rtems_partition_get_buffer
     341
     342.. _rtems_partition_get_buffer:
    339343
    340344PARTITION_GET_BUFFER - Get buffer from a partition
     
    381385   \clearpage
    382386
    383 .. _rtems_partition_return_buffer:
    384387.. index:: return buffer to partitition
    385388.. index:: rtems_partition_return_buffer
     389
     390.. _rtems_partition_return_buffer:
    386391
    387392PARTITION_RETURN_BUFFER - Return buffer to a partition
  • c-user/rate_monotonic_manager.rst

    rac0eaff r3384994  
    635635   \clearpage
    636636
    637 .. _rtems_rate_monotonic_create:
    638637.. index:: create a period
    639638.. index:: rtems_rate_monotonic_create
     639
     640.. _rtems_rate_monotonic_create:
    640641
    641642RATE_MONOTONIC_CREATE - Create a rate monotonic period
     
    675676   \clearpage
    676677
    677 .. _rtems_rate_monotonic_ident:
    678678.. index:: get ID of a period
    679679.. index:: obtain ID of a period
    680680.. index:: rtems_rate_monotonic_ident
     681
     682.. _rtems_rate_monotonic_ident:
    681683
    682684RATE_MONOTONIC_IDENT - Get ID of a period
     
    714716   \clearpage
    715717
    716 .. _rtems_rate_monotonic_cancel:
    717718.. index:: cancel a period
    718719.. index:: rtems_rate_monotonic_cancel
     720
     721.. _rtems_rate_monotonic_cancel:
    719722
    720723RATE_MONOTONIC_CANCEL - Cancel a period
     
    755758   \clearpage
    756759
    757 .. _rtems_rate_monotonic_delete:
    758760.. index:: rtems_rate_monotonic_delete
    759761.. index:: delete a period
     762
     763.. _rtems_rate_monotonic_delete:
    760764
    761765RATE_MONOTONIC_DELETE - Delete a rate monotonic period
     
    794798   \clearpage
    795799
    796 .. _rtems_rate_monotonic_period:
    797800.. index:: conclude current period
    798801.. index:: start current period
    799802.. index:: period initiation
    800803.. index:: rtems_rate_monotonic_period
     804
     805.. _rtems_rate_monotonic_period:
    801806
    802807RATE_MONOTONIC_PERIOD - Conclude current/Start next period
     
    848853   \clearpage
    849854
    850 .. _rtems_rate_monotonic_get_status:
    851855.. index:: get status of period
    852856.. index:: obtain status of period
    853857.. index:: rtems_rate_monotonic_get_status
     858
     859.. _rtems_rate_monotonic_get_status:
    854860
    855861RATE_MONOTONIC_GET_STATUS - Obtain status from a period
     
    899905    time information since the last invocation of the
    900906    ``rtems_rate_monotonic_period`` directive.  More specifically, the
    901     since_last_period value contains the elapsed time which has occurred
    902     since the last invocation of the ``rtems_rate_monotonic_period`` directive
    903     and the ``executed_since_last_period`` contains how much processor
    904     time the owning task has consumed since the invocation of the
     907    since_last_period value contains the elapsed time which has occurred since
     908    the last invocation of the ``rtems_rate_monotonic_period`` directive and
     909    the ``executed_since_last_period`` contains how much processor time the
     910    owning task has consumed since the invocation of the
    905911    ``rtems_rate_monotonic_period`` directive. In addition, the
    906     postponed_jobs_count value contains the count of jobs which are not released yet.
     912    ``postponed_jobs_count value`` contains the count of jobs which are not
     913    released yet.
    907914
    908915NOTES:
     
    913920   \clearpage
    914921
    915 .. _rtems_rate_monotonic_get_statistics:
    916922.. index:: get statistics of period
    917923.. index:: obtain statistics of period
    918924.. index:: rtems_rate_monotonic_get_statistics
     925
     926.. _rtems_rate_monotonic_get_statistics:
    919927
    920928RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
     
    982990   \clearpage
    983991
    984 .. _rtems_rate_monotonic_reset_statistics:
    985992.. index:: reset statistics of period
    986993.. index:: rtems_rate_monotonic_reset_statistics
     994
     995.. _rtems_rate_monotonic_reset_statistics:
    987996
    988997RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period
     
    10161025   \clearpage
    10171026
    1018 .. _rtems_rate_monotonic_reset_all_statistics:
    10191027.. index:: reset statistics of all periods
    10201028.. index:: rtems_rate_monotonic_reset_all_statistics
     1029
     1030.. _rtems_rate_monotonic_reset_all_statistics:
    10211031
    10221032RATE_MONOTONIC_RESET_ALL_STATISTICS - Reset statistics for all periods
     
    10421052   \clearpage
    10431053
    1044 .. _rtems_rate_monotonic_report_statistics:
    10451054.. index:: print period statistics report
    10461055.. index:: period statistics report
    10471056.. index:: rtems_rate_monotonic_report_statistics
     1057
     1058.. _rtems_rate_monotonic_report_statistics:
    10481059
    10491060RATE_MONOTONIC_REPORT_STATISTICS - Print period statistics report
  • c-user/region_manager.rst

    rac0eaff r3384994  
    225225   \clearpage
    226226
     227.. index:: create a region
     228
    227229.. _rtems_region_create:
    228 .. index:: create a region
    229230
    230231REGION_CREATE - Create a region
     
    301302   \clearpage
    302303
    303 .. _rtems_region_ident:
    304304.. index:: get ID of a region
    305305.. index:: obtain ID of a region
    306306.. index:: rtems_region_ident
     307
     308.. _rtems_region_ident:
    307309
    308310REGION_IDENT - Get ID of a region
     
    343345   \clearpage
    344346
    345 .. _rtems_region_delete:
    346347.. index:: delete a region
    347348.. index:: rtems_region_delete
     349
     350.. _rtems_region_delete:
    348351
    349352REGION_DELETE - Delete a region
     
    384387   \clearpage
    385388
    386 .. _rtems_region_extend:
    387389.. index:: add memory to a region
    388390.. index:: region, add memory
    389391.. index:: rtems_region_extend
     392
     393.. _rtems_region_extend:
    390394
    391395REGION_EXTEND - Add memory to a region
     
    437441   \clearpage
    438442
    439 .. _rtems_region_get_segment:
    440443.. index:: get segment from region
    441444.. index:: rtems_region_get_segment
     445
     446.. _rtems_region_get_segment:
    442447
    443448REGION_GET_SEGMENT - Get segment from a region
     
    523528   \clearpage
    524529
    525 .. _rtems_region_return_segment:
    526530.. index:: return segment to region
    527531.. index:: rtems_region_return_segment
     532
     533.. _rtems_region_return_segment:
    528534
    529535REGION_RETURN_SEGMENT - Return segment to a region
     
    572578   \clearpage
    573579
    574 .. _rtems_region_get_segment_size:
    575580.. index:: get size of segment
    576581.. index:: rtems_region_get_segment_size
     582
     583.. _rtems_region_get_segment_size:
    577584
    578585REGION_GET_SEGMENT_SIZE - Obtain size of a segment
     
    614621   \clearpage
    615622
    616 .. _rtems_region_resize_segment:
    617623.. index:: resize segment
    618624.. index:: rtems_region_resize_segment
     625
     626.. _rtems_region_resize_segment:
    619627
    620628REGION_RESIZE_SEGMENT - Change size of a segment
  • c-user/semaphore_manager.rst

    rac0eaff r3384994  
    325325   \clearpage
    326326
    327 .. _rtems_semaphore_create:
    328327.. index:: create a semaphore
    329328.. index:: rtems_semaphore_create
     329
     330.. _rtems_semaphore_create:
    330331
    331332SEMAPHORE_CREATE - Create a semaphore
     
    437438   \clearpage
    438439
    439 .. _rtems_semaphore_ident:
    440440.. index:: get ID of a semaphore
    441441.. index:: obtain ID of a semaphore
    442442.. index:: rtems_semaphore_ident
     443
     444.. _rtems_semaphore_ident:
    443445
    444446SEMAPHORE_IDENT - Get ID of a semaphore
     
    489491   \clearpage
    490492
    491 .. _rtems_semaphore_delete:
    492493.. index:: delete a semaphore
    493494.. index:: rtems_semaphore_delete
     495
     496.. _rtems_semaphore_delete:
    494497
    495498SEMAPHORE_DELETE - Delete a semaphore
     
    545548   \clearpage
    546549
    547 .. _rtems_semaphore_obtain:
    548550.. index:: obtain a semaphore
    549551.. index:: lock a semaphore
    550552.. index:: rtems_semaphore_obtain
     553
     554.. _rtems_semaphore_obtain:
    551555
    552556SEMAPHORE_OBTAIN - Acquire a semaphore
     
    644648   \clearpage
    645649
    646 .. _rtems_semaphore_release:
    647650.. index:: release a semaphore
    648651.. index:: unlock a semaphore
    649652.. index:: rtems_semaphore_release
     653
     654.. _rtems_semaphore_release:
    650655
    651656SEMAPHORE_RELEASE - Release a semaphore
     
    705710   \clearpage
    706711
    707 .. _rtems_semaphore_flush:
    708712.. index:: flush a semaphore
    709713.. index:: unblock all tasks waiting on a semaphore
    710714.. index:: rtems_semaphore_flush
     715
     716.. _rtems_semaphore_flush:
    711717
    712718SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
     
    761767   \clearpage
    762768
    763 .. _rtems_semaphore_set_priority:
    764769.. index:: set priority by scheduler for a semaphore
    765770.. index:: rtems_semaphore_set_priority
     771
     772.. _rtems_semaphore_set_priority:
    766773
    767774SEMAPHORE_SET_PRIORITY - Set priority by scheduler for a semaphore
  • c-user/signal_manager.rst

    rac0eaff r3384994  
    212212   \clearpage
    213213
    214 .. _rtems_signal_catch:
    215214.. index:: establish an ASR
    216215.. index:: install an ASR
    217216.. index:: rtems_signal_catch
     217
     218.. _rtems_signal_catch:
    218219
    219220SIGNAL_CATCH - Establish an ASR
     
    273274   \clearpage
    274275
    275 .. _rtems_signal_send:
    276276.. index:: send signal set
    277277.. index:: rtems_signal_send
     278
     279.. _rtems_signal_send:
    278280
    279281SIGNAL_SEND - Send signal set to a task
  • c-user/symmetric_multiprocessing_services.rst

    rac0eaff r3384994  
    328328executing thread and restored from the thread control block of the heir thread.
    329329This is inherently broken if more than one executing thread exists.
    330 Alternatives to task variables are POSIX keys and :ref:`TLS <TLS>`.  All use
    331 cases of task variables in the RTEMS code base were replaced with alternatives.
    332 The task variable API has been removed in RTEMS 5.1.
     330Alternatives to task variables are POSIX keys and :term:`TLS`.  All use cases
     331of task variables in the RTEMS code base were replaced with alternatives.  The
     332task variable API has been removed in RTEMS 5.1.
    333333
    334334Highest Priority Thread Never Walks Alone
  • c-user/task_manager.rst

    rac0eaff r3384994  
    599599   \clearpage
    600600
    601 .. _rtems_task_create:
    602601.. index:: create a task
    603602.. index:: rtems_task_create
     603
     604.. _rtems_task_create:
    604605
    605606TASK_CREATE - Create a task
     
    744745   \clearpage
    745746
    746 .. _rtems_task_ident:
    747747.. index:: get ID of a task
    748748.. index:: rtems_task_ident
     749
     750.. _rtems_task_ident:
    749751
    750752TASK_IDENT - Get ID of a task
     
    798800   \clearpage
    799801
    800 .. _rtems_task_self:
    801802.. index:: obtain ID of caller
    802803.. index:: rtems_task_self
    803804
     805.. _rtems_task_self:
     806
    804807TASK_SELF - Obtain ID of caller
    805808-------------------------------
     
    824827   \clearpage
    825828
    826 .. _rtems_task_start:
    827829.. index:: starting a task
    828830.. index:: rtems_task_start
     831
     832.. _rtems_task_start:
    829833
    830834TASK_START - Start a task
     
    878882   \clearpage
    879883
    880 .. _rtems_task_restart:
    881884.. index:: restarting a task
    882885.. index:: rtems_task_restart
     886
     887.. _rtems_task_restart:
    883888
    884889TASK_RESTART - Restart a task
     
    940945   \clearpage
    941946
    942 .. _rtems_task_delete:
    943947.. index:: deleting a task
    944948.. index:: rtems_task_delete
     949
     950.. _rtems_task_delete:
    945951
    946952TASK_DELETE - Delete a task
     
    9961002   \clearpage
    9971003
    998 .. _rtems_task_suspend:
    9991004.. index:: suspending a task
    10001005.. index:: rtems_task_suspend
     1006
     1007.. _rtems_task_suspend:
    10011008
    10021009TASK_SUSPEND - Suspend a task
     
    10431050   \clearpage
    10441051
    1045 .. _rtems_task_resume:
    10461052.. index:: resuming a task
    10471053.. index:: rtems_task_resume
     1054
     1055.. _rtems_task_resume:
    10481056
    10491057TASK_RESUME - Resume a task
     
    10881096   \clearpage
    10891097
    1090 .. _rtems_task_is_suspended:
    10911098.. index:: is task suspended
    10921099.. index:: rtems_task_is_suspended
     1100
     1101.. _rtems_task_is_suspended:
    10931102
    10941103TASK_IS_SUSPENDED - Determine if a task is Suspended
     
    11261135   \clearpage
    11271136
    1128 .. _rtems_task_set_priority:
    11291137.. index:: rtems_task_set_priority
    11301138.. index:: current task priority
     
    11321140.. index:: get task priority
    11331141.. index:: obtain task priority
     1142
     1143.. _rtems_task_set_priority:
    11341144
    11351145TASK_SET_PRIORITY - Set task priority
     
    11901200   \clearpage
    11911201
    1192 .. _rtems_task_get_priority:
    11931202.. index:: rtems_task_get_priority
    11941203.. index:: current task priority
    11951204.. index:: get task priority
    11961205.. index:: obtain task priority
     1206
     1207.. _rtems_task_get_priority:
    11971208
    11981209TASK_GET_PRIORITY - Get task priority
     
    12391250   \clearpage
    12401251
    1241 .. _rtems_task_mode:
    12421252.. index:: current task mode
    12431253.. index:: set task mode
     
    12471257.. index:: obtain task mode
    12481258.. index:: rtems_task_mode
     1259
     1260.. _rtems_task_mode:
    12491261
    12501262TASK_MODE - Change the current task mode
     
    13181330   \clearpage
    13191331
    1320 .. _rtems_task_wake_after:
    13211332.. index:: delay a task for an interval
    13221333.. index:: wake up after an interval
    13231334.. index:: rtems_task_wake_after
    13241335
     1336.. _rtems_task_wake_after:
     1337
    13251338TASK_WAKE_AFTER - Wake up after interval
    13261339----------------------------------------
     
    13611374   \clearpage
    13621375
    1363 .. _rtems_task_wake_when:
    13641376.. index:: delay a task until a wall time
    13651377.. index:: wake up at a wall time
    13661378.. index:: rtems_task_wake_when
     1379
     1380.. _rtems_task_wake_when:
    13671381
    13681382TASK_WAKE_WHEN - Wake up when specified
     
    16171631   \clearpage
    16181632
    1619 .. _rtems_task_iterate:
    16201633.. index:: iterate over all threads
    16211634.. index:: rtems_task_iterate
     1635
     1636.. _rtems_task_iterate:
    16221637
    16231638TASK_ITERATE - Iterate Over Tasks
     
    16591674   \clearpage
    16601675
     1676.. index:: rtems_iterate_over_all_threads
     1677
    16611678.. _rtems_iterate_over_all_threads:
    1662 .. index:: rtems_iterate_over_all_threads
    16631679
    16641680ITERATE_OVER_ALL_THREADS - Iterate Over Tasks
     
    16981714   \clearpage
    16991715
    1700 .. _rtems_task_get_note:
    17011716.. index:: get task notepad entry
    17021717.. index:: rtems_task_get_note
     1718
     1719.. _rtems_task_get_note:
    17031720
    17041721TASK_GET_NOTE - Get task notepad entry
     
    17511768   \clearpage
    17521769
    1753 .. _rtems_task_set_note:
    17541770.. index:: set task notepad entry
    17551771.. index:: rtems_task_set_note
     1772
     1773.. _rtems_task_set_note:
    17561774
    17571775TASK_SET_NOTE - Set task notepad entry
     
    18031821   \clearpage
    18041822
    1805 .. _rtems_task_variable_add:
    18061823.. index:: per-task variable
    18071824.. index:: task private variable
    18081825.. index:: task private data
    18091826.. index:: rtems_task_variable_add
     1827
     1828.. _rtems_task_variable_add:
    18101829
    18111830TASK_VARIABLE_ADD - Associate per task variable
     
    18661885   \clearpage
    18671886
    1868 .. _rtems_task_variable_get:
    18691887.. index:: get per-task variable
    18701888.. index:: obtain per-task variable
    18711889.. index:: rtems_task_variable_get
     1890
     1891.. _rtems_task_variable_get:
    18721892
    18731893TASK_VARIABLE_GET - Obtain value of a per task variable
     
    19231943   \clearpage
    19241944
    1925 .. _rtems_task_variable_delete:
    19261945.. index:: per-task variable
    19271946.. index:: task private variable
    19281947.. index:: task private data
    19291948.. index:: rtems_task_variable_delete
     1949
     1950.. _rtems_task_variable_delete:
    19301951
    19311952TASK_VARIABLE_DELETE - Remove per task variable
  • c-user/timer_manager.rst

    rac0eaff r3384994  
    195195
    196196   \clearpage
    197 .. _rtems_timer_create:
    198197.. index:: create a timer
    199198.. index:: rtems_timer_create
     199
     200.. _rtems_timer_create:
    200201
    201202TIMER_CREATE - Create a timer
     
    241242   \clearpage
    242243
    243 .. _rtems_timer_ident:
    244244.. index:: obtain the ID of a timer
    245245.. index:: rtems_timer_ident
     246
     247.. _rtems_timer_ident:
    246248
    247249TIMER_IDENT - Get ID of a timer
     
    281283   \clearpage
    282284
    283 .. _rtems_timer_cancel:
    284285.. index:: cancel a timer
    285286.. index:: rtems_timer_cancel
     287
     288.. _rtems_timer_cancel:
    286289
    287290TIMER_CANCEL - Cancel a timer
     
    316319   \clearpage
    317320
    318 .. _rtems_timer_delete:
    319321.. index:: delete a timer
    320322.. index:: rtems_timer_delete
     323
     324.. _rtems_timer_delete:
    321325
    322326TIMER_DELETE - Delete a timer
     
    355359   \clearpage
    356360
    357 .. _rtems_timer_fire_after:
    358361.. index:: fire a timer after an interval
    359362.. index:: rtems_timer_fire_after
     363
     364.. _rtems_timer_fire_after:
    360365
    361366TIMER_FIRE_AFTER - Fire timer after interval
     
    399404   \clearpage
    400405
    401 .. _rtems_timer_fire_when:
    402406.. index:: fire a timer at wall time
    403407.. index:: rtems_timer_fire_when
     408
     409.. _rtems_timer_fire_when:
    404410
    405411TIMER_FIRE_WHEN - Fire timer when specified
     
    447453   \clearpage
    448454
    449 .. _rtems_timer_initiate_server:
    450455.. index:: initiate the Timer Server
    451456.. index:: rtems_timer_initiate_server
     457
     458.. _rtems_timer_initiate_server:
    452459
    453460TIMER_INITIATE_SERVER - Initiate server for task-based timers
     
    492499   \clearpage
    493500
    494 .. _rtems_timer_server_fire_after:
    495501.. index:: fire task-based a timer after an interval
    496502.. index:: rtems_timer_server_fire_after
     503
     504.. _rtems_timer_server_fire_after:
    497505
    498506TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
     
    540548   \clearpage
    541549
    542 .. _rtems_timer_server_fire_when:
    543550.. index:: fire a task-based timer at wall time
    544551.. index:: rtems_timer_server_fire_when
     552
     553.. _rtems_timer_server_fire_when:
    545554
    546555TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
     
    592601   \clearpage
    593602
    594 .. _rtems_timer_reset:
    595603.. index:: reset a timer
    596604.. index:: rtems_timer_reset
     605
     606.. _rtems_timer_reset:
    597607
    598608TIMER_RESET - Reset an interval timer
  • c-user/timespec_helpers.rst

    rac0eaff r3384994  
    126126   \clearpage
    127127
    128 .. _rtems_timespec_set:
    129128.. index:: set struct timespec instance
    130129.. index:: rtems_timespec_set
     130
     131.. _rtems_timespec_set:
    131132
    132133TIMESPEC_SET - Set struct timespec Instance
     
    157158   \clearpage
    158159
     160.. index:: rtems_timespec_zero
     161
    159162.. _rtems_timespec_zero:
    160 .. index:: rtems_timespec_zero
    161163
    162164TIMESPEC_ZERO - Zero struct timespec Instance
     
    184186   \clearpage
    185187
     188.. index:: rtems_timespec_is_valid
     189
    186190.. _rtems_timespec_is_valid:
    187 .. index:: rtems_timespec_is_valid
    188191
    189192TIMESPEC_IS_VALID - Check validity of a struct timespec instance
     
    213216   \clearpage
    214217
     218.. index:: rtems_timespec_add_to
     219
    215220.. _rtems_timespec_add_to:
    216 .. index:: rtems_timespec_add_to
    217221
    218222TIMESPEC_ADD_TO - Add Two struct timespec Instances
     
    242246   \clearpage
    243247
     248.. index:: rtems_timespec_subtract
     249
    244250.. _rtems_timespec_subtract:
    245 .. index:: rtems_timespec_subtract
    246251
    247252TIMESPEC_SUBTRACT - Subtract Two struct timespec Instances
     
    276281   \clearpage
    277282
     283.. index:: rtems_timespec_divide
     284
    278285.. _rtems_timespec_divide:
    279 .. index:: rtems_timespec_divide
    280286
    281287TIMESPEC_DIVIDE - Divide Two struct timespec Instances
     
    316322   \clearpage
    317323
     324.. index:: rtems_timespec_divide_by_integer
     325
    318326.. _rtems_timespec_divide_by_integer:
    319 .. index:: rtems_timespec_divide_by_integer
    320327
    321328TIMESPEC_DIVIDE_BY_INTEGER - Divide a struct timespec Instance by an Integer
     
    347354   \clearpage
    348355
     356.. index:: rtems_timespec_less_than
     357
    349358.. _rtems_timespec_less_than:
    350 .. index:: rtems_timespec_less_than
    351359
    352360TIMESPEC_LESS_THAN - Less than operator
     
    377385   \clearpage
    378386
     387.. index:: rtems_timespec_greater_than
     388
    379389.. _rtems_timespec_greater_than:
    380 .. index:: rtems_timespec_greater_than
    381390
    382391TIMESPEC_GREATER_THAN - Greater than operator
     
    405414   \clearpage
    406415
     416.. index:: rtems_timespec_equal_to
     417
    407418.. _rtems_timespec_equal_to:
    408 .. index:: rtems_timespec_equal_to
    409419
    410420TIMESPEC_EQUAL_TO - Check equality of timespecs
     
    433443   \clearpage
    434444
     445.. index:: rtems_timespec_get_seconds
     446
    435447.. _rtems_timespec_get_seconds:
    436 .. index:: rtems_timespec_get_seconds
    437448
    438449TIMESPEC_GET_SECONDS - Get Seconds Portion of struct timespec Instance
     
    461472   \clearpage
    462473
     474.. index:: rtems_timespec_get_nanoseconds
     475
    463476.. _rtems_timespec_get_nanoseconds:
    464 .. index:: rtems_timespec_get_nanoseconds
    465477
    466478TIMESPEC_GET_NANOSECONDS - Get Nanoseconds Portion of the struct timespec Instance
     
    489501   \clearpage
    490502
     503.. index:: rtems_timespec_to_ticks
     504
    491505.. _rtems_timespec_to_ticks:
    492 .. index:: rtems_timespec_to_ticks
    493506
    494507TIMESPEC_TO_TICKS - Convert struct timespec Instance to Ticks
     
    516529   \clearpage
    517530
     531.. index:: rtems_timespec_from_ticks
     532
    518533.. _rtems_timespec_from_ticks:
    519 .. index:: rtems_timespec_from_ticks
    520534
    521535TIMESPEC_FROM_TICKS - Convert Ticks to struct timespec Representation
  • c-user/user_extensions.rst

    rac0eaff r3384994  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: user extensions
     8
    79.. _User Extensions Manager:
    8 .. index:: user extensions
    910
    1011User Extensions Manager
     
    425426   \clearpage
    426427
    427 .. _rtems_extension_create:
    428428.. index:: create an extension set
    429429.. index:: rtems_extension_create
     430
     431.. _rtems_extension_create:
    430432
    431433EXTENSION_CREATE - Create a extension set
     
    473475   \clearpage
    474476
    475 .. _rtems_extension_ident:
    476477.. index:: get ID of an extension set
    477478.. index:: obtain ID of an extension set
    478479.. index:: rtems_extension_ident
     480
     481.. _rtems_extension_ident:
    479482
    480483EXTENSION_IDENT - Get ID of a extension set
     
    514517   \clearpage
    515518
    516 .. _rtems_extension_delete:
    517519.. index:: delete an extension set
    518520.. index:: rtems_extension_delete
     521
     522.. _rtems_extension_delete:
    519523
    520524EXTENSION_DELETE - Delete a extension set
  • user/installation/prefixes-sandboxing.rst

    rac0eaff r3384994  
    44.. comment: All rights reserved.
    55
     6.. index:: Prefixes
    67.. _prefixes:
    7 .. index:: Prefixes
    88
    99Prefixes
  • user/start/index.rst

    rac0eaff r3384994  
    33.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
    44.. comment: All rights reserved.
     5
     6.. index:: Quick Start
    57
    68Quick Start
     
    1921following the procedure in :ref:`microsoft-windows` first.
    2022
    21 Their are many ways and locations a suitable environment can be set up. A
     23There are many ways and locations a suitable environment can be set up. A
    2224common factor that defines the final location of tools and projects is the
    23 place you have suitable storage. :ref:`prefixes` and :ref:`project-sandboxing`
     25place you have suitable storage. :ref:`Prefixes` and :ref:`project-sandboxing`
    2426provide detailed examples of possible locations and set ups .
    2527
  • user/tools/index.rst

    rac0eaff r3384994  
    2020   symbols
    2121   exeinfo
    22    trace-linker
    2322   bsp-builder
    2423   tester
  • user/tools/tester.rst

    rac0eaff r3384994  
    44.. comment: All rights reserved.
    55
    6 RTEMS Tester
    7 ============
    8 
    9 .. index:: Tools, rtems-tester
    10 
    11 The RTEMS Tester is a test framework. It includes a command line interface to
    12 run tests on supported targets. The framework provides back-end support for
    13 common simulators and debuggers. The board support package (BSP) configurations
    14 for RTEMS are provided and can be used to run all the tests provided with
    15 RTEMS. The framework is not specific to RTEMS and can be configured to run any
    16 suitable application.
     6.. _rtems-tester-command:
     7
     8RTEMS Tester and Run Commands
     9=============================
     10
     11.. index:: Tools, rtems-test, rtems-run
     12
     13The RTEMS Tester is a test tool that provides a command line interface to run
     14test executable on supported targets. The tool provides back-end support for
     15common simulators, debuggers and boot loaders. Board support package (BSP)
     16configurations for RTEMS are provided and can be used to run all the tests in
     17the RTEMS test suite. The tool and it's framework is not specific to RTEMS and
     18can be configured to run any suitable application.
    1719
    1820RTEMS is an embedded operating system and is cross-compiled on a range of host
    1921machines. The executables run on the target hardware and this can vary widely
    2022from open source simulators, commercial simulators, debuggers with simulators,
    21 to debuggers with hardware specific pods and devices. Testing RTEMS requires
    22 the cross-compiled test executable is transferred to the target hardware,
    23 executed and the output returned to the host where it is analyzed to determine
    24 the test result. The RTEMS Tester provides a framework to do this.
    25 
    26 Running all the RTEMS tests on your target is very important. It provides you
    27 with a traceable record showing that your RTEMS version and its tools are
    28 working at the level the RTEMS development team expect when releasing
    29 RTEMS. Being able to easily run the tests and verify the results is critical in
    30 maintaining a high standard.
    31 
    32 This document is for users of the RTEMS Tester as well as those wanting to
    33 develop, extend and investigate the RTEMS Tester.
     23debuggers with hardware specific pods and devices to targe boot
     24loaders. Testing RTEMS requires the cross-compiled test executable is
     25transferred to the target hardware, executed and the output captured and
     26returned to the test host where it is analyzed to determine the test
     27result.
     28
     29Running the RTEMS tests on your target is very important. It provides you with
     30a traceable record showing that your RTEMS version and its tools are working at
     31the level the RTEMS development team expect when releasing RTEMS. Being able to
     32easily run the tests and verify the results is critical in maintaining a high
     33standard.
    3434
    3535Available BSP testers
     
    4343    arm920
    4444    beagleboardxm
     45    beagleboneblack
    4546    jmr3904-run
    4647    jmr3904
    4748    mcf5235
     49    pc
    4850    psim-run
    4951    psim
     
    5557    xilinx_zynq_zc706
    5658    xilinx_zynq_zc706_qemu
     59    xilinx_zynq_zedboard
    5760
    5861.. note:: The list is growing all the time and if your BSP is not supported we
     
    7174
    7275Build the RTEMS Kernel (See :ref:`rtems-kernel`) by cloning the repository,
    73 running the ``bootstrap`` procecure, building and finally installing the
     76running the ``bootstrap`` procedure, building and finally installing the
    7477kernel. Be sure to enable tests by using ``--enable-tests`` option with
    7578configure after running ``bootstrap``.
     
    8184    $ make
    8285
    83 Add the -j option to the make command with the number of cores to run the
    84 build parallel where it can.
     86Add the `-j` option to the make command with the number of cores to run a
     87parallel build.
    8588
    8689Building all the tests takes time and it uses more disk so be patient. When
    87 finished all the tests will be built and ready to run. Before running all the
    88 tests it is a good idea to run the ``hello`` test. The ``hello`` test is an
    89 RTEMS version of the classic "Hello World" example and running it shows you
    90 have a working tool chain and build of RTEMS ready to run the tests. Using the
    91 run command:
     90finished all the tests will have been built. Some BSPs may require a post-build
     91process to be run on the RTEMS ELF executable to create an image suitable for
     92execution. This can be built into the configuration script and the tester will
     93perform a pre-test command to covert the executable to a suitable format for
     94your target.
     95
     96Before running all the tests it is a good idea to run the ``hello`` test. The
     97``hello`` test is an RTEMS version of the classic "Hello World" example and
     98running it shows you have a working tool chain and build of RTEMS ready to run
     99the tests. Using the run with the ERC32 BSP the command is:
    92100
    93101.. code-block:: shell
     
    187195    Testing time     : 0:06:03.519012
    188196
    189 
    190 
    191197* The RTEMS Tester's test command. In this example we are using an absolute
    192198  path.
Note: See TracChangeset for help on using the changeset viewer.