Re: [net-next, v3, 02/10] ptp: support ptp physical/virtual clocks conversion

[Richard Cochran]

On Tue, Jun 15, 2021 at 05:45:09PM +0800, Yangbo Lu wrote:

> diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp
> index 2363ad810ddb..2ef11b775f47 100644
> --- a/Documentation/ABI/testing/sysfs-ptp
> +++ b/Documentation/ABI/testing/sysfs-ptp
> @@ -61,6 +61,19 @@ Description:
>  		This file contains the number of programmable pins
>  		offered by the PTP hardware clock.
>  
> +What:		/sys/class/ptp/ptpN/n_vclocks
> +Date:		May 2021
> +Contact:	Yangbo Lu <yangbo.lu@xxxxxxx>
> +Description:
> +		This file contains the ptp virtual clocks number in use,
> +		based on current ptp physical clock. In default, the
> +		value is 0 meaning only ptp physical clock is in use.
> +		Setting the value can create corresponding number of ptp
> +		virtual clocks to use. But current ptp physical clock is
> +		guaranteed to stay free running. Setting the value back
> +		to 0 can delete ptp virtual clocks and back use ptp
> +		physical clock again.

The native speaker in me suggests:

		This file contains the number of virtual PTP clocks in
		use.  By default, the value is 0 meaning that only the
		physical clock is in use.  Setting the value creates
		the corresponding number of virtual clocks and causes
		the physical clock to become free running.  Setting the
		value back to 0 deletes the virtual clocks and
		switches the physical clock back to normal, adjustable
		operation.

Thanks,
Richard