Changeset d4696eb in rtems


Ignore:
Timestamp:
Jun 28, 2002, 1:57:18 PM (18 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
b43314a
Parents:
dda0bffc
Message:

2002-06-28 Joel Sherrill <joel@…>

  • userext.t: Per PR228, correct the prototype of the task create user extension to indicate it returns a boolean and augment the documentation to explain the purpose of the boolean return value.
Location:
doc/user
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/user/ChangeLog

    rdda0bffc rd4696eb  
     12002-06-28      Joel Sherrill <joel@OARcorp.com>
     2
     3        * userext.t: Per PR228, correct the prototype of the task create
     4        user extension to indicate it returns a boolean and augment the
     5        documentation to explain the purpose of the boolean return value.
     6
    172002-04-12      Chris Johns <ccj@acm.org>
    28
  • doc/user/userext.t

    rdda0bffc rd4696eb  
    200200
    201201The TASK_CREATE extension directly corresponds to the
    202 task_create directive.  If this extension is defined in any
     202@code{@value{DIRPREFIX}task_create} directive.  If this extension
     203is defined in any
    203204static or dynamic extension set and a task is being created,
    204205then the extension routine will automatically be invoked by
     
    210211@ifset is-C
    211212@example
    212 rtems_extension user_task_create(
     213boolean user_task_create(
    213214  rtems_tcb *current_task,
    214215  rtems_tcb *new_task
     
    219220@ifset is-Ada
    220221@example
    221 procedure User_Task_Create (
     222function User_Task_Create (
    222223   Current_Task : in     RTEMS.TCB_Pointer;
    223224   New_Task     : in     RTEMS.TCB_Pointer
    224 );
    225 @end example
    226 @end ifset
    227 
    228 where current_task can be used to access the TCB for
     225) returns Boolean;
     226@end example
     227@end ifset
     228
     229where @code{current_task} can be used to access the TCB for
    229230the currently executing task, and new_task can be used to access
    230231the TCB for the new task being created.  This extension is
    231 invoked from the task_create directive after new_task has been
     232invoked from the @code{@value{DIRPREFIX}task_create}
     233directive after @code{new_task} has been
    232234completely initialized, but before it is placed on a ready TCB
    233235chain.
     236
     237The user extension is expected to return the boolean
     238value @code{TRUE} if it successfully executed and
     239@code{FALSE} otherwise.  A task create user extension
     240will frequently attempt to allocate resources.  If this
     241allocation fails, then the extension should return
     242@code{FALSE} and the entire task create operation
     243will fail.
    234244
    235245@subsubsection TASK_START Extension
Note: See TracChangeset for help on using the changeset viewer.