adjtimex.2: add explanation on ADJ_TAI mode
PATCH v3 2/2 adjtimex.2: add explanation on ADJ_TAI mode
This patch includes the adjtimex mode ADJ_TAI, intended to update the TAI offset. There are other FIXMEs in the man page and it's a bit outdated. I'll be on it once those first patches are accepted (to be sure to do the right thing).
Thanks
Laurent
man2/adjtimex.2 +15 -3
@@ -24,9 +24,7 @@ .\" Modified 1997-01-31 by Eric S. Raymond <[email protected]> .\" Modified 1997-07-30 by Paul Slootman <[email protected]> .\" Modified 2004-05-27 by Michael Kerrisk <[email protected]> -.\" -.\" FIXME Document ADJ_TAI (added in Linux 2.6.26) -.\" commit 153b5d054ac2d98ea0d86504884326b6777f683d +.\" Modified 2014-11-30 by Laurent Georget <[email protected]> .\" .\" FIXME Document ADJ_MICRO and ADJ_NANO (added in Linux 2.6.26) .\" commit eea83d896e318bda54be2d2770d2c5d6668d11db
@@ -101,6 +99,7 @@ combination of zero or more of the following bits: #define ADJ_ESTERROR 0x0008 /* estimated time error */ #define ADJ_STATUS 0x0010 /* clock status */ #define ADJ_TIMECONST 0x0020 /* pll time constant */ +#define ADJ_TAI 0x0080 /* TAI offset */ #define ADJ_TICK 0x4000 /* tick value */ #define ADJ_OFFSET_SINGLESHOT 0x8001 /* old-fashioned adjtime() */ .fi
@@ -110,6 +109,24 @@ Ordinary users are restricted to a zero value for .IR modes . Only the superuser may set any parameters. .br +In the case of +.BR ADJ_TAI , +as +.I buf->tai +is read-only, the new value is passed through +.IR buf->constant , +therefore +.B ADJ_TIMECONST +and +.B ADJ_TAI +should probably not be used at the same time. +.PP +Support for TAI (Atomic International Time, for a complete explanation
about
+what it is and what is the difference between TAI and UTC, see +.UR http://www.bipm.org/en/bipm/tai/tai.html
+.I BIPM
+.UE )
+has been added in version 2.6.26.
.ne 12v
.SH RETURN VALUE
On success,
Hello Laurent,
Quoted 2 lines · Laurent Georget
This patch includes the adjtimex mode
ADJ_TAI, intended to update the TAI offset.
Thanks. Applied, with a few rewordings (which you can find in Git). One point/question below.
Quoted 3 lines
There are other FIXMEs in the man page and it's a bit outdated. I'll be on it once those first patches are accepted (to be sure to do the right thing).
I would be happy to get more such patches.
Quoted 28 lines
man2/adjtimex.2 +3
-3@@ -24,9 +24,7 @@ .\" Modified 1997-01-31 by Eric S. Raymond <[email protected]> .\" Modified 1997-07-30 by Paul Slootman <paul-pqePwCal/[email protected]> .\" Modified 2004-05-27 by Michael Kerrisk <[email protected]> -.\" -.\" FIXME Document ADJ_TAI (added in Linux 2.6.26) -.\" commit 153b5d054ac2d98ea0d86504884326b6777f683d +.\" Modified 2014-11-30 by Laurent Georget <[email protected]> .\" .\" FIXME Document ADJ_MICRO and ADJ_NANO (added in Linux 2.6.26) .\" commit eea83d896e318bda54be2d2770d2c5d6668d11db@@ -101,6 +99,7 @@ combination of zero or more of the following bits: #define ADJ_ESTERROR 0x0008 /* estimated time error */ #define ADJ_STATUS 0x0010 /* clock status */ #define ADJ_TIMECONST 0x0020 /* pll time constant */ +#define ADJ_TAI 0x0080 /* TAI offset */ #define ADJ_TICK 0x4000 /* tick value */ #define ADJ_OFFSET_SINGLESHOT 0x8001 /* old-fashioned adjtime() */ .fi@@ -110,6 +109,24 @@ Ordinary users are restricted to a zero value for .IR modes . Only the superuser may set any parameters. .br +In the case of
man2/adjtimex.2 Ordinary users are restricted to a zero value for · line 122
Quoted 10 lines
man2/adjtimex.2 +10
-0+.BR ADJ_TAI , +as +.I buf->tai +is read-only, the new value is passed through +.IR buf->constant , +therefore +.B ADJ_TIMECONST +and +.B ADJ_TAI +should probably not be used at the same time.
"should probably not" seems a little weak to me. Surely it is rather the case that they *must not* be used at the same time. I changed it to "must not".
Thanks,
Michael
Signature · 7 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html