summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2010-11-01 15:58:33 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2010-11-01 15:58:33 +0000
commit327218a24f5f4cc93ed6b84143c620f03cff7f64 (patch)
tree5813f9b4a7c4632fae5d5a781ee63ddc2a41c631
parentb5b69605864f7afdb6b9df93beca0fb3eb35f5a0 (diff)
2010-11-01 Joel Sherrill <joel.sherrilL@OARcorp.com>
PR 1714/doc * user/datatypes.t: Add missing description of rtems_status_codes.
-rw-r--r--doc/ChangeLog5
-rw-r--r--doc/user/datatypes.t6
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 8e2c0814ea..fad06904bd 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2010-11-01 Joel Sherrill <joel.sherrilL@OARcorp.com>
+
+ PR 1714/doc
+ * user/datatypes.t: Add missing description of rtems_status_codes.
+
2010-05-18 Joel Sherrill <joel.sherrilL@OARcorp.com>
PR 1520/doc
diff --git a/doc/user/datatypes.t b/doc/user/datatypes.t
index 6f3e6e7ac7..45e14f2431 100644
--- a/doc/user/datatypes.t
+++ b/doc/user/datatypes.t
@@ -224,7 +224,11 @@ type that corresponds to single precision floating point
on the target hardware.
@findex rtems_status_codes
-@item @code{@value{DIRPREFIX}status_codes} is the
+@item @code{@value{DIRPREFIX}status_codes} is the return type for most
+RTEMS services. This is an enumerated type of approximately twenty-five
+values. In general, when a service returns a particular status code, it
+indicates that a very specific error condition has occurred.
+
@findex rtems_task
@item @code{@value{DIRPREFIX}task} is the return type for an
RTEMS Task.