[rtems commit] doc: rtems_scheduler_ident()

[Sebastian Huber]

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

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

doc: rtems_scheduler_ident()

---

 doc/user/smp.t |   37 +++++++++++++++++++++++++++++++++++++
 1 files changed, 37 insertions(+), 0 deletions(-)

diff --git a/doc/user/smp.t b/doc/user/smp.t
index d0bb240..fd349ec 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -16,6 +16,7 @@ The application level services currently provided are:
 @itemize @bullet
 @item @code{rtems_get_processor_count} - Get processor count
 @item @code{rtems_get_current_processor} - Get current processor index
+ at item @code{rtems_scheduler_ident} - Get ID of a scheduler
 @item @code{rtems_task_get_affinity} - Get task processor affinity
 @item @code{rtems_task_set_affinity} - Set task processor affinity
 @end itemize
@@ -297,6 +298,42 @@ thread dispatching disabled.
 None.
 
 @c
+ at c rtems_scheduler_ident
+ at c
+ at page
+ at subsection SCHEDULER_IDENT - Get ID of a scheduler
+
+ at subheading CALLING SEQUENCE:
+
+ at ifset is-C
+ at example
+rtems_status_code rtems_scheduler_ident(
+  rtems_name  name,
+  rtems_id   *id
+);
+ at end example
+ at end ifset
+
+ at ifset is-Ada
+ at end ifset
+
+ at subheading DIRECTIVE STATUS CODES:
+
+ at code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+ at code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
+ at code{@value{RPREFIX}INVALID_NAME} - invalid scheduler name
+
+ at subheading DESCRIPTION:
+
+Identifies a scheduler by its name.  The scheduler name is determined by the
+scheduler configuration.  @xref{Configuring a System Configuring
+Clustered/Partitioned Schedulers}.
+
+ at subheading NOTES:
+
+None.
+
+ at c
 @c rtems_task_get_affinity
 @c
 @page