Changeset 6c455f37 in rtems


Ignore:
Timestamp:
Sep 16, 1998, 3:15:41 PM (21 years ago)
Author:
Wade A Smith <warm38@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
6bd0fe4
Parents:
433c5585
Message:

Remove many of the shall verbs and replaced them with present tense verbs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/confspace.t

    r433c5585 r6c455f37  
    123123The @code{cfg_mount} function maps a configuration space defined
    124124by the file identified by the the @code{file} argument.  The
    125 distinguished node of the mapped configuration space shall be
     125distinguished node of the mapped configuration space is
    126126mounted in the active space at the point identified by the
    127127@code{cfgpath} configuration pathname.
    128128
    129129The @code{notification} argument specifies how changes to the
    130 mapped configuration space shall be communicated to the application.
    131 If the @code{notification} argument is NULL, no notification shall
     130mapped configuration space are communicated to the application.
     131If the @code{notification} argument is NULL, no notification will be
    132132be performed for the mapped configuration space.  If the Event
    133133Logging option is defined, the notification argument defines the
    134 facility to which changes in the mapped configuration space shall
    135 be logged.  Otherwise, the @code{notification} argument shall
    136 specify an implementation defined method of notifying the application
     134facility to which changes in the mapped configuration space are
     135logged.  Otherwise, the @code{notification} argument specifies
     136an implementation defined method of notifying the application
    137137of changes to the mapped configuration space.
    138138
     
    274274
    275275The @code{cfg_mknod} function creates a new node in the configuration
    276 space which contains the pathname prefix of @code{cfgpath}.  T he node
    277 name shall be defined by the pathname suffix of @code{cfgpath}.  The
    278 node name shall be defined by the pathname suffix of @code{cfgpath}.
    279 The node permissions shall be specified by the value of @code{mode}.
    280 The node type shall be specified by the value of @code{type}.
     276space which contains the pathname prefix of @code{cfgpath}.  The node
     277name is defined by the pathname suffix of @code{cfgpath}. The node
     278permissions are specified by the value of @code{mode}.  The node type
     279is specified by the value of @code{type}.
    281280
    282281@subheading NOTES:
     
    476475
    477476The @code{src} and @code{dest}arguments point to pathnames which
    478 name existing nodes.  The @code{cfg_link} function shall atomically
    479 create a link between specified nodes, and increment by one the link
    480 count of the node specified by the @code{src} argument.
    481 
    482 If the @code{cfg_link} function fails, no link shall be created, and
    483 the link count of the node shall remain unchanged by this function
    484 call.
     477name existing nodes.  The @code{cfg_link} function atomically creates
     478a link between specified nodes, and increment by one the link count
     479of the node specified by the @code{src} argument.
     480
     481If the @code{cfg_link} function fails, no link is created, and the
     482link count of the node remains unchanged by this function call.
    485483
    486484This implementation may require that the calling process has permission
     
    561559The @code{cfg_unlink} function removes the link between the node
    562560specified by the @code{cfgpath} path prefix and the parent node
    563 specified by @code{cfgpath}, and shall decrement the link count
     561specified by @code{cfgpath}, and decrements the link count
    564562of the @code{cfgpath} node.
    565563
    566564When the link count of the node becomes zero, the space occupied
    567 by the node shall be freed and the node shall no longer be accessible.
     565by the node is freed and the node is no longer be accessible.
    568566
    569567@subheading NOTES:
     
    613611@item EINVAL
    614612Either both or neither of CFG_LOGICAL and CFG_PHYSICAL are
    615 specified by the options argument ???????????
     613specified by the options argument
    616614
    617615@item ENOMEM
     
    631629@subheading DESCRIPTION:
    632630
    633 The @code{cfg_open} function shall open a configuration traversal stream
     631The @code{cfg_open} function opens a configuration traversal stream
    634632rooted in the configuration nodes name by the @code{pathnames} argument.
    635 It shall store a pointer to a CFG object that represents that stream at
     633It stores a pointer to a CFG object that represents that stream at
    636634the location identified the @code{cfgstream} pointer.  The @code{pathnames}
    637635argument is an array of character pointers to NULL-terminated strings.
    638 The last member of this array shall be a NULL pointer.
     636The last member of this array is a NULL pointer.
    639637
    640638The value of @code{options} is the bitwise inclusive OR of values from the
    641 following lists.  Applications shall supply exactly one of the first two
    642 values below in @code{options}.
     639following lists.  Applications supply exactly one of the first two values
     640below in @code{options}.
    643641
    644642@table @b
     
    647645When symbolic links referencing existing nodes are
    648646encountered during the traversal, the @code{cfg_info}
    649 field of the returned CFGENT structure shall describe
    650 the target node pointed to by the link instead of the
     647field of the returned CFGENT structure describes the
     648target node pointed to by the link instead of the
    651649link itself, unless the target node does not exist.
    652650If the target node has children, the pre-order return,
    653651followed by the return of structures referencing all of
    654 its descendants, followed by a post-order return, shall
    655 be done.
     652its descendants, followed by a post-order return, is done.
    656653                   
    657654@item CFG_PHYSICAL
    658655When symbolic links are encountered during the traversal,
    659 the @code{cfg_info} field shall describe the symbolic
     656the @code{cfg_info} field is used to describe the symbolic
    660657link.
    661658
     
    672669specified in the @code{pathnames} argument, the
    673670@code{cfg_info} field of the returned CFGENT structure
    674 shall describe the target node pointed to by the link
     671describes the target node pointed to by the link
    675672instead of the link itself, unless the target node does
    676673not exist.  If the target node has children, the
     
    680677
    681678@item CFG_XDEV
    682 The configuration space functions shall not return a
     679The configuration space functions do not return a
    683680CFGENT structure for any node in a different configuration
    684681space than the configuration space of the nodes identified
     
    687684@end table
    688685
    689 The @code{cfg_open} argument @code{compar} shall either be NULL or point
    690 to a function that shall be called with two pointers to pointers to CFGENT
    691 structures that shall return less than, equal to , or greater than zero if
     686The @code{cfg_open} argument @code{compar} is either a NULL or point
     687to a function that is called with two pointers to pointers to CFGENT
     688structures that returns less than, equal to , or greater than zero if
    692689the node referenced by the first argument is considered to be respectively
    693690less than, equal to, or greater than the node referenced by the second.
    694 The CFGENT structure fields provided to the comparison routine shall be as
     691The CFGENT structure fields provided to the comparison routine is as
    695692described with the exception that the contents of the @code{cfg_path} and
    696693@code{cfg_pathlen} fields are unspecified.
     
    700697of traversal when more than one node is specified in the @code{pathnames}
    701698argument to @code{cfg_open}.  If a comparison routine is specified, the
    702 order of traversal shall be from the least to the greatest.  If the
    703 @code{compar} argument is NULL, the order of traversal shall be as listed
    704 in the @code{pathnames} argument.
     699order of traversal is from the least to the greatest.  If the @code{compar}
     700argument is NULL, the order of traversal shall be as listed in the
     701@code{pathnames} argument.
    705702
    706703@subheading NOTES:
     
    763760The @code{cfg_read} function returns a pointer to a CFGENT structure
    764761representing a node in the configuration space to which @code{cfgp}
    765 refers.  The returned pointer shall be stored at the location
    766 indicated by the @code{node} argument.
     762refers.  The returned pointer is stored at the location indicated
     763by the @code{node} argument.
    767764
    768765The child nodes of each node in the configuration tree is returned
    769766by @code{cfg_read}.  If a comparison routine is specified to the
    770 @code{cfg_open} function, the order of return of the child nodes shall
    771 be as specified by the routine, from least to greatest.  Otherwise
     767@code{cfg_open} function, the order of return of the child nodes is
     768as specified by the routine, from least to greatest.  Otherwise
    772769the order of return is unspecified.
    773770
    774 Structures referencing nodes with children shall be returned by the
     771Structures referencing nodes with children is returned by the
    775772function @code{cfg_read} at least twice [unless the application
    776773specifies otherwise with @code{cfg_mark}]-once immediately before
     
    779776of their descendants, if any, are returned (post-order).  The
    780777CFGENT structure returned in post-order (with the exception of the
    781 @code{cfg_info} field) shall be identical to that returned in pre-order.
    782 Structures referencing nodes of other types shall be returned at least
     778@code{cfg_info} field) is identical to that returned in pre-order.
     779Structures referencing nodes of other types is returned at least
    783780once.
    784781
    785 The fields of the CFGENT structure shall contain the following
     782The fields of the CFGENT structure contains the following
    786783information:
    787784
     
    792789@code{cfg_read} function for the node that contains
    793790the entry for the current node.  A @code{cfg_parent}
    794 structure shall be provided for the node(s) specified
    795 by the @code{pathnames} argument to the @code{cfg_open}
     791structure is provided for the node(s) specified by
     792the @code{pathnames} argument to the @code{cfg_open}
    796793function, but the contents of other than its
    797794@code{cfg_number}, @code{cfg_pointer}, @code{cfg_parent},
     
    816813@item cfg_number
    817814The @code{cfg_number} field is provided for use by the
    818 application program.  It shall be initialized to zero for
     815application program.  It is initialized to zero for
    819816each new node returned by the @code{cfg_read} function,
    820 but shall not be further modified the configuration space
     817but is not further modified by the configuration space
    821818routines.
    822819
    823820@item cfg_pointer
    824821The @code{cfg_pointer} field is provided for use by the
    825 application program.  It shall be initialized to NULL for
     822application program.  It is initialized to NULL for
    826823each new node returned by the @code{cfg_read} function,
    827 but shall not be further modified by the configuration
     824but is not further modified by the configuration
    828825space routines.
    829826
     
    832829argument supplied to the @code{cfg_open} routine for this
    833830configuration space.  This pathname may be longer than
    834 @code{PATH_MAX} bytes.  This pathname shall be NULL-terminated.
     831@code{PATH_MAX} bytes.  This pathname is NULL-terminated.
    835832
    836833@item cfg_name
     
    850847structure for each of the node(s) specified in the
    851848@code{pathnames} argument to the @code{cfg_open} function
    852 shall be set to 0, and this number shall be incremented for
    853 for each node level descendant.
     849is set to 0, and this number is incremented for each
     850node level descendant.
    854851
    855852@item cfg_info
    856 This field shall contain one of the values listed below.  If
     853This field contains one of the values listed below.  If
    857854an object can have more than one info value, the first
    858 appropriate value listed below shall be returned.
     855appropriate value listed below is returned.
    859856
    860857@table @b
     
    867864The structure represents a node that is a parent
    868865of the node most recently returned by @code{cfg_read}.
    869 The @code{cfg_cycle} field shall reference the
    870 structure previously returned by @code{cfg_read} that
    871 is the same as the returned structure.
     866The @code{cfg_cycle} field references the structure
     867previously returned by @code{cfg_read} that is the
     868same as the returned structure.
    872869
    873870@item CFG_DEFAULT
     
    878875The structure represents a node, not of type symlink,
    879876that is unreadable.  The variable @code{cfg_errno}
    880 shall be set to the appropriate value.
     877is set to the appropriate value.
    881878
    882879@item CFG_DP
    883880The structure represents a node with children in
    884 post-order.  This value shall occur only if CFG_D
     881post-order.  This value occurs only if CFG_D
    885882has previously been returned for this entry.
    886883
    887884@item CFG_ERR
    888885The structure represents a node for which an error has
    889 occurred.  The variable @code{cfg_errno} shall be set
    890 to the appropriate value.
     886occurred.  The variable @code{cfg_errno} is set to the
     887appropriate value.
    891888
    892889@item CFG_F
     
    906903
    907904Structures returned by @code{cfg_read} with a @code{cfg_info} field equal
    908 to CFG_D shall be accessible until a subsequent call, on the same
     905to CFG_D is accessible until a subsequent call, on the same
    909906configuration traversal stream, to @code{cfg_close}, or to @code{cfg_read}
    910907after they have been returned by the @code{cfg_read} function in
    911908post-order.  Structures returned by @code{cfg_read} with an
    912 @code{cfg_info} field not equal to CFG_D shall be accessible until a
    913 subsequent call, on the same configuration traversal stream, to
    914 @code{cfg_close} or @code{cfg_read}.
     909@code{cfg_info} field not equal to CFG_D is accessible until a subsequent
     910call, on the same configuration traversal stream, to @code{cfg_close}
     911or @code{cfg_read}.
    915912
    916913The content of the @code{cfg_path} field is specified only for the
     
    919916The specified fields in structures in the list representing nodes for
    920917which structures have previously been returned by @code{cfg_children},
    921 shall be identical to those returned by @code{cfg_children}, except that
     918is identical to those returned by @code{cfg_children}, except that
    922919the contents of the @code{cfg_path} and @code{cfg_pathlen} fields are
    923920unspecified.
     
    979976@subheading DESCRIPTION:
    980977
    981 The first @code{cfg_children} call after a @code{cfg_read} shall
    982 return information about the first node without children under the
    983 node returned by @code{cfg_read}.  Subsequent calls to
    984 @code{cfg_children} without the intervening @code{cfg_read} shall
    985 return information about the remaining nodes without children under
    986 that same node.
     978The first @code{cfg_children} call after a @code{cfg_read} returns
     979information about the first node without children under the node
     980returned by @code{cfg_read}.  Subsequent calls to @code{cfg_children}
     981without the intervening @code{cfg_read} shall return information
     982about the remaining nodes without children under that same node.
    987983
    988984If @code{cfg_read} has not yet been called for the configuration
    989985traversal stream represented by @code{cfgp}, @code{cfg_children}
    990 shall return a pointer to the first entry in a list of the nodes
     986returns a pointer to the first entry in a list of the nodes
    991987represented by the @code{pathnames} argument to @code{cfg_open}.
    992988
    993 In either case, the list shall be NULL-terminated, ordered by the
     989In either case, the list is NULL-terminated, ordered by the
    994990user-specified comparison function, if any, and linked through the
    995991cfg_link field.
     
    10391035by the structure pointed to by the argument @code{cfgp}.
    10401036
    1041 Exactly one of the @code{f} argument and the @code{cfgp} argument shall
    1042 be NULL.
    1043 
    1044 The value of the @code{options} argument shall be exactly one of the
    1045 flags specified in the following list:
     1037Exactly one of the @code{f} argument and the @code{cfgp} argument is NULL.
     1038
     1039The value of the @code{options} argument is exactly one of the flags
     1040specified in the following list:
    10461041
    10471042@table @b
     
    10511046argument is NULL, or the structure referenced by @code{f}
    10521047is not the one most recently returned by @code{cfg_read},
    1053 @code{cfg_mark} shall return an error.  Otherwise, the next
    1054 call to the @code{cfg_read} function shall return the
    1055 structure referenced by @code{f} with the @code{cfg_info}
    1056 field reinitialized.  Subsequent behavior of the @code{cfg}
    1057 functions shall be based on the reinitialized value of
     1048@code{cfg_mark} returns an error.  Otherwise, the next
     1049call to the @code{cfg_read} function returns the structure
     1050referenced by @code{f} with the @code{cfg_info} field
     1051reinitialized.  Subsequent behavior of the @code{cfg}
     1052functions are based on the reinitialized value of
    10581053@code{cfg_info}.
    10591054
     
    10631058is not one of those specified as accessible, or the structure
    10641059referenced by @code{f} is not for a node of type pre-order
    1065 node, @code{cfg_mark} shall return an error.  Otherwise, no
     1060node, @code{cfg_mark} returns an error.  Otherwise, no
    10661061more structures for the node referenced by @code{f} or its
    1067 descendants shall be returned by the @code{cfg_read} function.
     1062descendants are returned by the @code{cfg_read} function.
    10681063
    10691064@item CFG_FOLLOW
     
    10721067is not one of those specified as accessible, or the structure
    10731068referenced by @code{f} is not for a node of type symbolic link,
    1074 @code{cfg_mark} shall return an error.  Otherwise, the next
    1075 call to the @code{cfg_read} function shall return the structure
     1069@code{cfg_mark} returns an error.  Otherwise, the next
     1070call to the @code{cfg_read} function returns the structure
    10761071referenced by @code{f} with the @code{cfg_info} field reset
    10771072to reflect the target of the symbolic link instead of the
Note: See TracChangeset for help on using the changeset viewer.