Re: [PATCH v2 2/2] man/man2/adjtimex.2: Add error for clock_adjtime

[Alejandro Colomar <alx+linux-man@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 1239 bytes --]

Hi Georg,

> Date: 2026-10-27 01:37:12+0100
> From: Georg Sauthoff <mail@gms.tf>
>
> The ERANGE error can be verified either via trying to adjust the
> frequency of a PHC by a value that is outside of [-X,X],
> where X=`cat /sys/class/ptp/ptpX/max_adjustment`,
> or via checking the kernel source code:
> 
> <https://elixir.bootlin.com/linux/v7.2.2/source/drivers/ptp/ptp_clock.c#L164>
> 
> Signed-off-by: Georg Sauthoff <mail@gms.tf>

Thanks!  I've applied the patch.


Cheers,
Alex

> ---
>  man/man2/adjtimex.2 | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/man/man2/adjtimex.2 b/man/man2/adjtimex.2
> index 5b9a0667b..6b6ee98b0 100644
> --- a/man/man2/adjtimex.2
> +++ b/man/man2/adjtimex.2
> @@ -537,6 +537,12 @@ .SH ERRORS
>  Under Linux, the
>  .B CAP_SYS_TIME
>  capability is required.
> +.TP
> +.B ERANGE
> +The frequency offset supplied with
> +.BR clock_adjtime ()
> +is outside of the range clock clk_id supports.
> +See also /sys/class/ptp/ptpX/max_adjustment when adjusting a PTP hardware clock.
>  .SH ATTRIBUTES
>  For an explanation of the terms used in this section, see
>  .BR attributes (7).
> -- 
> 2.55.0
> 
> 

-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]