summaryrefslogtreecommitdiffstats
path: root/doc/user/dirstat.t
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2014-02-07 09:53:47 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2014-02-12 09:18:00 +0100
commitbab16de2671cc5b35e3df9b343e8645b632e3b1d (patch)
treef397b31d5a5c2f87e5c3aee69f6cfb39738f7ac2 /doc/user/dirstat.t
parentsparc: Save/restore only non-volatile context (diff)
downloadrtems-bab16de2671cc5b35e3df9b343e8645b632e3b1d.tar.bz2
score: Change debug helper functions
Rename rtems_internal_error_description() to rtems_internal_error_text(). Rename rtems_fatal_source_description() to rtems_fatal_source_text(). Rename rtems_status_code_description() to rtems_status_text(). Remove previous implementation of rtems_status_text().
Diffstat (limited to 'doc/user/dirstat.t')
-rw-r--r--doc/user/dirstat.t13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/user/dirstat.t b/doc/user/dirstat.t
index adb675d613..4d51e2e5e6 100644
--- a/doc/user/dirstat.t
+++ b/doc/user/dirstat.t
@@ -40,16 +40,14 @@
@section Directives
@page
-@subsection STATUS_CODE_DESCRIPTION - Returns a description for a status code
-
-@cindex fatal error
+@subsection STATUS_TEXT - Returns a text for a status code
@subheading CALLING SEQUENCE:
@ifset is-C
-@findex rtems_status_code_description
+@findex rtems_status_text
@example
-const char *rtems_status_code_description(
+const char *rtems_status_text(
rtems_status_code code
);
@end example
@@ -57,8 +55,9 @@ const char *rtems_status_code_description(
@subheading DIRECTIVE STATUS CODES
-The status code description or "?" in case the passed status code is invalid.
+The status code text or "?" in case the passed status code is invalid.
@subheading DESCRIPTION:
-Returns a description for a status code.
+Returns a text for a status code. The text for each status code is the
+enumerator constant.