[rtems-docs commit] Use "in X config..." instead of "on X config..."
Sebastian Huber
sebh at rtems.org
Wed Feb 1 12:44:24 UTC 2017
Module: rtems-docs
Branch: master
Commit: a0d2eeea9da0671faecb31c7f1e426f76e8bc506
Changeset: http://git.rtems.org/rtems-docs/commit/?id=a0d2eeea9da0671faecb31c7f1e426f76e8bc506
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Wed Feb 1 13:38:41 2017 +0100
Use "in X config..." instead of "on X config..."
---
c-user/configuring_a_system.rst | 7 +++----
c-user/fatal_error.rst | 6 +++---
c-user/glossary.rst | 2 +-
c-user/interrupt_manager.rst | 18 +++++++++---------
c-user/semaphore_manager.rst | 10 +++++-----
c-user/symmetric_multiprocessing_services.rst | 12 ++++++------
6 files changed, 27 insertions(+), 28 deletions(-)
diff --git a/c-user/configuring_a_system.rst b/c-user/configuring_a_system.rst
index dceec7b..7f69724 100644
--- a/c-user/configuring_a_system.rst
+++ b/c-user/configuring_a_system.rst
@@ -670,12 +670,11 @@ DEFAULT VALUE:
DESCRIPTION:
``CONFIGURE_MAXIMUM_MRSP_SEMAPHORES`` is the maximum number of Classic API
- Semaphores using the Multiprocessor Resource Sharing Protocol (MrsP) that
- can be concurrently active.
+ Semaphores using the :ref:`MrsP` that can be concurrently active.
NOTES:
- This configuration option is only used on SMP configurations. On
- uni-processor configurations the Priority Ceiling Protocol is used for MrsP
+ This configuration option is only used in SMP configurations. In
+ uni-processor configurations, the :ref:`PriorityCeiling` is used for MrsP
semaphores and thus no extra memory is necessary.
.. COMMENT: === CONFIGURE_MAXIMUM_MESSAGE_QUEUES ===
diff --git a/c-user/fatal_error.rst b/c-user/fatal_error.rst
index 92a228b..c716c89 100644
--- a/c-user/fatal_error.rst
+++ b/c-user/fatal_error.rst
@@ -248,7 +248,7 @@ INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK (28)
A deadlock was detected during a thread queue enqueue operation.
INTERNAL_ERROR_THREAD_QUEUE_ENQUEUE_STICKY_FROM_BAD_STATE (29)
- This fatal error can only happen on SMP configurations. It is not allowed
+ This fatal error can only happen in SMP configurations. It is not allowed
to obtain MrsP semaphores in a context with thread dispatching disabled,
for example interrupt context.
@@ -331,7 +331,7 @@ INTERNAL_ERROR_BAD_THREAD_DISPATCH_DISABLE_LEVEL (30)
}
INTERNAL_ERROR_BAD_THREAD_DISPATCH_ENVIRONMENT (31)
- On SMP configurations, it is a fatal error to call blocking operating
+ In SMP configurations, it is a fatal error to call blocking operating
system with interrupts disabled, since this prevents delivery of
inter-processor interrupts. This could lead to executing threads which are
not allowed to execute resulting in undefined system behaviour.
@@ -409,7 +409,7 @@ required
- valid read-only data.
For the initial extensions the read-write data (including .bss segment) is not
-required on single processor configurations. On SMP configurations, however,
+required on single processor configurations. In SMP configurations, however,
the read-write data must be initialized since this function must determine the
state of the other processors and request them to shut-down if necessary.
diff --git a/c-user/glossary.rst b/c-user/glossary.rst
index 9c4df99..3cb0ed9 100644
--- a/c-user/glossary.rst
+++ b/c-user/glossary.rst
@@ -171,7 +171,7 @@ Glossary
:dfn:`executing task`
The task state entered by a task after it has been given control of the
- processor. On SMP configurations a task may be registered as executing on
+ processor. In SMP configurations, a task may be registered as executing on
more than one processor for short time frames during task migration.
Blocked tasks can be executing until they issue a thread dispatch.
diff --git a/c-user/interrupt_manager.rst b/c-user/interrupt_manager.rst
index 529e896..f7c1ce8 100644
--- a/c-user/interrupt_manager.rst
+++ b/c-user/interrupt_manager.rst
@@ -446,7 +446,7 @@ DESCRIPTION:
NOTES:
This directive will not cause the calling task to be preempted.
- On SMP configurations this will not ensure system wide mutual exclusion.
+ In SMP configurations, this will not ensure system wide mutual exclusion.
Use interrupt locks instead.
.. raw:: latex
@@ -528,8 +528,8 @@ DIRECTIVE STATUS CODES:
NONE
DESCRIPTION:
- Interrupts will be disabled. On SMP configurations this directive acquires
- a SMP lock.
+ Interrupts will be disabled. In SMP configurations, this directive
+ acquires an SMP lock.
NOTES:
This directive will not cause the calling thread to be preempted. This
@@ -557,8 +557,8 @@ DIRECTIVE STATUS CODES:
NONE
DESCRIPTION:
- The interrupt status will be restored. On SMP configurations this
- directive releases a SMP lock.
+ The interrupt status will be restored. In SMP configurations, this
+ directive releases an SMP lock.
NOTES:
This directive will not cause the calling thread to be preempted. This
@@ -586,8 +586,8 @@ DIRECTIVE STATUS CODES:
NONE
DESCRIPTION:
- The interrupt status will remain unchanged. On SMP configurations this
- directive acquires a SMP lock.
+ The interrupt status will remain unchanged. In SMP configurations, this
+ directive acquires an SMP lock.
In case the corresponding interrupt service routine can be interrupted by
higher priority interrupts and these interrupts enter the critical section
@@ -620,8 +620,8 @@ DIRECTIVE STATUS CODES:
DESCRIPTION:
- The interrupt status will remain unchanged. On SMP configurations this
- directive releases a SMP lock.
+ The interrupt status will remain unchanged. In SMP configurations, this
+ directive releases an SMP lock.
NOTES:
This directive should be called from the corresponding interrupt service
diff --git a/c-user/semaphore_manager.rst b/c-user/semaphore_manager.rst
index e184590..f57bd80 100644
--- a/c-user/semaphore_manager.rst
+++ b/c-user/semaphore_manager.rst
@@ -428,7 +428,7 @@ NOTES:
maximum_global_objects field in the Configuration Table.
It is not allowed to create an initially locked MrsP semaphore and the
- ``RTEMS_INVALID_NUMBER`` status code will be returned on SMP configurations
+ ``RTEMS_INVALID_NUMBER`` status code will be returned in SMP configurations
in this case. This prevents lock order reversal problems with the
allocator mutex.
@@ -612,7 +612,7 @@ DESCRIPTION:
then timeout is ignored.
Deadlock situations are detected for MrsP semaphores and the
- ``RTEMS_UNSATISFIED`` status code will be returned on SMP configurations in
+ ``RTEMS_UNSATISFIED`` status code will be returned in SMP configurations in
this case.
NOTES:
@@ -638,7 +638,7 @@ NOTES:
It is not allowed to obtain a MrsP semaphore more than once by one task at
a time (nested access) and the ``RTEMS_UNSATISFIED`` status code will be
- returned on SMP configurations in this case.
+ returned in SMP configurations in this case.
.. raw:: latex
@@ -698,7 +698,7 @@ NOTES:
semaphores and it has inherited a higher priority.
The MrsP semaphores must be released in the reversed obtain order,
- otherwise the ``RTEMS_INCORRECT_STATE`` status code will be returned on SMP
+ otherwise the ``RTEMS_INCORRECT_STATE`` status code will be returned in SMP
configurations in this case.
.. raw:: latex
@@ -755,7 +755,7 @@ NOTES:
task is reclaimed.
It is not allowed to flush a MrsP semaphore and the ``RTEMS_NOT_DEFINED``
- status code will be returned on SMP configurations in this case.
+ status code will be returned in SMP configurations in this case.
.. raw:: latex
diff --git a/c-user/symmetric_multiprocessing_services.rst b/c-user/symmetric_multiprocessing_services.rst
index 38581ac..11b04da 100644
--- a/c-user/symmetric_multiprocessing_services.rst
+++ b/c-user/symmetric_multiprocessing_services.rst
@@ -265,7 +265,7 @@ Disable Interrupts and Interrupt Locks
A low overhead means to ensure mutual exclusion in uni-processor configurations
is to disable interrupts around a critical section. This is commonly used in
-device driver code and throughout the operating system core. On SMP
+device driver code and throughout the operating system core. In SMP
configurations, however, disabling the interrupts on one processor has no
effect on other processors. So, this is insufficient to ensure system wide
mutual exclusion. The macros
@@ -276,7 +276,7 @@ mutual exclusion. The macros
- ``rtems_interrupt_flush()``
-are disabled on SMP configurations and its use will lead to compiler warnings
+are disabled in SMP configurations and its use will lead to compiler warnings
and linker errors. In the unlikely case that interrupts must be disabled on
the current processor, then the
@@ -522,9 +522,9 @@ DIRECTIVE STATUS CODES:
The count of processors in the system.
DESCRIPTION:
- On uni-processor configurations a value of one will be returned.
+ In uni-processor configurations, a value of one will be returned.
- On SMP configurations this returns the value of a global variable set
+ In SMP configurations, this returns the value of a global variable set
during system initialization to indicate the count of utilized processors.
The processor count depends on the physically or virtually available
processors and application configuration. The value will always be less
@@ -551,9 +551,9 @@ DIRECTIVE STATUS CODES:
The index of the current processor.
DESCRIPTION:
- On uni-processor configurations a value of zero will be returned.
+ In uni-processor configurations, a value of zero will be returned.
- On SMP configurations an architecture specific method is used to obtain the
+ In SMP configurations, an architecture specific method is used to obtain the
index of the current processor in the system. The set of processor indices
is the range of integers starting with zero up to the processor count minus
one.
More information about the vc
mailing list