| Message ID | 6bc914f0607428ab0d8f5d5fc42a5e87bedc95c5.1348299094.git.richardcochran@gmail.com |
|---|---|
| State | Superseded, archived |
| Delegated to: | David Miller |
| Headers | show |
On Sat, 2012-09-22 at 09:42 +0200, Richard Cochran wrote: > There has been some confusion among PHC driver authors about the > intended purpose of the clock_name attribute. This patch expands the > documation in order to clarify how the clock_name field should be > understood. > > Signed-off-by: Richard Cochran <richardcochran@gmail.com> > --- > Documentation/ABI/testing/sysfs-ptp | 5 ++++- > 1 files changed, 4 insertions(+), 1 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp > index d40d2b5..c906488 100644 > --- a/Documentation/ABI/testing/sysfs-ptp > +++ b/Documentation/ABI/testing/sysfs-ptp > @@ -19,7 +19,10 @@ Date: September 2010 > Contact: Richard Cochran <richardcochran@gmail.com> > Description: > This file contains the name of the PTP hardware clock > - as a human readable string. > + as a human readable string. The purpose of this > + attribute is to provide the user with a "friendly > + name" and to help distinguish PHY based devices from > + MAC based ones. Might also be worth saying that it is not required to be unique. And this explanation should also go in the kernel-doc in ptp_clock_kernel.h, which is what driver writers are most likely to read. Ben. > What: /sys/class/ptp/ptpN/max_adjustment > Date: September 2010
On 09/22/2012 08:44 AM, Ben Hutchings wrote: > On Sat, 2012-09-22 at 09:42 +0200, Richard Cochran wrote: >> There has been some confusion among PHC driver authors about the >> intended purpose of the clock_name attribute. This patch expands the >> documation in order to clarify how the clock_name field should be >> understood. >> >> Signed-off-by: Richard Cochran <richardcochran@gmail.com> >> --- >> Documentation/ABI/testing/sysfs-ptp | 5 ++++- >> 1 files changed, 4 insertions(+), 1 deletions(-) >> >> diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp >> index d40d2b5..c906488 100644 >> --- a/Documentation/ABI/testing/sysfs-ptp >> +++ b/Documentation/ABI/testing/sysfs-ptp >> @@ -19,7 +19,10 @@ Date: September 2010 >> Contact: Richard Cochran <richardcochran@gmail.com> >> Description: >> This file contains the name of the PTP hardware clock >> - as a human readable string. >> + as a human readable string. The purpose of this >> + attribute is to provide the user with a "friendly >> + name" and to help distinguish PHY based devices from >> + MAC based ones. > Might also be worth saying that it is not required to be unique. And > this explanation should also go in the kernel-doc in ptp_clock_kernel.h, > which is what driver writers are most likely to read. > > Ben FWIW, I agree with Ben. -- To unsubscribe from this list: send the line "unsubscribe netdev" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/Documentation/ABI/testing/sysfs-ptp b/Documentation/ABI/testing/sysfs-ptp index d40d2b5..c906488 100644 --- a/Documentation/ABI/testing/sysfs-ptp +++ b/Documentation/ABI/testing/sysfs-ptp @@ -19,7 +19,10 @@ Date: September 2010 Contact: Richard Cochran <richardcochran@gmail.com> Description: This file contains the name of the PTP hardware clock - as a human readable string. + as a human readable string. The purpose of this + attribute is to provide the user with a "friendly + name" and to help distinguish PHY based devices from + MAC based ones. What: /sys/class/ptp/ptpN/max_adjustment Date: September 2010
There has been some confusion among PHC driver authors about the intended purpose of the clock_name attribute. This patch expands the documation in order to clarify how the clock_name field should be understood. Signed-off-by: Richard Cochran <richardcochran@gmail.com> --- Documentation/ABI/testing/sysfs-ptp | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-)