summaryrefslogtreecommitdiffstats
path: root/doc/user
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1997-06-04 13:04:36 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1997-06-04 13:04:36 +0000
commit7e8a1fc9470db924bce49a4fce16ba98afbcf3fc (patch)
treecc6c9357d0d6bec974bfc5af38225b41a732b9ce /doc/user
parentcorrected name of test suite (diff)
downloadrtems-7e8a1fc9470db924bce49a4fce16ba98afbcf3fc.tar.bz2
final corrections before 4.1.0 documentation freeze.
Diffstat (limited to '')
-rw-r--r--doc/user/clock.t8
-rw-r--r--doc/user/conf.t10
-rw-r--r--doc/user/fatal.t2
-rw-r--r--doc/user/glossary.texi17
-rw-r--r--doc/user/intr.t8
-rw-r--r--doc/user/overview.t2
-rw-r--r--doc/user/rtmon.t2
-rw-r--r--doc/user/task.t2
-rw-r--r--doc/user/userext.t2
9 files changed, 26 insertions, 27 deletions
diff --git a/doc/user/clock.t b/doc/user/clock.t
index acc84796e9..78d25ab2b5 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -67,7 +67,7 @@ specified by the user in the Configuration Table.
The clock facilities of the clock manager operate
upon calendar time. These directives utilize the following date
-and time structure for the native time and date format:
+and time @value{STRUCTURE} for the native time and date format:
@ifset is-C
@example
@@ -106,7 +106,7 @@ supported when setting the system date and time using the
clock_get directive. Some applications expect to operate on a
"UNIX-style" date and time data structure. The clock_get
directive can optionally return the current date and time in the
-following structure:
+following @value{STRUCTURE}:
@ifset is-C
@example
@@ -129,7 +129,7 @@ type Clock_Time_Value is
@end example
@end ifset
-The seconds field in this structure is the number of
+The seconds field in this @value{STRUCTURE} is the number of
seconds since the RTEMS epoch of January 1, 1988.
@ifinfo
@@ -306,7 +306,7 @@ procedure Clock_Set (
@subheading DESCRIPTION:
This directive sets the system date and time. The
-date, time, and ticks in the time_buffer structure are all
+date, time, and ticks in the time_buffer @value{STRUCTURE} are all
range-checked, and an error is returned if any one is out of its
valid range.
diff --git a/doc/user/conf.t b/doc/user/conf.t
index 1412c3c849..7eb1ce67bc 100644
--- a/doc/user/conf.t
+++ b/doc/user/conf.t
@@ -333,7 +333,7 @@ initialization threads must be configured.
is the address of the Initialization Threads Table. This table contains the
information needed to create and start each of the initialization threads.
The format of each entry in this table is defined in the
-posix_initialization_threads_table structure.
+posix_initialization_threads_table @value{STRUCTURE}.
@end table
@@ -363,8 +363,8 @@ data structure directly correspond to arguments to the
task_create and task_start directives. The number of entries is
found in the number_of_initialization_tasks entry in the
Configuration Table. The format of each entry in the
-Initialization Task Table is defined in the following C
-structure:
+Initialization Task Table is defined in the following @value{LANGUAGE}
+@value{STRUCTURE}:
@ifset is-C
@example
@@ -581,8 +581,8 @@ contains one entry for each possible extension. The entries are
called at critical times in the life of the system and
individual tasks. The application may create dynamic extensions
in addition to this single static set. The format of each entry
-in the User Extensions Table is defined in the following C
-structure:
+in the User Extensions Table is defined in the following @value{LANGUAGE}
+@value{STRUCTURE}:
typedef User_extensions_routine rtems_extension;
typedef User_extensions_thread_create_extension rtems_task_create_extension;
diff --git a/doc/user/fatal.t b/doc/user/fatal.t
index 8d319ad42d..9e08b83f6b 100644
--- a/doc/user/fatal.t
+++ b/doc/user/fatal.t
@@ -90,7 +90,7 @@ The fatal_error_occurred directive is invoked when a
fatal error is detected. Before invoking any user-supplied
fatal error handlers or the RTEMS fatal error handler, the
fatal_error_occurred directive stores useful information in the
-variable @code{_Internal_errors_What_happened}. This structure
+variable @code{_Internal_errors_What_happened}. This @value{STRUCTURE}
contains three pieces of information:
@itemize @bullet
diff --git a/doc/user/glossary.texi b/doc/user/glossary.texi
index 58b57061f0..682cb32c2b 100644
--- a/doc/user/glossary.texi
+++ b/doc/user/glossary.texi
@@ -211,8 +211,7 @@ the memory.
An acronym for First In First Out.
@item First In First Out
-A discipline for manipulating
-entries in a data structure.
+A discipline for manipulating entries in a data structure.
@item floating point coprocessor
A component used in
@@ -247,12 +246,10 @@ A data structure used to dynamically allocate
and deallocate variable sized blocks of memory.
@item heterogeneous
-A multiprocessor computer system
-composed of dissimilar processors.
+A multiprocessor computer system composed of dissimilar processors.
@item homogeneous
-A multiprocessor computer system
-composed of a single type of processor.
+A multiprocessor computer system composed of a single type of processor.
@item ID
An RTEMS assigned identification tag used to
@@ -350,9 +347,8 @@ and communicate between tasks by transporting messages between
sending and receiving tasks.
@item Message Queue Control Block
-A data structure
-associated with each message queue used by RTEMS to manage that
-message queue.
+A data structure associated with each message queue used by RTEMS
+to manage that message queue.
@item minor number
A numeric value passed to a device
@@ -382,8 +378,7 @@ of user-provided routines which enable the nodes in a
multiprocessor system to communicate with one another.
@item Multiprocessor Configuration Table
-The data
-structure defining the characteristics of the multiprocessor
+The data structure defining the characteristics of the multiprocessor
target system with which RTEMS will communicate.
@item multitasking
diff --git a/doc/user/intr.t b/doc/user/intr.t
index d2226df3f6..b118f3e70b 100644
--- a/doc/user/intr.t
+++ b/doc/user/intr.t
@@ -33,6 +33,10 @@ directive:
@itemize @bullet
@item @code{interrupt_catch} - Establish an ISR
+@item @code{interrupt_disable} - Disable Interrupts
+@item @code{interrupt_enable} - Enable Interrupts
+@item @code{interrupt_flash} - Flash Interrupt
+@item @code{interrupt_is_in_progress} - Is an ISR in Progress
@end itemize
@ifinfo
@@ -315,9 +319,9 @@ procedure Interrupt_Catch (
This directive establishes an interrupt service
routine (ISR) for the specified interrupt vector number. The
-new_isr_handler parameter specifies the entry point of the ISR.
+@code{new_isr_handler} parameter specifies the entry point of the ISR.
The entry point of the previous ISR for the specified vector is
-returned in old_isr_handler.
+returned in @code{old_isr_handler}.
@subheading NOTES:
diff --git a/doc/user/overview.t b/doc/user/overview.t
index 8ec1675e6f..51821e6da6 100644
--- a/doc/user/overview.t
+++ b/doc/user/overview.t
@@ -437,7 +437,7 @@ names are printed in bold type.
@item Items in bold capital letters are constants defined by
RTEMS. Each language interface provided by RTEMS includes a
file containing the standard set of constants, data types, and
-structure definitions which can be incorporated into the user
+@value{STRUCTURE} definitions which can be incorporated into the user
application.
@item A number of type definitions are provided by RTEMS and
diff --git a/doc/user/rtmon.t b/doc/user/rtmon.t
index 086c572a3a..771b3f3e94 100644
--- a/doc/user/rtmon.t
+++ b/doc/user/rtmon.t
@@ -1194,7 +1194,7 @@ procedure Rate_Monotonic_Get_Status (
@subheading DESCRIPTION:
This directive returns status information associated with
-the rate monotonic period id in the following data structure:
+the rate monotonic period id in the following data @value{STRUCTURE}:
@ifset is-C
@example
diff --git a/doc/user/task.t b/doc/user/task.t
index a7c729872c..791a6a5d3f 100644
--- a/doc/user/task.t
+++ b/doc/user/task.t
@@ -1483,5 +1483,5 @@ in time_buffer. At the requested date and time, the calling
task will be unblocked and made ready to execute.
@subheading NOTES:
-The ticks portion of time_buffer structure is ignored. The
+The ticks portion of time_buffer @value{STRUCTURE} is ignored. The
timing granularity of this directive is a second.
diff --git a/doc/user/userext.t b/doc/user/userext.t
index dc49b03e65..06eaba7f86 100644
--- a/doc/user/userext.t
+++ b/doc/user/userext.t
@@ -85,7 +85,7 @@ user extension routines are invoked. Together a set of these
routines typically perform a specific functionality such as
performance monitoring or debugger support. RTEMS is informed of
the entry points which constitute an extension set via the
-following structure:
+following @value{STRUCTURE}:
@ifset is-C
@example