summaryrefslogtreecommitdiffstats
path: root/doc/user
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
parent97cf623d4ada641b0a59321f0e75a6b323ecf193 (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 '')
-rw-r--r--doc/user/Makefile.am2
-rw-r--r--doc/user/dirstat.t13
-rw-r--r--doc/user/example.texi2
-rw-r--r--doc/user/fatal.t22
4 files changed, 20 insertions, 19 deletions
diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am
index 1b6ddcb7e4..eec627a882 100644
--- a/doc/user/Makefile.am
+++ b/doc/user/Makefile.am
@@ -144,7 +144,7 @@ fatal.texi: fatal.t
-n "Board Support Packages" < $< > $@
bsp.texi: bsp.t
- $(BMENU2) -p "Fatal Error Manager INTERNAL_ERROR_DESCRIPTION - Returns a description for an internal error code" \
+ $(BMENU2) -p "Fatal Error Manager INTERNAL_ERROR_TEXT - Returns a text for an internal error code" \
-u "Top" \
-n "User Extensions Manager" < $< > $@
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.
diff --git a/doc/user/example.texi b/doc/user/example.texi
index 71a71ab015..00923c014b 100644
--- a/doc/user/example.texi
+++ b/doc/user/example.texi
@@ -3,7 +3,7 @@
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
-@node Example Application, Glossary, Directive Status Codes STATUS_CODE_DESCRIPTION - Returns a description for a status code, Top
+@node Example Application, Glossary, Directive Status Codes STATUS_TEXT - Returns a text for a status code, Top
@chapter Example Application
@example
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.