diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2014-02-05 17:00:09 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2014-02-06 08:47:02 +0100 |
commit | 920a43e6392dfe60ad8bf4bcce73fd1c97d6aa5a (patch) | |
tree | 1b4757300bc435e408078ff0588a8d2e73fe76ae /doc/user | |
parent | score: _CPU_Context_switch_to_first_task_smp() (diff) | |
download | rtems-920a43e6392dfe60ad8bf4bcce73fd1c97d6aa5a.tar.bz2 |
rtems: Add rtems_status_code_description()
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/Makefile.am | 11 | ||||
-rw-r--r-- | doc/user/dirstat.t (renamed from doc/user/dirstat.texi) | 29 | ||||
-rw-r--r-- | doc/user/example.texi | 2 |
3 files changed, 37 insertions, 5 deletions
diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index 7992b29005..1b6ddcb7e4 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -8,14 +8,14 @@ PROJECT = c_user include $(top_srcdir)/project.am include $(top_srcdir)/main.am -FILES = bsp.texi dirstat.texi example.texi glossary.texi preface.texi +FILES = bsp.texi example.texi glossary.texi preface.texi GENERATED_FILES = overview.texi concepts.texi datatypes.texi init.texi \ task.texi intr.texi clock.texi timer.texi sem.texi msg.texi event.texi \ signal.texi part.texi region.texi dpmem.texi io.texi fatal.texi \ schedule.texi rtmon.texi barrier.texi bsp.texi userext.texi conf.texi \ mp.texi stackchk.texi cpuuse.texi object.texi chains.texi timespec.texi \ - cbs.texi + cbs.texi dirstat.texi COMMON_FILES += $(top_srcdir)/common/cpright.texi @@ -193,10 +193,15 @@ cbs.texi: cbs.t -u "Top" \ -n "Directive Status Codes" < $< > $@ +dirstat.texi: dirstat.t + $(BMENU2) -p "Constant Bandwidth Server Scheduler API CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time" \ + -u "Top" \ + -n "Example Application" < $< > $@ + EXTRA_DIST = bsp.t cbs.t clock.t chains.t concepts.t cpuuse.t datatypes.t conf.t \ dpmem.t event.t fatal.t init.t intr.t io.t mp.t msg.t overview.t \ part.t region.t rtmon.t sem.t schedule.t signal.t stackchk.t \ - task.t timer.t userext.t $(TXT_FILES) $(PNG_FILES) $(EPS_IMAGES) \ + task.t timer.t userext.t dirstat.t $(TXT_FILES) $(PNG_FILES) $(EPS_IMAGES) \ $(noinst_DATA) CLEANFILES += c_user.info c_user.info-? c_user.info-?? diff --git a/doc/user/dirstat.texi b/doc/user/dirstat.t index 17a7edd90e..adb675d613 100644 --- a/doc/user/dirstat.texi +++ b/doc/user/dirstat.t @@ -3,8 +3,10 @@ @c On-Line Applications Research Corporation (OAR). @c All rights reserved. -@node Directive Status Codes, Example Application, Constant Bandwidth Server Scheduler API CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time, Top @chapter Directive Status Codes + +@section Introduction + @table @b @item @code{@value{RPREFIX}SUCCESSFUL} - successful completion @item @code{@value{RPREFIX}TASK_EXITTED} - returned from a task @@ -35,3 +37,28 @@ @item @code{@value{RPREFIX}NO_MEMORY} - could not get enough memory @end table +@section Directives + +@page +@subsection STATUS_CODE_DESCRIPTION - Returns a description for a status code + +@cindex fatal error + +@subheading CALLING SEQUENCE: + +@ifset is-C +@findex rtems_status_code_description +@example +const char *rtems_status_code_description( + rtems_status_code code +); +@end example +@end ifset + +@subheading DIRECTIVE STATUS CODES + +The status code description or "?" in case the passed status code is invalid. + +@subheading DESCRIPTION: + +Returns a description for a status code. diff --git a/doc/user/example.texi b/doc/user/example.texi index f95868e88e..71a71ab015 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, Top +@node Example Application, Glossary, Directive Status Codes STATUS_CODE_DESCRIPTION - Returns a description for a status code, Top @chapter Example Application @example |