From f23e83b156da8966e43e303dced5439503450d21 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Mon, 4 Jan 2016 23:17:21 -0500 Subject: man/sd_event_{add_io,add_time,add_signal,now}: various small fixes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - remove things which are clear from the context - 0 is a valid descriptor number, hence "positive" → "non-negative" - "positive" means greater than zero, hence "positive non-zero" → "positive" - use oxford comma - reword some things for clarity --- man/sd_event_now.xml | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) (limited to 'man/sd_event_now.xml') diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml index 58d7375eac..054aff3ac6 100644 --- a/man/sd_event_now.xml +++ b/man/sd_event_now.xml @@ -65,45 +65,44 @@ Description - sd_event_now() returns the timestamp - the most recent event loop iteration began. This timestamp is - taken right after returning from the event sleep, and before + sd_event_now() returns the time when + the most recent event loop iteration began. A timestamp + is taken right after returning from the event sleep, and before dispatching any event sources. The event - parameter takes the even loop object to retrieve the timestamp + parameter specifies the event loop object to retrieve the timestamp from. The clock parameter specifies the clock to retrieve the timestamp for, and is one of - CLOCK_REALTIME (or its equivalent + CLOCK_REALTIME (or equivalently CLOCK_REALTIME_ALARM), - CLOCK_MONOTONIC or - CLOCK_BOOTTIME (or its equivalent - CLOCK_BOOTTIME_ALARM), see clock_gettime2 + CLOCK_MONOTONIC, or + CLOCK_BOOTTIME (or equivalently + CLOCK_BOOTTIME_ALARM), see + clock_gettime2 for more information on the various clocks. The retrieved timestamp is stored in the usec parameter, in µs since the clock's epoch. If this function is invoked before - the first event loop iteration the current time is returned, as + the first event loop iteration, the current time is returned, as reported by clock_gettime(). To distinguish this case from a regular invocation the return value will be - positive non-zero in this case, while it is zero when the returned - timestamp refers to the actual event loop iteration. + positive, and zero when the returned timestamp refers to an actual + event loop iteration. Return Value If the first event loop iteration has not run yet - sd_event_now() returns the requested - timestamp in usec and returns a positive, - non-zero return value. Otherwise, on success it will return the - iteration's timestamp in usec and 0 as - return value. On failure, the call returns a negative errno-style + sd_event_now() writes current time to + usec and returns a positive return value. + Otherwise, it will write the requested timestamp to usec + and return 0. On failure, the call returns a negative errno-style error code. Errors - Returned errors may indicate the following problems: + Returned values may indicate the following problems: -- cgit v1.2.3