Hi
In Documentation/rtc.txt, there is a description of the sysfs
interface which could be moved to Documentation/ABI.
Would such a change be useful?
The ABI documentation format looks like the following:
What: (the full sysfs path of the attribute)
Date: (date of creation)
KernelVersion: (kernel version it first showed up in)
Contact: (primary contact)
Description: (long description on usage)
I am doing this in an exercise to move sysfs ABI interfaces (which are
documented) to their right place i.e. in Documentation/ABI along with the rest.
Aishwarya
28.12.2017, 17:22, "Ozgur" <[email protected]>:
> 28.12.2017, 16:31, "Aishwarya Pant" <[email protected]>:
>> Hi
Hello,
>> In Documentation/rtc.txt, there is a description of the sysfs
>> interface which could be moved to Documentation/ABI.
>>
>> Would such a change be useful?
>>
>> The ABI documentation format looks like the following:
>>
>> What: (the full sysfs path of the attribute)
>> Date: (date of creation)
>> KernelVersion: (kernel version it first showed up in)
>> Contact: (primary contact)
>> Description: (long description on usage)
>>
>> I am doing this in an exercise to move sysfs ABI interfaces (which are
>> documented) to their right place i.e. in Documentation/ABI along with the rest.
Do I understand right? Are you want to make the rtc.txt part the same format as ABI folder?
for example create to RTC folder and add /dev/rtc what, date, kernelversion, contact right?
This can be a good idea and I can help.
>> Aishwarya
Ozgur
On Thu, Dec 28, 2017 at 05:23:33PM +0300, Ozgur wrote:
>
>
> 28.12.2017, 17:22, "Ozgur" <[email protected]>:
> > 28.12.2017, 16:31, "Aishwarya Pant" <[email protected]>:
> >> ?Hi
>
> Hello,
>
> >> ?In Documentation/rtc.txt, there is a description of the sysfs
> >> ?interface which could be moved to Documentation/ABI.
> >>
> >> ?Would such a change be useful?
> >>
> >> ?The ABI documentation format looks like the following:
> >>
> >> ?What: (the full sysfs path of the attribute)
> >> ?Date: (date of creation)
> >> ?KernelVersion: (kernel version it first showed up in)
> >> ?Contact: (primary contact)
> >> ?Description: (long description on usage)
> >>
> >> ?I am doing this in an exercise to move sysfs ABI interfaces (which are
> >> ?documented) to their right place i.e. in Documentation/ABI along with the rest.
>
> Do I understand right? Are you want to make the rtc.txt part the same format as ABI folder?
> for example create to RTC folder and add /dev/rtc what, date, kernelversion, contact right?
Yes I mentioned just the sysfs interface. But both ioctl and sysfs interface
should be there in Documentation/ABI. There could a new file called sysfs-rtc in
Documentation/ABI/stable with both these interfaces.
>
> This can be a good idea and I can help.
Sure thanks. I can maybe send a patch with these changes.
One question: who should be the primary contact for this ABI?
>
> >> ?Aishwarya
>
> Ozgur
28.12.2017, 18:00, "Aishwarya Pant" <[email protected]>:
> On Thu, Dec 28, 2017 at 05:23:33PM +0300, Ozgur wrote:
>> 28.12.2017, 17:22, "Ozgur" <[email protected]>:
>> > 28.12.2017, 16:31, "Aishwarya Pant" <[email protected]>:
>> >> Hi
>>
>> Hello,
>>
>> >> In Documentation/rtc.txt, there is a description of the sysfs
>> >> interface which could be moved to Documentation/ABI.
>> >>
>> >> Would such a change be useful?
>> >>
>> >> The ABI documentation format looks like the following:
>> >>
>> >> What: (the full sysfs path of the attribute)
>> >> Date: (date of creation)
>> >> KernelVersion: (kernel version it first showed up in)
>> >> Contact: (primary contact)
>> >> Description: (long description on usage)
>> >>
>> >> I am doing this in an exercise to move sysfs ABI interfaces (which are
>> >> documented) to their right place i.e. in Documentation/ABI along with the rest.
>>
>> Do I understand right? Are you want to make the rtc.txt part the same format as ABI folder?
>> for example create to RTC folder and add /dev/rtc what, date, kernelversion, contact right?
>
> Yes I mentioned just the sysfs interface. But both ioctl and sysfs interface
> should be there in Documentation/ABI. There could a new file called sysfs-rtc in
> Documentation/ABI/stable with both these interfaces.
Hello,
I think the ABI maintainer is API group but I think you have contact to linux documentation team.
maybe, Greg provide a give information:
>> This can be a good idea and I can help.
>
> Sure thanks. I can maybe send a patch with these changes.
>
> One question: who should be the primary contact for this ABI?
I add linux-api mailing lists. So, please send a your patch linux-kernel and linux-api mailing lists.
Ozgur
>> >> Aishwarya
>>
>> Ozgur