summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-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 351f121b10..e400486332 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-08-13 Joel Sherrill <joel.sherrilL@OARcorp.com>
PR 1674/docs
diff --git a/doc/user/datatypes.t b/doc/user/datatypes.t
index ec0fe5b3db..d856cc2332 100644
--- a/doc/user/datatypes.t
+++ b/doc/user/datatypes.t
@@ -226,7 +226,11 @@ on the target hardware.
This type is deprecated. Use "float" instead.
@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.