From 920a43e6392dfe60ad8bf4bcce73fd1c97d6aa5a Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 5 Feb 2014 17:00:09 +0100 Subject: rtems: Add rtems_status_code_description() --- doc/user/Makefile.am | 11 ++++++--- doc/user/dirstat.t | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/user/dirstat.texi | 37 ----------------------------- doc/user/example.texi | 2 +- 4 files changed, 73 insertions(+), 41 deletions(-) create mode 100644 doc/user/dirstat.t delete mode 100644 doc/user/dirstat.texi (limited to 'doc') 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.t b/doc/user/dirstat.t new file mode 100644 index 0000000000..adb675d613 --- /dev/null +++ b/doc/user/dirstat.t @@ -0,0 +1,64 @@ +@c +@c COPYRIGHT (c) 1989-2011. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. + +@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 +@item @code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured +@item @code{@value{RPREFIX}INVALID_NAME} - invalid object name +@item @code{@value{RPREFIX}INVALID_ID} - invalid object id +@item @code{@value{RPREFIX}TOO_MANY} - too many +@item @code{@value{RPREFIX}TIMEOUT} - timed out waiting +@item @code{@value{RPREFIX}OBJECT_WAS_DELETED} - object was deleted while waiting +@item @code{@value{RPREFIX}INVALID_SIZE} - invalid specified size +@item @code{@value{RPREFIX}INVALID_ADDRESS} - invalid address specified +@item @code{@value{RPREFIX}INVALID_NUMBER} - number was invalid +@item @code{@value{RPREFIX}NOT_DEFINED} - item not initialized +@item @code{@value{RPREFIX}RESOURCE_IN_USE} - resources outstanding +@item @code{@value{RPREFIX}UNSATISFIED} - request not satisfied +@item @code{@value{RPREFIX}INCORRECT_STATE} - task is in wrong state +@item @code{@value{RPREFIX}ALREADY_SUSPENDED} - task already in state +@item @code{@value{RPREFIX}ILLEGAL_ON_SELF} - illegal for calling task +@item @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object +@item @code{@value{RPREFIX}CALLED_FROM_ISR} - invalid environment +@item @code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority +@item @code{@value{RPREFIX}INVALID_CLOCK} - invalid time buffer +@item @code{@value{RPREFIX}INVALID_NODE} - invalid node id +@item @code{@value{RPREFIX}NOT_CONFIGURED} - directive not configured +@item @code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - not owner of resource +@item @code{@value{RPREFIX}NOT_IMPLEMENTED} - directive not implemented +@item @code{@value{RPREFIX}INTERNAL_ERROR} - RTEMS inconsistency detected +@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/dirstat.texi b/doc/user/dirstat.texi deleted file mode 100644 index 17a7edd90e..0000000000 --- a/doc/user/dirstat.texi +++ /dev/null @@ -1,37 +0,0 @@ -@c -@c COPYRIGHT (c) 1989-2011. -@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 -@table @b -@item @code{@value{RPREFIX}SUCCESSFUL} - successful completion -@item @code{@value{RPREFIX}TASK_EXITTED} - returned from a task -@item @code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured -@item @code{@value{RPREFIX}INVALID_NAME} - invalid object name -@item @code{@value{RPREFIX}INVALID_ID} - invalid object id -@item @code{@value{RPREFIX}TOO_MANY} - too many -@item @code{@value{RPREFIX}TIMEOUT} - timed out waiting -@item @code{@value{RPREFIX}OBJECT_WAS_DELETED} - object was deleted while waiting -@item @code{@value{RPREFIX}INVALID_SIZE} - invalid specified size -@item @code{@value{RPREFIX}INVALID_ADDRESS} - invalid address specified -@item @code{@value{RPREFIX}INVALID_NUMBER} - number was invalid -@item @code{@value{RPREFIX}NOT_DEFINED} - item not initialized -@item @code{@value{RPREFIX}RESOURCE_IN_USE} - resources outstanding -@item @code{@value{RPREFIX}UNSATISFIED} - request not satisfied -@item @code{@value{RPREFIX}INCORRECT_STATE} - task is in wrong state -@item @code{@value{RPREFIX}ALREADY_SUSPENDED} - task already in state -@item @code{@value{RPREFIX}ILLEGAL_ON_SELF} - illegal for calling task -@item @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object -@item @code{@value{RPREFIX}CALLED_FROM_ISR} - invalid environment -@item @code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority -@item @code{@value{RPREFIX}INVALID_CLOCK} - invalid time buffer -@item @code{@value{RPREFIX}INVALID_NODE} - invalid node id -@item @code{@value{RPREFIX}NOT_CONFIGURED} - directive not configured -@item @code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - not owner of resource -@item @code{@value{RPREFIX}NOT_IMPLEMENTED} - directive not implemented -@item @code{@value{RPREFIX}INTERNAL_ERROR} - RTEMS inconsistency detected -@item @code{@value{RPREFIX}NO_MEMORY} - could not get enough memory -@end table - 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 -- cgit v1.2.3