summaryrefslogtreecommitdiffstats
path: root/doc/new_chapters/eventlog.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-08-27 20:53:21 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-08-27 20:53:21 +0000
commitaf5a571ea8669b6c428c2ad220a3002034d831fe (patch)
tree651acee0021ca1d06e696b1b4893c1eb57772b11 /doc/new_chapters/eventlog.t
parentModified log_open() to reflect review. (diff)
downloadrtems-af5a571ea8669b6c428c2ad220a3002034d831fe.tar.bz2
Updated log_seek() per review.
Diffstat (limited to '')
-rw-r--r--doc/new_chapters/eventlog.t24
1 files changed, 10 insertions, 14 deletions
diff --git a/doc/new_chapters/eventlog.t b/doc/new_chapters/eventlog.t
index 2c2598efcd..de7b928817 100644
--- a/doc/new_chapters/eventlog.t
+++ b/doc/new_chapters/eventlog.t
@@ -264,7 +264,7 @@ and @code{ENOTDIR} are detected in this manner.
#include <evlog.h>
int log_read(
- const logd_t logdes,
+ const logd_t logdes,
struct log_entry *entry,
void *log_buf,
const size_t log_len,
@@ -452,19 +452,13 @@ int log_seek(
@table @b
@item EBADF
-The logdes argument is not a valid log file descriptor.
-
-@item EINTR
-The log_seek() function was interrupted by a signal.
-
-@item EINVAL
-The log_recid argument is not a valid record id.
+The @code{logdes} argument is not a valid log file descriptor.
@end table
@subheading DESCRIPTION:
-The @code{log_seek} function shall set the log file offset of the open
+The @code{log_seek} function sets the log file offset of the open
log description associated with the @code{logdes} log file descriptor
to the event record in the log file identified by @code{log_recid}.
The @code{log_recid} argument is either the record id of a valid event
@@ -473,22 +467,24 @@ record or one of the following values, as defined in the header <evlog.h>:
@table @b
@item LOG_SEEK_START
Set log file position to point at the first event
-record in the log file
+record in the log file.
@item LOG_SEEK_END
Set log file position to point after the last event
-record in the log file
+record in the log file.
@end table
-If the @code{log_seek} function is interrupted, the state of the open log
-file description associated with @code{logdes} is unspecified.
-
@subheading NOTES:
The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.
+This implementation can not return @code{EINTR}.
+
+This implementation can not return @code{EINVAL} to indicate that
+the @code{log_recid} argument is not a valid record id.
+
@page
@subsection log_severity_before - Compare event record severities