diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2014-02-07 09:53:47 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2014-02-12 09:18:00 +0100 |
commit | bab16de2671cc5b35e3df9b343e8645b632e3b1d (patch) | |
tree | f397b31d5a5c2f87e5c3aee69f6cfb39738f7ac2 /doc/user/fatal.t | |
parent | sparc: Save/restore only non-volatile context (diff) | |
download | rtems-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 '')
-rw-r--r-- | doc/user/fatal.t | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/user/fatal.t b/doc/user/fatal.t index 20faa642ba..61e5261c9b 100644 --- a/doc/user/fatal.t +++ b/doc/user/fatal.t @@ -230,16 +230,16 @@ Prints the exception frame via printk(). @c @c @page -@subsection FATAL_SOURCE_DESCRIPTION - Returns a description for a fatal source +@subsection FATAL_SOURCE_TEXT - Returns a text for a fatal source @cindex fatal error @subheading CALLING SEQUENCE: @ifset is-C -@findex rtems_fatal_source_description +@findex rtems_fatal_source_text @example -const char *rtems_fatal_source_description( +const char *rtems_fatal_source_text( rtems_fatal_source source ); @end example @@ -247,26 +247,27 @@ const char *rtems_fatal_source_description( @subheading DIRECTIVE STATUS CODES -The fatal source description or "?" in case the passed fatal source is invalid. +The fatal source text or "?" in case the passed fatal source is invalid. @subheading DESCRIPTION: -Returns a description for a fatal source. +Returns a text for a fatal source. The text for fatal source is the enumerator +constant. @c @c @c @page -@subsection INTERNAL_ERROR_DESCRIPTION - Returns a description for an internal error code +@subsection INTERNAL_ERROR_TEXT - Returns a text for an internal error code @cindex fatal error @subheading CALLING SEQUENCE: @ifset is-C -@findex rtems_internal_error_description +@findex rtems_internal_error_text @example -const char *rtems_internal_error_description( +const char *rtems_internal_error_text( rtems_fatal_code error ); @end example @@ -274,8 +275,9 @@ const char *rtems_internal_error_description( @subheading DIRECTIVE STATUS CODES -The error code description or "?" in case the passed error code is invalid. +The error code text or "?" in case the passed error code is invalid. @subheading DESCRIPTION: -Returns a description for an internal error code. +Returns a text for an internal error code. The text for each internal error +code is the enumerator constant. |