diff options
| author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2014-03-10 09:47:06 -0500 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2014-03-11 19:04:06 -0500 |
| commit | 2aeeaa00f915a4c11144441081e68333d6b99227 (patch) | |
| tree | bc133fc98629efd1b0c503a0fec174a20974623e /doc/user/dirstat.t | |
| parent | smp.t: Add Background and Operation Sections (diff) | |
| download | rtems-2aeeaa00f915a4c11144441081e68333d6b99227.tar.bz2 | |
doc: Improve description of rtems_status_text for ToC
Diffstat (limited to 'doc/user/dirstat.t')
| -rw-r--r-- | doc/user/dirstat.t | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/user/dirstat.t b/doc/user/dirstat.t index 4d51e2e5e6..d9cf77e101 100644 --- a/doc/user/dirstat.t +++ b/doc/user/dirstat.t @@ -40,7 +40,7 @@ @section Directives @page -@subsection STATUS_TEXT - Returns a text for a status code +@subsection STATUS_TEXT - Returns the enumeration name for a status code @subheading CALLING SEQUENCE: @@ -55,9 +55,8 @@ const char *rtems_status_text( @subheading DIRECTIVE STATUS CODES -The status code text or "?" in case the passed status code is invalid. +The status code enumeration name or "?" in case the status code is invalid. @subheading DESCRIPTION: -Returns a text for a status code. The text for each status code is the -enumerator constant. +Returns the enumeration name for the specified status code. |