From 4da4a15ee1376bb53bb6e62bd00728c8cb6171cf Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Wed, 9 Nov 2016 11:42:10 +1100 Subject: c-user: Fix header levels. Minor fixes. --- c-user/barrier_manager.rst | 2 +- c-user/board_support_packages.rst | 2 +- c-user/chains.rst | 2 +- c-user/clock_manager.rst | 3 +-- c-user/configuring_a_system.rst | 2 +- c-user/constant_bandwidth_server.rst | 2 +- c-user/cpu_usage_statistics.rst | 2 +- c-user/directive_status_codes.rst | 2 +- c-user/dual_ports_memory_manager.rst | 2 +- c-user/event_manager.rst | 2 +- c-user/example_application.rst | 2 +- c-user/fatal_error.rst | 2 +- c-user/glossary.rst | 2 +- c-user/initialization.rst | 2 +- c-user/interrupt_manager.rst | 22 +++++++++++----------- c-user/io_manager.rst | 2 +- c-user/key_concepts.rst | 2 +- c-user/linker_sets.rst | 2 +- c-user/message_manager.rst | 2 +- c-user/multiprocessing.rst | 2 +- c-user/object_services.rst | 2 +- c-user/overview.rst | 2 +- c-user/partition_manager.rst | 2 +- c-user/pci_library.rst | 2 +- c-user/preface.rst | 2 +- c-user/rate_monotonic_manager.rst | 16 ++++++++-------- c-user/red_black_trees.rst | 2 +- c-user/region_manager.rst | 2 +- c-user/rtems_data_types.rst | 2 +- c-user/scheduling_concepts.rst | 2 +- c-user/semaphore_manager.rst | 2 +- c-user/signal_manager.rst | 2 +- c-user/stack_bounds_checker.rst | 2 +- c-user/symmetric_multiprocessing_services.rst | 3 +-- c-user/task_manager.rst | 2 +- c-user/timer_manager.rst | 2 +- c-user/timespec_helpers.rst | 2 +- c-user/user_extensions.rst | 2 +- 38 files changed, 55 insertions(+), 57 deletions(-) diff --git a/c-user/barrier_manager.rst b/c-user/barrier_manager.rst index 653c98f..be40985 100644 --- a/c-user/barrier_manager.rst +++ b/c-user/barrier_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Barrier Manager -############### +*************** .. index:: barrier diff --git a/c-user/board_support_packages.rst b/c-user/board_support_packages.rst index 9a32036..9e58632 100644 --- a/c-user/board_support_packages.rst +++ b/c-user/board_support_packages.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Board Support Packages -###################### +********************** .. index:: Board Support Packages .. index:: BSPs diff --git a/c-user/chains.rst b/c-user/chains.rst index f427142..382bc46 100644 --- a/c-user/chains.rst +++ b/c-user/chains.rst @@ -4,7 +4,7 @@ .. COMMENT: All rights reserved. Chains -###### +****** .. index:: chains diff --git a/c-user/clock_manager.rst b/c-user/clock_manager.rst index f27e66d..6c00501 100644 --- a/c-user/clock_manager.rst +++ b/c-user/clock_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Clock Manager -############# +************* .. index:: clock @@ -694,7 +694,6 @@ DIRECTIVE STATUS CODES: The system uptime in seconds. DESCRIPTION: - This directive returns the seconds since the system was booted. NOTES: diff --git a/c-user/configuring_a_system.rst b/c-user/configuring_a_system.rst index 16973d6..585014c 100644 --- a/c-user/configuring_a_system.rst +++ b/c-user/configuring_a_system.rst @@ -7,7 +7,7 @@ .. _Configuring a System: Configuring a System -#################### +******************** .. index:: configuring a system diff --git a/c-user/constant_bandwidth_server.rst b/c-user/constant_bandwidth_server.rst index 7f45e26..2db0daa 100644 --- a/c-user/constant_bandwidth_server.rst +++ b/c-user/constant_bandwidth_server.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Constant Bandwidth Server Scheduler API -####################################### +*************************************** .. index:: cbs diff --git a/c-user/cpu_usage_statistics.rst b/c-user/cpu_usage_statistics.rst index 4705ca9..81eb41f 100644 --- a/c-user/cpu_usage_statistics.rst +++ b/c-user/cpu_usage_statistics.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. CPU Usage Statistics -#################### +******************** Introduction ============ diff --git a/c-user/directive_status_codes.rst b/c-user/directive_status_codes.rst index 5106a81..420a0a0 100644 --- a/c-user/directive_status_codes.rst +++ b/c-user/directive_status_codes.rst @@ -4,7 +4,7 @@ .. COMMENT: All rights reserved. Directive Status Codes -###################### +********************** Introduction ============ diff --git a/c-user/dual_ports_memory_manager.rst b/c-user/dual_ports_memory_manager.rst index 7af67c6..18b5808 100644 --- a/c-user/dual_ports_memory_manager.rst +++ b/c-user/dual_ports_memory_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Dual-Ported Memory Manager -########################## +************************** .. index:: ports .. index:: dual ported memory diff --git a/c-user/event_manager.rst b/c-user/event_manager.rst index 4b12a9a..784fbd9 100644 --- a/c-user/event_manager.rst +++ b/c-user/event_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Event Manager -############# +************* .. index:: events diff --git a/c-user/example_application.rst b/c-user/example_application.rst index 49f6e9b..194382e 100644 --- a/c-user/example_application.rst +++ b/c-user/example_application.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Example Application -################### +******************* .. code-block:: c :linenos: diff --git a/c-user/fatal_error.rst b/c-user/fatal_error.rst index 5d7456f..33b5d14 100644 --- a/c-user/fatal_error.rst +++ b/c-user/fatal_error.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Fatal Error Manager -################### +******************* .. index:: fatal errors diff --git a/c-user/glossary.rst b/c-user/glossary.rst index 0ec0d08..694cd7a 100644 --- a/c-user/glossary.rst +++ b/c-user/glossary.rst @@ -1,7 +1,7 @@ .. comment SPDX-License-Identifier: CC-BY-SA-4.0 Glossary -######## +******** :dfn:`active` A term used to describe an object which has been created by an application. diff --git a/c-user/initialization.rst b/c-user/initialization.rst index d808110..27dc148 100644 --- a/c-user/initialization.rst +++ b/c-user/initialization.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Initialization Manager -###################### +********************** Introduction ============ diff --git a/c-user/interrupt_manager.rst b/c-user/interrupt_manager.rst index 8cd1332..529e896 100644 --- a/c-user/interrupt_manager.rst +++ b/c-user/interrupt_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Interrupt Manager -################# +***************** Introduction ============ @@ -325,16 +325,16 @@ CALLING SEQUENCE: DIRECTIVE STATUS CODES: NONE -.. sidebar:: *Macro* - - This directive is implemented as a macro which modifies the ``level`` - parameter. - DESCRIPTION: This directive disables all maskable interrupts and returns the previous ``level``. A later invocation of the ``rtems_interrupt_enable`` directive should be used to restore the interrupt level. +.. sidebar:: *Macro* + + This directive is implemented as a macro which modifies the ``level`` + parameter. + NOTES: This directive will not cause the calling task to be preempted. @@ -433,16 +433,16 @@ CALLING SEQUENCE: DIRECTIVE STATUS CODES: NONE -.. sidebar:: *Macro* - - This directive is implemented as a macro which modifies the ``level`` - parameter. - DESCRIPTION: This directive disables all maskable interrupts and returns the previous ``level``. A later invocation of the ``rtems_interrupt_local_enable`` directive should be used to restore the interrupt level. +.. sidebar:: *Macro* + + This directive is implemented as a macro which modifies the ``level`` + parameter. + NOTES: This directive will not cause the calling task to be preempted. diff --git a/c-user/io_manager.rst b/c-user/io_manager.rst index 74ca5b1..cb8f70d 100644 --- a/c-user/io_manager.rst +++ b/c-user/io_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. I/O Manager -########### +*********** .. index:: device drivers .. index:: IO Manager diff --git a/c-user/key_concepts.rst b/c-user/key_concepts.rst index ef464bb..e196aa4 100644 --- a/c-user/key_concepts.rst +++ b/c-user/key_concepts.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Key Concepts -############ +************ Introduction ============ diff --git a/c-user/linker_sets.rst b/c-user/linker_sets.rst index 37f863e..498aeb6 100644 --- a/c-user/linker_sets.rst +++ b/c-user/linker_sets.rst @@ -7,7 +7,7 @@ .. _Linker Sets: Linker Sets -########### +*********** .. index:: linkersets diff --git a/c-user/message_manager.rst b/c-user/message_manager.rst index 5613da9..496137e 100644 --- a/c-user/message_manager.rst +++ b/c-user/message_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Message Manager -############### +*************** .. index:: messages .. index:: message queues diff --git a/c-user/multiprocessing.rst b/c-user/multiprocessing.rst index 5323cfa..6ff2dff 100644 --- a/c-user/multiprocessing.rst +++ b/c-user/multiprocessing.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Multiprocessing Manager -####################### +*********************** .. index:: multiprocessing diff --git a/c-user/object_services.rst b/c-user/object_services.rst index e748de7..0ee32ef 100644 --- a/c-user/object_services.rst +++ b/c-user/object_services.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Object Services -############### +*************** .. index:: object manipulation diff --git a/c-user/overview.rst b/c-user/overview.rst index 273e5ed..e6722af 100644 --- a/c-user/overview.rst +++ b/c-user/overview.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Overview -######## +******** Introduction ============ diff --git a/c-user/partition_manager.rst b/c-user/partition_manager.rst index f3d0a92..fafd988 100644 --- a/c-user/partition_manager.rst +++ b/c-user/partition_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Partition Manager -################# +***************** .. index:: partitions diff --git a/c-user/pci_library.rst b/c-user/pci_library.rst index 5e15a56..ea0bf51 100644 --- a/c-user/pci_library.rst +++ b/c-user/pci_library.rst @@ -6,7 +6,7 @@ PCI Library -########### +*********** .. index:: libpci diff --git a/c-user/preface.rst b/c-user/preface.rst index e593a9e..cd02fb9 100644 --- a/c-user/preface.rst +++ b/c-user/preface.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Preface -####### +******* In recent years, the cost required to develop a software product has increased significantly while the target hardware costs have decreased. Now a larger diff --git a/c-user/rate_monotonic_manager.rst b/c-user/rate_monotonic_manager.rst index c2ba1a5..8ad74e5 100644 --- a/c-user/rate_monotonic_manager.rst +++ b/c-user/rate_monotonic_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Rate Monotonic Manager -###################### +********************** .. index:: rate mononitonic tasks .. index:: periodic tasks @@ -235,7 +235,7 @@ even under transient overload, without knowing exactly when any given task will execute by applying proven schedulability analysis rules. Assumptions -~~~~~~~~~~~ +^^^^^^^^^^^ The schedulability analysis rules for RMS were developed based on the following assumptions: @@ -258,7 +258,7 @@ Once the basic schedulability analysis is understood, some of the above assumptions can be relaxed and the side-effects accounted for. Processor Utilization Rule -~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^ .. index:: RMS Processor Utilization Rule The Processor Utilization Rule requires that processor utilization be @@ -285,7 +285,7 @@ scheduled with a greater utilization factor. In fact, the average processor utilization threshold for a randomly generated task set is approximately 0.88. Processor Utilization Rule Example -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This example illustrates the application of the Processor Utilization Rule to an application with three critical periodic tasks. The following table details @@ -309,7 +309,7 @@ Utilization Rule. Therefore, this task set is guaranteed to be schedulable using RMS. First Deadline Rule -~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^ .. index:: RMS First Deadline Rule If a given set of tasks do exceed the processor utilization upper limit imposed @@ -330,7 +330,7 @@ ensures that all tasks begin to compete for execution time at the same instant - when the user initialization task deletes itself. First Deadline Rule Example -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^ The First Deadline Rule can ensure schedulability even when the Processor Utilization Rule fails. The example below is a modification of the Processor @@ -385,7 +385,7 @@ Thus, all of the tasks have met their first deadlines at time 200, and the task set is schedulable using the First Deadline Rule. Relaxation of Assumptions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ The assumptions used to develop the RMS schedulability rules are uncommon in most real-time systems. For example, it was assumed that tasks have constant @@ -418,7 +418,7 @@ using RMS. Every hardware and software factor which impacts the execution time of each task must be accounted for in the schedulability analysis. Further Reading -~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^ For more information on Rate Monotonic Scheduling and its schedulability analysis, the reader is referred to the following: diff --git a/c-user/red_black_trees.rst b/c-user/red_black_trees.rst index 77dcf3f..53c8f81 100644 --- a/c-user/red_black_trees.rst +++ b/c-user/red_black_trees.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Red-Black Trees -############### +*************** .. index:: rbtrees diff --git a/c-user/region_manager.rst b/c-user/region_manager.rst index c5491cb..fd55da6 100644 --- a/c-user/region_manager.rst +++ b/c-user/region_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Region Manager -############## +************** .. index:: regions diff --git a/c-user/rtems_data_types.rst b/c-user/rtems_data_types.rst index da23448..323a0dc 100644 --- a/c-user/rtems_data_types.rst +++ b/c-user/rtems_data_types.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. RTEMS Data Types -################ +**************** Introduction ============ diff --git a/c-user/scheduling_concepts.rst b/c-user/scheduling_concepts.rst index c7ccb2d..8d25424 100644 --- a/c-user/scheduling_concepts.rst +++ b/c-user/scheduling_concepts.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Scheduling Concepts -################### +******************* .. index:: scheduling .. index:: task scheduling diff --git a/c-user/semaphore_manager.rst b/c-user/semaphore_manager.rst index 13b5ff3..2f75cc2 100644 --- a/c-user/semaphore_manager.rst +++ b/c-user/semaphore_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Semaphore Manager -################# +***************** .. index:: semaphores .. index:: binary semaphores diff --git a/c-user/signal_manager.rst b/c-user/signal_manager.rst index d6b253d..2bc9709 100644 --- a/c-user/signal_manager.rst +++ b/c-user/signal_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Signal Manager -############## +************** .. index:: signals diff --git a/c-user/stack_bounds_checker.rst b/c-user/stack_bounds_checker.rst index 87c16f5..67f1771 100644 --- a/c-user/stack_bounds_checker.rst +++ b/c-user/stack_bounds_checker.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Stack Bounds Checker -#################### +******************** .. index:: stack diff --git a/c-user/symmetric_multiprocessing_services.rst b/c-user/symmetric_multiprocessing_services.rst index 7f71f8e..6a47204 100644 --- a/c-user/symmetric_multiprocessing_services.rst +++ b/c-user/symmetric_multiprocessing_services.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Symmetric Multiprocessing Services -################################## +********************************** Introduction ============ @@ -939,7 +939,6 @@ DIRECTIVE STATUS CODES: set of the task DESCRIPTION: - Returns the current processor affinity set of the task in ``cpuset``. A set bit in the affinity set means that the task can execute on this processor and a cleared bit means the opposite. diff --git a/c-user/task_manager.rst b/c-user/task_manager.rst index beaef3b..76b7cca 100644 --- a/c-user/task_manager.rst +++ b/c-user/task_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Task Manager -############ +************ .. index:: tasks diff --git a/c-user/timer_manager.rst b/c-user/timer_manager.rst index d9ffd92..000348d 100644 --- a/c-user/timer_manager.rst +++ b/c-user/timer_manager.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Timer Manager -############# +************* .. index:: timers diff --git a/c-user/timespec_helpers.rst b/c-user/timespec_helpers.rst index c818651..905af55 100644 --- a/c-user/timespec_helpers.rst +++ b/c-user/timespec_helpers.rst @@ -5,7 +5,7 @@ .. COMMENT: All rights reserved. Timespec Helpers -################ +**************** Introduction ============ diff --git a/c-user/user_extensions.rst b/c-user/user_extensions.rst index aba0d9b..662ddf4 100644 --- a/c-user/user_extensions.rst +++ b/c-user/user_extensions.rst @@ -7,7 +7,7 @@ .. _User Extensions Manager: User Extensions Manager -####################### +*********************** .. index:: user extensions -- cgit v1.2.3