Add description of adjtime() from Linux man page
This commit is contained in:
parent
8db29071da
commit
c326b6320a
@ -195,7 +195,35 @@ int settimeofday(FAR const struct timeval *tv, FAR struct timezone *tz);
|
||||
* Name: adjtime
|
||||
*
|
||||
* Description:
|
||||
* Correct the time to synchronize the system clock
|
||||
* The adjtime() function gradually adjusts the system clock (as returned
|
||||
* by gettimeofday(2)). The amount of time by which the clock is to be
|
||||
* adjusted is specified in the structure pointed to by delta.
|
||||
*
|
||||
* This structure has the following form:
|
||||
*
|
||||
* struct timeval
|
||||
* {
|
||||
* time_t tv_sec; (seconds)
|
||||
* suseconds_t tv_usec; (microseconds)
|
||||
* };
|
||||
*
|
||||
* If the adjustment in delta is positive, then the system clock is
|
||||
* speeded up by some small percentage (i.e., by adding a small amount of
|
||||
* time to the clock value in each second) until the adjustment has been
|
||||
* completed. If the adjustment in delta is negative, then the clock is
|
||||
* slowed down in a similar fashion.
|
||||
*
|
||||
* If a clock adjustment from an earlier adjtime() call is already in
|
||||
* progress at the time of a later adjtime() call, and delta is not NULL
|
||||
* for the later call, then the earlier adjustment is stopped, but any
|
||||
* already completed part of that adjustment is not undone.
|
||||
*
|
||||
* If olddelta is not NULL, then the buffer that it points to is used to
|
||||
* return the amount of time remaining from any previous adjustment that
|
||||
* has not yet been completed.
|
||||
*
|
||||
* NOTE: This is not a POSIX interface but derives from 4.3BSD, System V.
|
||||
* It is also supported for Linux compatibility.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
|
@ -163,9 +163,41 @@ errout_in_critical_section:
|
||||
return ret;
|
||||
}
|
||||
|
||||
/************************************************************************
|
||||
/****************************************************************************
|
||||
* Name: adjtime
|
||||
************************************************************************/
|
||||
*
|
||||
* Description:
|
||||
* The adjtime() function gradually adjusts the system clock (as returned
|
||||
* by gettimeofday(2)). The amount of time by which the clock is to be
|
||||
* adjusted is specified in the structure pointed to by delta.
|
||||
*
|
||||
* This structure has the following form:
|
||||
*
|
||||
* struct timeval
|
||||
* {
|
||||
* time_t tv_sec; (seconds)
|
||||
* suseconds_t tv_usec; (microseconds)
|
||||
* };
|
||||
*
|
||||
* If the adjustment in delta is positive, then the system clock is
|
||||
* speeded up by some small percentage (i.e., by adding a small amount of
|
||||
* time to the clock value in each second) until the adjustment has been
|
||||
* completed. If the adjustment in delta is negative, then the clock is
|
||||
* slowed down in a similar fashion.
|
||||
*
|
||||
* If a clock adjustment from an earlier adjtime() call is already in
|
||||
* progress at the time of a later adjtime() call, and delta is not NULL
|
||||
* for the later call, then the earlier adjustment is stopped, but any
|
||||
* already completed part of that adjustment is not undone.
|
||||
*
|
||||
* If olddelta is not NULL, then the buffer that it points to is used to
|
||||
* return the amount of time remaining from any previous adjustment that
|
||||
* has not yet been completed.
|
||||
*
|
||||
* NOTE: This is not a POSIX interface but derives from 4.3BSD, System V.
|
||||
* It is also supported for Linux compatibility.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
int adjtime(const struct timeval *delta, struct timeval *olddelta)
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user