c-user: Fix header levels. Minor fixes.

2025-05-14 20:41:55 +08:00 · 2016-11-09 11:42:10 +11:00 · 2016-11-09 11:42:10 +11:00 · 4da4a15ee1
commit 4da4a15ee1
parent a91dd5c695
38 changed files with 55 additions and 57 deletions
--- a/c-user/barrier_manager.rst
+++ b/c-user/barrier_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Barrier Manager
-###############
+***************
 .. index:: barrier
--- 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
--- a/c-user/chains.rst
+++ b/c-user/chains.rst
@ -4,7 +4,7 @@
 .. COMMENT: All rights reserved.
 Chains
-######
+******
 .. index:: chains
--- 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:
--- 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
--- 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
--- 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
 ============
--- 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
 ============
--- 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
--- a/c-user/event_manager.rst
+++ b/c-user/event_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Event Manager
-#############
+*************
 .. index:: events
--- 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:
--- 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
--- 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.
--- a/c-user/initialization.rst
+++ b/c-user/initialization.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Initialization Manager
-######################
+**********************
 Introduction
 ============
--- 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.
--- 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
--- a/c-user/key_concepts.rst
+++ b/c-user/key_concepts.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Key Concepts
-############
+************
 Introduction
 ============
--- a/c-user/linker_sets.rst
+++ b/c-user/linker_sets.rst
@ -7,7 +7,7 @@
 .. _Linker Sets:
 Linker Sets
-###########
+***********
 .. index:: linkersets
--- 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
--- a/c-user/multiprocessing.rst
+++ b/c-user/multiprocessing.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Multiprocessing Manager
-#######################
+***********************
 .. index:: multiprocessing
--- 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
--- a/c-user/overview.rst
+++ b/c-user/overview.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Overview
-########
+********
 Introduction
 ============
--- a/c-user/partition_manager.rst
+++ b/c-user/partition_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Partition Manager
-#################
+*****************
 .. index:: partitions
--- a/c-user/pci_library.rst
+++ b/c-user/pci_library.rst
@ -6,7 +6,7 @@
 PCI Library
-###########
+***********
 .. index:: libpci
--- 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
--- 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:
--- 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
--- a/c-user/region_manager.rst
+++ b/c-user/region_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Region Manager
-##############
+**************
 .. index:: regions
--- 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
 ============
--- 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
--- 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
--- a/c-user/signal_manager.rst
+++ b/c-user/signal_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Signal Manager
-##############
+**************
 .. index:: signals
--- 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
--- 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.
--- a/c-user/task_manager.rst
+++ b/c-user/task_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Task Manager
-############
+************
 .. index:: tasks
--- a/c-user/timer_manager.rst
+++ b/c-user/timer_manager.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Timer Manager
-#############
+*************
 .. index:: timers
--- a/c-user/timespec_helpers.rst
+++ b/c-user/timespec_helpers.rst
@ -5,7 +5,7 @@
 .. COMMENT: All rights reserved.
 Timespec Helpers
-################
+****************
 Introduction
 ============
--- 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