Changeset 3e9b621 in rtems


Ignore:
Timestamp:
Nov 20, 2008, 9:13:03 PM (11 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, master
Children:
4aec1cf
Parents:
db03bcc1
Message:

2008-11-20 Joel Sherrill <joel.sherrill@…>

PR 1340/cpukit

  • user/chains.t: Add rtems_chain_initialize to public chain API.
Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    rdb03bcc1 r3e9b621  
     12008-11-20      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        PR 1340/cpukit
     4        * user/chains.t: Add rtems_chain_initialize to public chain API.
     5
    162008-11-20      Joel Sherrill <joel.sherrill@OARcorp.com>
    27
  • doc/user/chains.t

    rdb03bcc1 r3e9b621  
    2222@item @code{@value{DIRPREFIX}chain_node} - Chain node used in user objects
    2323@item @code{@value{DIRPREFIX}chain_control} - Chain control node
     24@item @code{@value{DIRPREFIX}chain_initialize} - initialize the chain with nodes
    2425@item @code{@value{DIRPREFIX}chain_initialize_empty} - initialize the chain as empty
    2526@item @code{@value{DIRPREFIX}chain_is_null_node} - Is the node NULL ?
     
    197198
    198199@c
     200@c Initialize this Chain With Nodes
     201@c
     202@page
     203@subsection Initialize Chain With Nodes
     204
     205@cindex chain initialize
     206
     207@subheading CALLING SEQUENCE:
     208
     209@ifset is-C
     210@findex @value{DIRPREFIX}chain_initialize
     211@example
     212void @value{DIRPREFIX}chain_initialize(
     213  @value{DIRPREFIX}chain_control *the_chain,
     214  void                *starting_address,
     215  size_t               number_nodes,
     216  size_t               node_size
     217)
     218@end example
     219@end ifset
     220
     221@subheading RETURNS
     222
     223Returns nothing.
     224
     225@subheading DESCRIPTION:
     226
     227This function take in a pointer to a chain control and initializes it
     228to contain a set of chain nodes.  The chain will contain @code{number_nodes}
     229chain nodes from the memory pointed to by @code{start_address}.  Each node
     230is assumed to be @code{node_size} bytes.
     231
     232@subheading NOTES:
     233
     234This call will discard any nodes on the chain.
     235
     236This call does NOT inititialize any user data on each node.
     237
     238@c
    199239@c Initialize this Chain as Empty
    200240@c
    201241@page
    202 @subsection Initialise Empty
    203 
    204 @cindex chain initialise empty
     242@subsection Initialize Empty
     243
     244@cindex chain initialize empty
    205245
    206246@subheading CALLING SEQUENCE:
Note: See TracChangeset for help on using the changeset viewer.