Imagelibrary/rtems
1
0
Fork 1
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-12-06 15:43:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Corrected descriptions of log facility set manipulation routines as

Browse Source 
part of the review.
This commit is contained in:
Joel Sherrill
1998-08-27 18:53:34 +00:00
parent c5568160cb
commit d65d22a096
1 changed files with 69 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

209
doc/new_chapters/eventlog.t
View File

@@ -559,47 +559,30 @@ int log_facilityemptyset(
@subheading STATUS CODES: @subheading STATUS CODES:
@table @b @table @b
@item EINVAL @item EFAULT
The facilityno argument is not a valid facility. The @code{set} argument is an invalid pointer.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The @code{log_facilityemptyset} function initializes the facility The @code{log_facilityemptyset} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities set pointed to by the argument @code{set}, such that all facilities
are included. are excluded.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions
respectively add or delete the individual facility specified by the
value of the argument @code{facilityno} to or from the facility set
pointed to by the argument @code{set}
The @code{log_facilityismember} function tests whether the facility
specified by the value of the argument @code{facilityno} is a member
of the set pointed to by the argument @code{set}. Upon successful
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available. this service is available.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
@page @page
@subsection log_facilityfillset - Manipulate log facility sets @subsection log_facilityfillset - Manipulate log facility sets
@@ -621,47 +604,30 @@ int log_facilityfillset(
@subheading STATUS CODES: @subheading STATUS CODES:
@table @b @table @b
@item EINVAL @item EFAULT
The facilityno argument is not a valid facility. The @code{set} argument is an invalid pointer.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityfillset} function initializes the facility
operate on data objects addressable by the application.
The @code{log_facilityemptyset} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities set pointed to by the argument @code{set}, such that all facilities
are included. are included.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions
respectively add or delete the individual facility specified by the
value of the argument @code{facilityno} to or from the facility set
pointed to by the argument @code{set}
The @code{log_facilityismember} function tests whether the facility
specified by the value of the argument @code{facilityno} is a member
of the set pointed to by the argument @code{set}. Upon successful
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available. this service is available.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
@page @page
@subsection log_facilityaddset - Manipulate log facility sets @subsection log_facilityaddset - Manipulate log facility sets
@@ -673,7 +639,7 @@ this service is available.
int log_facilityaddset( int log_facilityaddset(
log_facility_set_t *set, log_facility_set_t *set,
log_facility_t facilityno log_facility_t facilityno
); );
@end example @end example
@end ifset @end ifset
@@ -684,47 +650,33 @@ int log_facilityaddset(
@subheading STATUS CODES: @subheading STATUS CODES:
@table @b @table @b
@item EFAULT
The @code{set} argument is an invalid pointer.
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The @code{facilityno} argument is not a valid facility.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilityaddset} function adds the individual
operate on data objects addressable by the application. facility specified by the value of the argument @code{facilityno}
to the facility set pointed to by the argument @code{set}.
The @code{log_facilityemptyset} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities
are included.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions
respectively add or delete the individual facility specified by the
value of the argument @code{facilityno} to or from the facility set
pointed to by the argument @code{set}
The @code{log_facilityismember} function tests whether the facility
specified by the value of the argument @code{facilityno} is a member
of the set pointed to by the argument @code{set}. Upon successful
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available. this service is available.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
@page @page
@subsection log_facilitydelset - Manipulate log facility sets @subsection log_facilitydelset - Manipulate log facility sets
@@ -736,7 +688,7 @@ this service is available.
int log_facilitydelset( int log_facilitydelset(
log_facility_set_t *set, log_facility_set_t *set,
log_facility_t facilityno log_facility_t facilityno
); );
@end example @end example
@end ifset @end ifset
@@ -747,47 +699,33 @@ int log_facilitydelset(
@subheading STATUS CODES: @subheading STATUS CODES:
@table @b @table @b
@item EFAULT
The @code{set} argument is an invalid pointer.
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The @code{facilityno} argument is not a valid facility.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The facilitysetops primitives manipulate sets of facilities. They The @code{log_facilitydelset} function deletes the individual
operate on data objects addressable by the application. facility specified by the value of the argument @code{facilityno}
from the facility set pointed to by the argument @code{set}.
The @code{log_facilityemptyset} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities
are included.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions
respectively add or delete the individual facility specified by the
value of the argument @code{facilityno} to or from the facility set
pointed to by the argument @code{set}
The @code{log_facilityismember} function tests whether the facility
specified by the value of the argument @code{facilityno} is a member
of the set pointed to by the argument @code{set}. Upon successful
completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a
value of zero to the location specified by @code{member} if the
specified facility is not a member of the specified set.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available. this service is available.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
@page @page
@subsection log_facilityismember - Manipulate log facility sets @subsection log_facilityismember - Manipulate log facility sets
@@ -811,47 +749,38 @@ int log_facilityismember(
@subheading STATUS CODES: @subheading STATUS CODES:
@table @b @table @b
@item EFAULT
The @code{set} or @code{member} argument is an invalid pointer.
@item EINVAL @item EINVAL
The facilityno argument is not a valid facility. The @code{facilityno} argument is not a valid facility.
@end table @end table
@subheading DESCRIPTION: @subheading DESCRIPTION:
The facilitysetops primitives manipulate sets of facilities. They
operate on data objects addressable by the application.
The @code{log_facilityemptyset} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities
are included.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
The @code{log_facilityaddset} and @code{log_facilitydelset} functions
respectively add or delete the individual facility specified by the
value of the argument @code{facilityno} to or from the facility set
pointed to by the argument @code{set}
The @code{log_facilityismember} function tests whether the facility The @code{log_facilityismember} function tests whether the facility
specified by the value of the argument @code{facilityno} is a member specified by the value of the argument @code{facilityno} is a member
of the set pointed to by the argument @code{set}. Upon successful of the set pointed to by the argument @code{set}. Upon successful
completion, the @code{log_facilityismember} function either returns completion, the @code{log_facilityismember} function either returns
a value of one to the location specified by @code{member} if the a value of one to the location specified by @code{member} if the
specified facility is a member of the specified set or returns a specified facility is a member of the specified set or value of
value of zero to the location specified by @code{member} if the zero to the location specified by @code{member} if the specified
specified facility is not a member of the specified set. facility is not a member of the specified set.
@subheading NOTES: @subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available. this service is available.
Applications shall call either @code{log_facilityemptyset} or
@code{log_facilityfillset} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object. If
such an object is not initialized in this way, but is nonetheless
supplied as an argument to any of the @code{log_facilityaddset},
@code{logfacilitydelset}, @code{log_facilityismember} or
@code{log_open} functions, the results are undefined.
@page @page
@subsection log_create - Creates a log file @subsection log_create - Creates a log file