From b0ceb59bc49d6fb2cd7f63dabaec5ce62d320433 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 1 Nov 2010 15:58:26 +0000 Subject: 2010-11-01 Joel Sherrill PR 1714/doc * user/datatypes.t, user/part.t: Add missing description of rtems_status_codes. --- doc/ChangeLog | 6 ++++++ doc/user/datatypes.t | 6 +++++- doc/user/part.t | 6 +++--- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index c0a5fcdd71..537e1e60f8 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2010-11-01 Joel Sherrill + + PR 1714/doc + * user/datatypes.t, user/part.t: Add missing description of + rtems_status_codes. + 2009-07-02 Joel Sherrill * user/region.t: Fix typos where semaphore referenced instead of region 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. diff --git a/doc/user/part.t b/doc/user/part.t index e65cd44c38..9bc8ad3857 100644 --- a/doc/user/part.t +++ b/doc/user/part.t @@ -1,5 +1,5 @@ @c -@c COPYRIGHT (c) 1988-2008. +@c COPYRIGHT (c) 1988-2010. @c On-Line Applications Research Corporation (OAR). @c All rights reserved. @c @@ -83,8 +83,8 @@ RTEMS allocates a Partition Control Block (PTCB) from the PTCB free list. This data structure is used by RTEMS to manage the newly created partition. The number of buffers in the partition is calculated based upon the -specified partition length and buffer size, and returned to the -calling task along with a unique partition ID. +specified partition length and buffer size. If successful,the +unique partition ID is returned to the calling task. @subsection Obtaining Partition IDs -- cgit v1.2.3