rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-14 08:29:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Fix header levels. Minor fixes.

Browse Source
This commit is contained in:
Chris Johns 2016-11-09 11:42:10 +11:00
parent a91dd5c695
commit 4da4a15ee1
38 changed files with 55 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
c-user/barrier_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Barrier Manager
###############
***************
.. index:: barrier

2
c-user/board_support_packages.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Board Support Packages
######################
**********************
.. index:: Board Support Packages
.. index:: BSPs

2
c-user/chains.rst
View File

@ -4,7 +4,7 @@
.. COMMENT: All rights reserved.
Chains
######
******
.. index:: chains

3
c-user/clock_manager.rst
View File

@ -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:

2
c-user/configuring_a_system.rst
View File

@ -7,7 +7,7 @@
.. _Configuring a System:
Configuring a System
####################
********************
.. index:: configuring a system

2
c-user/constant_bandwidth_server.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Constant Bandwidth Server Scheduler API
#######################################
***************************************
.. index:: cbs

2
c-user/cpu_usage_statistics.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
CPU Usage Statistics
####################
********************
Introduction
============

2
c-user/directive_status_codes.rst
View File

@ -4,7 +4,7 @@
.. COMMENT: All rights reserved.
Directive Status Codes
######################
**********************
Introduction
============

2
c-user/dual_ports_memory_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Dual-Ported Memory Manager
##########################
**************************
.. index:: ports
.. index:: dual ported memory

2
c-user/event_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Event Manager
#############
*************
.. index:: events

2
c-user/example_application.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Example Application
###################
*******************
.. code-block:: c
:linenos:

2
c-user/fatal_error.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Fatal Error Manager
###################
*******************
.. index:: fatal errors

2
c-user/glossary.rst
View File

@ -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.

2
c-user/initialization.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Initialization Manager
######################
**********************
Introduction
============

22
c-user/interrupt_manager.rst
View File

@ -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.

2
c-user/io_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
I/O Manager
###########
***********
.. index:: device drivers
.. index:: IO Manager

2
c-user/key_concepts.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Key Concepts
############
************
Introduction
============

2
c-user/linker_sets.rst
View File

@ -7,7 +7,7 @@
.. _Linker Sets:
Linker Sets
###########
***********
.. index:: linkersets

2
c-user/message_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Message Manager
###############
***************
.. index:: messages
.. index:: message queues

2
c-user/multiprocessing.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Multiprocessing Manager
#######################
***********************
.. index:: multiprocessing

2
c-user/object_services.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Object Services
###############
***************
.. index:: object manipulation

2
c-user/overview.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Overview
########
********
Introduction
============

2
c-user/partition_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Partition Manager
#################
*****************
.. index:: partitions

2
c-user/pci_library.rst
View File

@ -6,7 +6,7 @@
PCI Library
###########
***********
.. index:: libpci

2
c-user/preface.rst
View File

@ -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

16
c-user/rate_monotonic_manager.rst
View File

@ -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:

2
c-user/red_black_trees.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Red-Black Trees
###############
***************
.. index:: rbtrees

2
c-user/region_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Region Manager
##############
**************
.. index:: regions

2
c-user/rtems_data_types.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
RTEMS Data Types
################
****************
Introduction
============

2
c-user/scheduling_concepts.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Scheduling Concepts
###################
*******************
.. index:: scheduling
.. index:: task scheduling

2
c-user/semaphore_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Semaphore Manager
#################
*****************
.. index:: semaphores
.. index:: binary semaphores

2
c-user/signal_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Signal Manager
##############
**************
.. index:: signals

2
c-user/stack_bounds_checker.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Stack Bounds Checker
####################
********************
.. index:: stack

3
c-user/symmetric_multiprocessing_services.rst
View File

@ -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.

2
c-user/task_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Task Manager
############
************
.. index:: tasks

2
c-user/timer_manager.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Timer Manager
#############
*************
.. index:: timers

2
c-user/timespec_helpers.rst
View File

@ -5,7 +5,7 @@
.. COMMENT: All rights reserved.
Timespec Helpers
################
****************
Introduction
============

2
c-user/user_extensions.rst
View File

@ -7,7 +7,7 @@
.. _User Extensions Manager:
User Extensions Manager
#######################
***********************
.. index:: user extensions