Changeset e2c8e2c in rtems

Timestamp:

07/01/99 23:05:07 (24 years ago)

Author:

Joel Sherrill <joel.sherrill@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

68f54e1

Parents:

1c4d8f0

Message:

Filled in.

File:

• doc/posix_users/sched.t (modified) (7 diffs)

doc/posix_users/sched.t

@@ -16 +16 @@
 
 @itemize @bullet
-@item @code{sched_get_priority_min} - 
-@item @code{sched_get_priority_max} - 
-@item @code{sched_rr_get_interval} - 
-@item @code{sched_yield} - 
+@item @code{sched_get_priority_min} - Get Minimum Priority Value
+@item @code{sched_get_priority_max} - Get Maximum Priority Value
+@item @code{sched_rr_get_interval} - Get Timeslicing Quantum
+@item @code{sched_yield} - Yield the Processor
 @end itemize
 
@@ -27 +27 @@
 
 In the RTEMS implementation of the POSIX API, the priorities range from
-the low priority of sched_get_priority_min() to the highest priority of
-sched_get_priority_max().  Numerically higher values represent higher
+the low priority of @code{sched_get_priority_min()} to the highest priority of
+@code{sched_get_priority_max()}.  Numerically higher values represent higher
 priorities.
 
@@ -71 +71 @@
 
 @page
-@subsection sched_get_priority_min
+@subsection sched_get_priority_min - Get Minimum Priority Value
 
 @subheading CALLING SEQUENCE:
@@ -95 +95 @@
 @subheading DESCRIPTION:
 
+This routine return the minimum (numerically and logically lowest) priority
+for the specified @code{policy}.
+
 @subheading NOTES:
 
+NONE
+
 @page
-@subsection sched_get_priority_max
+@subsection sched_get_priority_max - Get Maximum Priority Value
 
 @subheading CALLING SEQUENCE:
@@ -122 +127 @@
 @subheading DESCRIPTION:
 
+This routine return the maximum (numerically and logically highest) priority
+for the specified @code{policy}.
+
 @subheading NOTES:
 
+NONE
+
 @page
-@subsection sched_rr_get_interval
+@subsection sched_rr_get_interval - Get Timeslicing Quantum
 
 @subheading CALLING SEQUENCE:
@@ -153 +163 @@
 @subheading DESCRIPTION:
 
+This routine returns the length of the timeslice quantum in the 
+@code{interval} parameter for the specified @code{pid}.
+
 @subheading NOTES:
 
+The @code{pid} argument should be 0 to indicate the calling process.
+
 @page
-@subsection sched_yield
+@subsection sched_yield - Yield the Processor
 
 @subheading CALLING SEQUENCE:
@@ -172 +187 @@
 @subheading DESCRIPTION:
 
+This call forces the calling thread to yield the processor to another
+thread.  Normally this is used to implement voluntary round-robin
+task scheduling.
+
 @subheading NOTES:
 
+NONE