Added "findex" for all directive pages but it turns out that this

blows up both makeinfo and texi2dvi. So I have commented them out.
1998-04-02 16:18:26 +00:00
parent 7f70ad7daa
commit 87ed029c79
18 changed files with 98 additions and 4 deletions
--- a/doc/user/c_user.texi
+++ b/doc/user/c_user.texi
@@ -154,9 +154,7 @@ This is the online version of the RTEMS C User's Guide.
@node Command and Variable Index, Concept Index, Glossary, Top
@unnumbered Command and Variable Index

-There are currently no Command and Variable Index entries.
-
-@c @printindex fn
+@printindex fn

@node Concept Index, , Command and Variable Index, Top
@unnumbered Concept Index
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -224,6 +224,7 @@ and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_clock_set
@example
 rtems_status_code rtems_clock_set(
  rtems_time_of_day *time_buffer
@@ -274,6 +275,7 @@ the system date and time to application specific specifications.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_clock_get
@example
 rtems_status_code rtems_clock_get(
  rtems_clock_get_options  option,
@@ -364,6 +366,7 @@ system date and time to application specific specifications.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_clock_tick
@example
 rtems_status_code rtems_clock_tick( void );
@end example
--- a/doc/user/dpmem.t
+++ b/doc/user/dpmem.t
@@ -98,6 +98,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_port_create
@example
 rtems_status_code rtems_port_create(
  rtems_name        name,
@@ -155,6 +156,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_port_ident
@example
 rtems_status_code rtems_port_ident(
  rtems_name  name,
@@ -197,6 +199,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_port_delete
@example
 rtems_status_code rtems_port_delete(
  rtems_id id
@@ -238,6 +241,7 @@ delete the port.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_port_external_to_internal
@example
 rtems_status_code rtems_port_external_to_internal(
  rtems_id   id,
@@ -282,6 +286,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_port_internal_to_external
@example
 rtems_status_code rtems_port_internal_to_external(
  rtems_id   id,
--- a/doc/user/event.t
+++ b/doc/user/event.t
@@ -190,6 +190,7 @@ and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_event_send
@example
 rtems_status_code rtems_event_send (
  rtems_id         id,
@@ -246,7 +247,8 @@ remote node to send the event set to the appropriate task.
@subheading CALLING SEQUENCE:

@ifset is-C
-@example
+@c @findex rtems_event_receive
+@example 
 rtems_status_code rtems_event_receive (
  rtems_event_set  event_in,
  rtems_option     option_set,
--- a/doc/user/fatal.t
+++ b/doc/user/fatal.t
@@ -116,6 +116,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_fatal_error_occurred
@example
 void volatile rtems_fatal_error_occurred(
  rtems_unsigned32        the_error
--- a/doc/user/init.t
+++ b/doc/user/init.t
@@ -193,6 +193,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_initialize_executive
@example
 void rtems_initialize_executive(
  rtems_configuration_table *configuration_table,
@@ -256,6 +257,7 @@ with no intervening actions.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_initialize_executive_early
@example
 rtems_interrupt_level rtems_initialize_executive_early(
  rtems_configuration_table *configuration_table,
@@ -308,6 +310,7 @@ initialization sequences:
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_initialize_executive_late
@example
 void rtems_initialize_executive_late(
  rtems_interrupt_level  bsp_level
@@ -365,6 +368,7 @@ initialization sequences:
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_shutdown_executive
@example
 void rtems_shutdown_executive(
  rtems_unsigned32 result
--- a/doc/user/intr.t
+++ b/doc/user/intr.t
@@ -231,6 +231,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_interrupt_catch
@example
 rtems_status_code rtems_interrupt_catch(
  rtems_isr_entry      new_isr_handler,
@@ -274,6 +275,7 @@ This directive will not cause the calling task to be preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_interrupt_disable
@example
 void rtems_interrupt_disable(
  rtems_isr_level  level
@@ -314,6 +316,7 @@ parameter.}
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_interrupt_enable
@example
 void rtems_interrupt_enable(
  rtems_isr_level  level
@@ -353,6 +356,7 @@ This directive will not cause the calling task to be preempted.
@subheading CALLING SEQUENCE:

@ifset is-C 
+@c @findex rtems_interrupt_flash
@example
 void rtems_interrupt_flash(
  rtems_isr_level level
@@ -391,6 +395,7 @@ This directive will not cause the calling task to be preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_interrupt_is_in_progress
@example
 rtems_boolean rtems_interrupt_is_in_progress( void );
@end example
--- a/doc/user/io.t
+++ b/doc/user/io.t
@@ -203,6 +203,7 @@ status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_initialize
@example
 rtems_status_code rtems_io_initialize(
  rtems_device_major_number  major,
@@ -253,6 +254,7 @@ initialized.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_register_name
@example
 rtems_status_code rtems_io_register_name(
  char                      *name,
@@ -293,6 +295,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_lookup_name
@example
 rtems_status_code rtems_io_lookup_name(
  const char                *name,
@@ -331,6 +334,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_open
@example
 rtems_status_code rtems_io_open(
  rtems_device_major_number  major,
@@ -375,6 +379,7 @@ invoked.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_close
@example
 rtems_status_code rtems_io_close(
  rtems_device_major_number  major,
@@ -419,6 +424,7 @@ invoked.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_read
@example
 rtems_status_code rtems_io_read(
  rtems_device_major_number  major,
@@ -464,6 +470,7 @@ invoked.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_write
@example
 rtems_status_code rtems_io_write(
  rtems_device_major_number  major,
@@ -509,6 +516,7 @@ invoked.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_io_control
@example
 rtems_status_code rtems_io_control(
  rtems_device_major_number  major,
--- a/doc/user/mp.t
+++ b/doc/user/mp.t
@@ -560,6 +560,7 @@ status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_multiprocessing_announce
@example
 void rtems_multiprocessing_announce( void );
@end example
--- a/doc/user/msg.t
+++ b/doc/user/msg.t
@@ -217,6 +217,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_create
@example
 rtems_status_code rtems_message_queue_create(
  rtems_name        name,
@@ -302,6 +303,7 @@ configuration table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_ident
@example
 rtems_status_code rtems_message_queue_ident(
  rtems_name        name,
@@ -359,6 +361,7 @@ table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_delete
@example
 rtems_status_code rtems_message_queue_delete(
  rtems_id id
@@ -420,6 +423,7 @@ reclaimed when the message queue is deleted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_send
@example
 rtems_status_code rtems_message_queue_send(
  rtems_id           id,
@@ -478,6 +482,7 @@ proxy used to represent the task is reclaimed.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_urgent
@example
 rtems_status_code rtems_message_queue_urgent(
  rtems_id           id,
@@ -537,6 +542,7 @@ proxy used to represent the task is reclaimed.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_broadcast
@example
 rtems_status_code rtems_message_queue_broadcast(
  rtems_id           id,
@@ -600,6 +606,7 @@ proxy used to represent the task is reclaimed.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_receive
@example
 rtems_status_code rtems_message_queue_receive(
  rtems_id           id,
@@ -686,6 +693,7 @@ this directive.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_get_number_pending
@example
 rtems_status_code rtems_message_queue_get_number_pending(
  rtems_id          id,
@@ -728,6 +736,7 @@ the specified message queue.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_message_queue_flush
@example
 rtems_status_code rtems_message_queue_flush(
  rtems_id          id,
--- a/doc/user/part.t
+++ b/doc/user/part.t
@@ -129,6 +129,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_partition_create
@example
 rtems_status_code rtems_partition_create(
  rtems_name        name,
@@ -215,6 +216,7 @@ the Configuration Table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_partition_ident
@example
 rtems_status_code rtems_partition_ident(
  rtems_name        name,
@@ -272,6 +274,7 @@ table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_partition_delete
@example
 rtems_status_code rtems_partition_delete(
  rtems_id id
@@ -323,6 +326,7 @@ the partition was created with the @code{@value{RPREFIX}GLOBAL} option.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_partition_get_buffer
@example
 rtems_status_code rtems_partition_get_buffer(
  rtems_id   id,
@@ -371,6 +375,7 @@ remote node to allocate a buffer from the specified partition.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_partition_return_buffer
@example
 rtems_status_code rtems_partition_return_buffer(
  rtems_id  id,
--- a/doc/user/region.t
+++ b/doc/user/region.t
@@ -220,6 +220,7 @@ and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_create
@example
 rtems_status_code rtems_region_create(
  rtems_name        name,
@@ -298,6 +299,7 @@ by RTEMS:
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_ident
@example
 rtems_status_code rtems_region_ident(
  rtems_name  name,
@@ -340,6 +342,7 @@ This directive will not cause the running task to be preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_delete
@example
 rtems_status_code rtems_region_delete(
  rtems_id id
@@ -383,6 +386,7 @@ delete the region.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_extend
@example
 rtems_status_code rtems_region_extend(
  rtems_id            id,
@@ -428,6 +432,7 @@ extend the region.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_get_segment
@example
 rtems_status_code rtems_region_get_segment(
  rtems_id            id,
@@ -515,6 +520,7 @@ this directive.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_return_segment
@example
 rtems_status_code rtems_region_return_segment(
  rtems_id  id,
@@ -568,6 +574,7 @@ is less than or equal to the size of the segment returned.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_region_get_segment_size
@example
 rtems_status_code rtems_region_get_segment_size(
  rtems_id            id,
--- a/doc/user/rtmon.t
+++ b/doc/user/rtmon.t
@@ -834,6 +834,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_rate_monotonic_create
@example
 rtems_status_code rtems_rate_monotonic_create(
  rtems_name  name,
@@ -877,6 +878,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_rate_monotonic_ident
@example
 rtems_status_code rtems_rate_monotonic_ident(
  rtems_name  name,
@@ -919,6 +921,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_rate_monotonic_cancel
@example
 rtems_status_code rtems_rate_monotonic_cancel(
  rtems_id id
@@ -960,6 +963,7 @@ been created by the calling task.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_rate_monotonic_delete
@example
 rtems_status_code rtems_rate_monotonic_delete(
  rtems_id id
@@ -1000,6 +1004,7 @@ other than the task which created the period.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_rate_monotonic_period
@example
 rtems_status_code rtems_rate_monotonic_period(
  rtems_id       id,
@@ -1051,6 +1056,7 @@ This directive will not cause the running task to be preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_rate_monotonic_get_status
@example
 rtems_status_code rtems_rate_monotonic_get_status(
  rtems_id                            id,
--- a/doc/user/sem.t
+++ b/doc/user/sem.t
@@ -366,6 +366,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_semaphore_create
@example
 rtems_status_code rtems_semaphore_create(
  rtems_name           name,
@@ -467,6 +468,7 @@ the Configuration Table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_semaphore_ident
@example
 rtems_status_code rtems_semaphore_ident(
  rtems_name        name,
@@ -524,6 +526,7 @@ table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_semaphore_delete
@example
 rtems_status_code rtems_semaphore_delete(
  rtems_id id
@@ -582,6 +585,7 @@ reclaimed when the semaphore is deleted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_semaphore_obtain
@example
 rtems_status_code rtems_semaphore_obtain(
  rtems_id         id,
@@ -671,6 +675,7 @@ this directive.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_semaphore_release
@example
 rtems_status_code rtems_semaphore_release(
  rtems_id id
--- a/doc/user/signal.t
+++ b/doc/user/signal.t
@@ -236,6 +236,7 @@ and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_signal_catch
@example
 rtems_status_code rtems_signal_catch(
  rtems_asr_entry  asr_handler,
@@ -307,6 +308,7 @@ The following task mode constants are defined by RTEMS:
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_signal_send
@example
 rtems_status_code rtems_signal_send(
  rtems_id         id,
--- a/doc/user/task.t
+++ b/doc/user/task.t
@@ -598,6 +598,7 @@ status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_task_create
@example
 rtems_status_code rtems_task_create(
  rtems_name           name,
@@ -707,6 +708,7 @@ by the maximum_global_objects field in the Configuration Table.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_task_ident
@example
 rtems_status_code rtems_task_ident(
  rtems_name        name,
@@ -760,7 +762,9 @@ accesses only the local copy of the global object table.
@subsection TASK_START - Start a task

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_start
@example
 rtems_status_code rtems_task_start(
  rtems_id            id,
@@ -809,7 +813,9 @@ the @code{@value{DIRPREFIX}task_start} directive.
@subsection TASK_RESTART - Restart a task

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_restart
@example
 rtems_status_code rtems_task_restart(
  rtems_id            id,
@@ -870,7 +876,9 @@ created with the @code{@value{RPREFIX}GLOBAL} option.
@subsection TASK_DELETE - Delete a task

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_delete
@example
 rtems_status_code rtems_task_delete(
  rtems_id id
@@ -926,7 +934,9 @@ created with the @code{@value{RPREFIX}GLOBAL} option.
@subsection TASK_SUSPEND - Suspend a task

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_suspend
@example
 rtems_status_code rtems_task_suspend(
  rtems_id id
@@ -974,7 +984,9 @@ If the task specified by id is already suspended, then the
@subsection TASK_RESUME - Resume a task

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_resume
@example
 rtems_status_code rtems_task_resume(
  rtems_id id
@@ -1019,7 +1031,9 @@ If the task specified by id is not suspended, then the
@subsection TASK_SET_PRIORITY - Set task priority

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_set_priority
@example
 rtems_status_code rtems_task_set_priority(
  rtems_id             id,
@@ -1080,7 +1094,9 @@ binary semaphores.
@subsection TASK_MODE - Change current task's mode

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_mode
@example
 rtems_status_code rtems_task_mode(
  rtems_mode  mode_set,
@@ -1234,7 +1250,9 @@ mask constant is provided in the following table:
@subsection TASK_GET_NOTE - Get task notepad entry

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_get_note
@example
 rtems_status_code rtems_task_get_note(
  rtems_id          id,
@@ -1286,7 +1304,9 @@ the notepad entry of the specified task.
@subsection TASK_SET_NOTE - Set task notepad entry

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_set_note
@example
 rtems_status_code rtems_task_set_note(
  rtems_id         id,
@@ -1338,7 +1358,9 @@ node to set the specified notepad entry.
@subsection TASK_WAKE_AFTER - Wake up after interval

@subheading CALLING SEQUENCE:
+
@ifset is-C
+@c @findex rtems_task_wake_after
@example
 rtems_status_code rtems_task_wake_after(
  rtems_interval ticks
@@ -1384,6 +1406,7 @@ A clock tick is required to support the functionality of this directive.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_task_wake_when
@example
 rtems_status_code rtems_task_wake_when(
  rtems_time_of_day *time_buffer
--- a/doc/user/timer.t
+++ b/doc/user/timer.t
@@ -158,6 +158,7 @@ and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_create
@example
 rtems_status_code rtems_timer_create(
  rtems_name  name,
@@ -200,6 +201,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_ident
@example
 rtems_status_code rtems_timer_ident(
  rtems_name  name,
@@ -242,6 +244,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_cancel
@example
 rtems_status_code rtems_timer_cancel(
  rtems_id id
@@ -279,6 +282,7 @@ This directive will not cause the running task to be preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_delete
@example
 rtems_status_code rtems_timer_delete(
  rtems_id id
@@ -319,6 +323,7 @@ which created the timer.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_fire_after
@example
 rtems_status_code rtems_timer_fire_after(
  rtems_id                           id,
@@ -366,6 +371,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_fire_when
@example
 rtems_status_code rtems_timer_fire_when(
  rtems_id                           id,
@@ -414,6 +420,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_timer_reset
@example
 rtems_status_code rtems_timer_reset(
  rtems_id   id
--- a/doc/user/userext.t
+++ b/doc/user/userext.t
@@ -564,6 +564,7 @@ constants, usage, and status codes.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_extension_create
@example
 rtems_status_code rtems_extension_create(
  rtems_name              name,
@@ -609,6 +610,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_extension_ident
@example
 rtems_status_code rtems_extension_ident(
  rtems_name  name,
@@ -652,6 +654,7 @@ preempted.
@subheading CALLING SEQUENCE:

@ifset is-C
+@c @findex rtems_extension_delete
@example
 rtems_status_code rtems_extension_delete(
  rtems_id id