Re: [PATCH] [man-pages] adjtimex.2: document clock_adjtime

From: Richard Cochran
Date: Tue Nov 21 2017 - 11:06:11 EST


On Tue, Nov 21, 2017 at 09:06:37AM +0100, Arnd Bergmann wrote:
>
> I copied that line from clock_gettime() man page. I suppose we want to
> fix change this in both pages, right? Any suggestions for a good way to
> express your explanation in the man page? I suppose we don't want to
> go into details of the implementation there but still capture the possible
> corner cases.

Dynamic clockids are a Linux specific extension. This should be
explained with a paragraph or two on the gettime man page, along with
an example using the macros.

#define CLOCKFD 3
#define FD_TO_CLOCKID(fd) ((~(clockid_t) (fd) << 3) | CLOCKFD)
#define CLOCKID_TO_FD(clk) ((unsigned int) ~((clk) >> 3))

Then, the adjtimex page can say, see gettime.

Let me try to come up with a text over the (USA) holiday weekend.

Thanks,
Richard