[rtems commit] doc: rtems_get_processor_count()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    6809383d76966a01ef48642943a910f2c6bb6ea9
Changeset: http://git.rtems.org/rtems/commit/?id=6809383d76966a01ef48642943a910f2c6bb6ea9

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Apr 16 15:10:10 2014 +0200

doc: rtems_get_processor_count()

---

 cpukit/rtems/include/rtems/rtems/smp.h |   13 +++++--------
 doc/user/smp.t                         |   25 ++++++++++++++-----------
 2 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/cpukit/rtems/include/rtems/rtems/smp.h b/cpukit/rtems/include/rtems/rtems/smp.h
index fa4d5d6..aeb0df6 100644
--- a/cpukit/rtems/include/rtems/rtems/smp.h
+++ b/cpukit/rtems/include/rtems/rtems/smp.h
@@ -31,9 +31,6 @@ extern "C" {
  *
  * This encapsulates functionality which is useful for SMP applications.
  *
- * This API is also available on uni-processor configurations.  Here compile
- * time constants are used whenever possible.
- *
  * @{
  */
 
@@ -43,12 +40,12 @@ extern "C" {
  * On uni-processor configurations a value of one will be returned.
  *
  * On SMP configurations this returns the value of a global variable set during
- * system initialization to indicate the count of processors.  The processor
- * count depends on the hardware and application configuration.  The value will
- * always be less than or equal to the maximum count of application configured
- * processors.
+ * 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 than or equal
+ * to the maximum count of application configured processors.
  *
- * @return The count of processors in the system.
+ * @return The count of processors being utilized.
  */
 uint32_t rtems_get_processor_count(void);
 
diff --git a/doc/user/smp.t b/doc/user/smp.t
index 449987a..d16df0e 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -14,7 +14,7 @@ provided by RTEMS.
 The application level services currently provided are:
 
 @itemize @bullet
- at item @code{rtems_smp_get_processor_count} - Obtain Number of CPUs
+ at item @code{rtems_get_processor_count} - Get processor count
 @item @code{rtems_task_get_affinity} - Obtain Task Affinity
 @item @code{rtems_task_set_affinity} - Set Task Affinity
 @end itemize
@@ -223,36 +223,39 @@ is dedicated to each of these services and describes the calling sequence,
 related constants, usage, and status codes.
 
 @c
- at c rtems_smp_get_processor_count
+ at c rtems_get_processor_count
 @c
 @page
- at subsection rtems_smp_get_processor_count - Obtain Number of CPUs
+ at subsection GET_PROCESSOR_COUNT - Get processor count
 
 @subheading CALLING SEQUENCE:
 
 @ifset is-C
 @example
-#include <rtems.h>
-
-int rtems_smp_get_processor_count(void);
+uint32_t rtems_get_processor_count(void);
 @end example
 @end ifset
 
 @ifset is-Ada
 @end ifset
 
- at subheading STATUS CODES:
+ at subheading DIRECTIVE STATUS CODES:
 
-Returns the number of processors being utilized.
+The count of processors in the system.
 
 @subheading DESCRIPTION:
 
-The @code{rtems_smp_get_processor_count} routine is used to obtain the
-number of processor cores being utilized.
+On uni-processor configurations a value of one will be returned.
+
+On 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 than or equal to the
+maximum count of application configured processors.
 
 @subheading NOTES:
 
-NONE
+None.
 
 @c
 @c rtems_task_get_affinity