diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2013-01-07 16:01:45 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2013-01-07 16:08:19 +0100 |
commit | f2f39b62a284afefbf8f1840255602162a9b2a01 (patch) | |
tree | 389db5d1428bf56ae63477aa632ed735e3d5a2a5 /doc | |
parent | bsp/lpc24xx: Declare conditionally (diff) | |
download | rtems-f2f39b62a284afefbf8f1840255602162a9b2a01.tar.bz2 |
sapi: Add rtems_fatal_source_description()
Diffstat (limited to 'doc')
-rw-r--r-- | doc/user/fatal.t | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/user/fatal.t b/doc/user/fatal.t index 1b725e89f4..20faa642ba 100644 --- a/doc/user/fatal.t +++ b/doc/user/fatal.t @@ -230,6 +230,33 @@ Prints the exception frame via printk(). @c @c @page +@subsection FATAL_SOURCE_DESCRIPTION - Returns a description for a fatal source + +@cindex fatal error + +@subheading CALLING SEQUENCE: + +@ifset is-C +@findex rtems_fatal_source_description +@example +const char *rtems_fatal_source_description( + rtems_fatal_source source +); +@end example +@end ifset + +@subheading DIRECTIVE STATUS CODES + +The fatal source description or "?" in case the passed fatal source is invalid. + +@subheading DESCRIPTION: + +Returns a description for a fatal source. + +@c +@c +@c +@page @subsection INTERNAL_ERROR_DESCRIPTION - Returns a description for an internal error code @cindex fatal error |