diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ada_user/example.texi | 2 | ||||
-rw-r--r-- | doc/user/Makefile.am | 2 | ||||
-rw-r--r-- | doc/user/dirstat.t | 13 | ||||
-rw-r--r-- | doc/user/example.texi | 2 | ||||
-rw-r--r-- | doc/user/fatal.t | 22 |
5 files changed, 21 insertions, 20 deletions
diff --git a/doc/ada_user/example.texi b/doc/ada_user/example.texi index 90b1b12f72..697d1e0153 100644 --- a/doc/ada_user/example.texi +++ b/doc/ada_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, 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/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. |