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

From: Arnd Bergmann
Date: Tue Nov 21 2017 - 03:06:46 EST


On Tue, Nov 21, 2017 at 4:05 AM, Richard Cochran
<richardcochran@xxxxxxxxx> wrote:
> On Mon, Nov 20, 2017 at 11:53:02PM +0100, Arnd Bergmann wrote:
>> .B EINVAL
>> +The
>> +.I clk_id
>> +specified is not supported on this system.
>
> We return EINVAL when the clockid is not valid. That can mean two
> things. Either the SYS-V style hard coded positive clockid is out of
> range, or the dynamic negative clockid does not refer to a valid
> instance of a clock object.
>
> Dynamic clocks might also return ENODEV in case a hot-plugable device
> (like USB) has disappeared after its character device was opened.

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.

Arnd