From 7479042a5914a6b9223e734b4a14652314661e1a Mon Sep 17 00:00:00 2001
From: Joel Sherrill <joel.sherrill@OARcorp.com>
Date: Mon, 11 Oct 1999 21:24:38 +0000
Subject: Generated concept and function index entries.

---
 doc/posix_users/sched.t | 66 +++++++++++++++++++++++++++++++++----------------
 1 file changed, 45 insertions(+), 21 deletions(-)

(limited to 'doc/posix_users/sched.t')

diff --git a/doc/posix_users/sched.t b/doc/posix_users/sched.t
index 5730c52e2e..d2b9db5d07 100644
--- a/doc/posix_users/sched.t
+++ b/doc/posix_users/sched.t
@@ -1,9 +1,9 @@
 @c
-@c  COPYRIGHT (c) 1988-1998.
-@c  On-Line Applications Research Corporation (OAR).
-@c  All rights reserved.
+@c COPYRIGHT (c) 1988-1998.
+@c On-Line Applications Research Corporation (OAR).
+@c All rights reserved.
 @c
-@c  $Id$
+@c $Id$
 @c
 
 @chapter Scheduler Manager
@@ -27,7 +27,7 @@ The directives provided by the scheduler manager are:
 
 In the RTEMS implementation of the POSIX API, the priorities range from
 the low priority of @code{sched_get_priority_min()} to the highest priority of
-@code{sched_get_priority_max()}.  Numerically higher values represent higher
+@code{sched_get_priority_max()}. Numerically higher values represent higher
 priorities.
 
 @subsection Scheduling Policies
@@ -36,24 +36,24 @@ The following scheduling policies are available:
 
 @table @b
 @item SCHED_FIFO
-Priority-based, preemptive scheduling with no timeslicing.  This is equivalent
+Priority-based, preemptive scheduling with no timeslicing. This is equivalent
 to what is called "manual round-robin" scheduling.
 
 @item SCHED_RR
-Priority-based, preemptive scheduling with timeslicing.  Time quantums are 
+Priority-based, preemptive scheduling with timeslicing. Time quantums are
 maintained on a per-thread basis and are not reset at each context switch.
 Thus, a thread which is preempted and subsequently resumes execution will
 attempt to complete the unused portion of its time quantum.
 
 @item SCHED_OTHER
-Priority-based, preemptive scheduling with timeslicing.  Time quantums are 
+Priority-based, preemptive scheduling with timeslicing. Time quantums are
 maintained on a per-thread basis and are reset at each context switch.
 
 @item SCHED_SPORADIC
 Priority-based, preemptive scheduling utilizing three additional parameters:
-budget, replenishment period, and low priority.  Under this policy, the 
+budget, replenishment period, and low priority. Under this policy, the
 thread is allowed to execute for "budget" amount of time before its priority
-is lowered to "low priority".  At the end of each replenishment period,
+is lowered to "low priority". At the end of each replenishment period,
 the thread resumes its initial priority and has its budget replenished.
 
 @end table
@@ -69,16 +69,22 @@ A subsection is dedicated to each of this manager's directives
 and describes the calling sequence, related constants, usage,
 and status codes.
 
+@c
+@c
+@c
 @page
 @subsection sched_get_priority_min - Get Minimum Priority Value
 
+@findex sched_get_priority_min
+@cindex  get minimum priority value
+
 @subheading CALLING SEQUENCE:
 
 @example
 #include <sched.h>
 
 int sched_get_priority_min(
-  int policy
+int policy
 );
 @end example
 
@@ -89,7 +95,7 @@ On error, this routine returns -1 and sets errno to one of the following:
 @table @b
 @item EINVAL
 The indicated policy is invalid.
- 
+
 @end table
 
 @subheading DESCRIPTION:
@@ -101,16 +107,22 @@ for the specified @code{policy}.
 
 NONE
 
+@c
+@c
+@c
 @page
 @subsection sched_get_priority_max - Get Maximum Priority Value
 
+@findex sched_get_priority_max
+@cindex  get maximum priority value
+
 @subheading CALLING SEQUENCE:
 
 @example
 #include <sched.h>
 
 int sched_get_priority_max(
-  int policy
+int policy
 );
 @end example
 
@@ -121,7 +133,7 @@ On error, this routine returns -1 and sets errno to one of the following:
 @table @b
 @item EINVAL
 The indicated policy is invalid.
- 
+
 @end table
 
 @subheading DESCRIPTION:
@@ -133,17 +145,23 @@ for the specified @code{policy}.
 
 NONE
 
+@c
+@c
+@c
 @page
 @subsection sched_rr_get_interval - Get Timeslicing Quantum
 
+@findex sched_rr_get_interval
+@cindex  get timeslicing quantum
+
 @subheading CALLING SEQUENCE:
 
 @example
 #include <sched.h>
 
 int sched_rr_get_interval(
-  pid_t            pid,
-  struct timespec *interval
+pid_t pid,
+struct timespec *interval
 );
 @end example
 
@@ -153,25 +171,31 @@ On error, this routine returns -1 and sets errno to one of the following:
 
 @table @b
 @item ESRCH
-The indicated process id is invalid. 
- 
+The indicated process id is invalid.
+
 @item EINVAL
-The specified interval pointer parameter is invalid. 
+The specified interval pointer parameter is invalid.
 
 @end table
 
 @subheading DESCRIPTION:
 
-This routine returns the length of the timeslice quantum in the 
+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.
 
+@c
+@c
+@c
 @page
 @subsection sched_yield - Yield the Processor
 
+@findex sched_yield
+@cindex  yield the processor
+
 @subheading CALLING SEQUENCE:
 
 @example
@@ -187,7 +211,7 @@ This routine always returns zero to indicate success.
 @subheading DESCRIPTION:
 
 This call forces the calling thread to yield the processor to another
-thread.  Normally this is used to implement voluntary round-robin
+thread. Normally this is used to implement voluntary round-robin
 task scheduling.
 
 @subheading NOTES:
-- 
cgit v1.2.3