From: Jeff Kirsher <tarbal@gmail.com>
To: Ben Hutchings <bhutchings@solarflare.com>
Cc: Richard Cochran <richardcochran@gmail.com>,
netdev@vger.kernel.org, David Miller <davem@davemloft.net>,
Jacob Keller <jacob.e.keller@intel.com>,
Jeff Kirsher <jeffrey.t.kirsher@intel.com>,
John Stultz <john.stultz@linaro.org>,
Matthew Vick <matthew.vick@intel.com>
Subject: Re: [PATCH V2 net-next 4/4] ptp: clarify the clock_name sysfs attribute
Date: Sat, 22 Sep 2012 09:03:47 -0700 [thread overview]
Message-ID: <505DE163.1030809@gmail.com> (raw)
In-Reply-To: <1348328688.2521.81.camel@bwh-desktop.uk.solarflarecom.com>
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.
next prev parent reply other threads:[~2012-09-22 16:03 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-22 7:42 [PATCH V2 net-next 0/4] Two new PTP Hardware Clock features Richard Cochran
2012-09-22 7:42 ` [PATCH V2 net-next 1/4] ptp: remember the adjusted frequency Richard Cochran
2012-09-22 7:42 ` [PATCH V2 net-next 2/4] ptp: provide the clock's " Richard Cochran
2012-09-22 7:42 ` [PATCH V2 net-next 3/4] ptp: link the phc device to its parent device Richard Cochran
2012-09-22 15:40 ` Ben Hutchings
2012-09-22 7:42 ` [PATCH V2 net-next 4/4] ptp: clarify the clock_name sysfs attribute Richard Cochran
2012-09-22 15:44 ` Ben Hutchings
2012-09-22 16:03 ` Jeff Kirsher [this message]
2012-09-22 7:45 ` [PATCH V2 net-next 0/4] Two new PTP Hardware Clock features Richard Cochran
2012-09-22 9:11 ` Richard Cochran
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=505DE163.1030809@gmail.com \
--to=tarbal@gmail.com \
--cc=bhutchings@solarflare.com \
--cc=davem@davemloft.net \
--cc=jacob.e.keller@intel.com \
--cc=jeffrey.t.kirsher@intel.com \
--cc=john.stultz@linaro.org \
--cc=matthew.vick@intel.com \
--cc=netdev@vger.kernel.org \
--cc=richardcochran@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).