adjtimex.2: Add some FIXMEs

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

1 files changed, 54 insertions, 0 deletions

diff --git a/man2/adjtimex.2 b/man2/adjtimex.2
index aeaab07d9c..89e9abf2ef 100644
--- a/man2/adjtimex.2
+++ b/man2/adjtimex.2
@@ -219,43 +219,86 @@ while others are read-only.
 .TP
 .BR STA_PLL
 Enable phase-locked loop (PLL) updates (read-write) via
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .BR ADJ_OFFSET .
 .TP
 .BR STA_PPSFREQ
 Enable PPS freq discipline (read-write).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_PPSTIME
 Enable PPS time discipline (read-write).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_FLL
 Select frequency-locked loop (FLL) mode (read-write).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_INS
 Insert leap second (read-write).
+.\" FIXME Is the following correct?
+.\"     Insert a leap second after the last second of the day.
+.\"     That is, at 24:00:00, set the clock 1 second back, thus extending
+.\"     the last  minute of the day by one second.
+.\"     Leap second insertion will occur each day, so long as this flag
+.\"     remains set.
 .TP
 .BR STA_DEL
 Delete leap second (read-write).
+.\" FIXME Is the following correct?
+.\"     Delete a leap second at the last second of the leap day.
+.\"     That is, at 23:5:59, add one extra second to the clock.
+.\"     Leap second deletion will occur each day, so long as this flag
+.\"     remains set.
+.\" FIXME Does there need to be a statement that it is nonsensical to set
+.\"     to set both STA_INS and STA_DEL?
 .TP
 .BR STA_UNSYNC
 Clock unsynchronized (read-write).
 .TP
 .BR STA_FREQHOLD
 Hold frequency (read-write).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_PPSSIGNAL
 PPS signal present (read-only).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_PPSJITTER
 PPS signal jitter exceeded (read-only).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_PPSWANDER
 PPS signal wander exceeded (read-only).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_PPSERROR
 PPS signal calibration error (read-only).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_CLOCKERR
 Clock hardware fault (read-only).
+.\" FIXME Any pointer to further information about what this means?
+.\"       (It was not immediately obvious from a scan of the RFC, whether
+.\"       this is described in the RFC.)
 .TP
 .BR STA_NANO " (since Linux 2.6.26)"
 .\" commit eea83d896e318bda54be2d2770d2c5d6668d11db
@@ -291,18 +334,29 @@ Clock synchronized.
 .TP
 .BR TIME_INS
 Insert leap second.
+.\" FIXME Is the following correct:
+.\"       Indicates that a leap second will be added at the end of the day
 .TP
 .BR TIME_DEL
 Delete leap second.
+.\" FIXME Is the following correct:
+.\"       Indicates that a leap second will be deleted at the end of the day
 .TP
 .BR TIME_OOP
 Leap second in progress.
+.\" FIXME Is the following correct:
+.\"       Indicates that we are currently in the middle of the leap second
+.\"       that is being added at the end of the day (as a result of STA_INS)
 .TP
 .BR TIME_WAIT
 Leap second has occurred.
+.\" FIXME Is the following correct:
+.\"       Indicates that a leap second has just been added or deleted
+.\"       during the previous second
 .TP
 .BR TIME_ERROR
 Clock not synchronized.
+.\" FIXME Should more be said about how the TIME_ERROR state can occur?
 The symbolic name
 .B TIME_BAD
 is a synonym for