Hi
In Documentation/infiniband/sysfs.txt, there is a description of the infiniband
sysfs interface and there also exists
Documentation/ABI/testing/sysfs-class-infiniband which is out of date.
Would it be useful to move out the interface completely from
Documentation/infiniband/sysfs.txt to the ABI?
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
On Mon, Jan 08, 2018 at 02:23:42PM +0530, Aishwarya Pant wrote:
> Hi
>
> In Documentation/infiniband/sysfs.txt, there is a description of the infiniband
> sysfs interface and there also exists
> Documentation/ABI/testing/sysfs-class-infiniband which is out of date.
>
> Would it be useful to move out the interface completely from
> Documentation/infiniband/sysfs.txt to the ABI?
It would be good, but I fear all the documentation files are variously
out of date, so it would be harder to do this task reliably without
having various rdma devices to inspect?
But if you want to take it on, I could probably get you some sysfs
dumps from some systems to help?
Jason
On Tue, Jan 09, 2018 at 10:28:20AM -0700, Jason Gunthorpe wrote:
> On Mon, Jan 08, 2018 at 02:23:42PM +0530, Aishwarya Pant wrote:
> > Hi
> >
> > In Documentation/infiniband/sysfs.txt, there is a description of the infiniband
> > sysfs interface and there also exists
> > Documentation/ABI/testing/sysfs-class-infiniband which is out of date.
> >
> > Would it be useful to move out the interface completely from
> > Documentation/infiniband/sysfs.txt to the ABI?
>
> It would be good, but I fear all the documentation files are variously
> out of date, so it would be harder to do this task reliably without
> having various rdma devices to inspect?
>
> But if you want to take it on, I could probably get you some sysfs
> dumps from some systems to help?
Yes, I think that would be useful. I might not be able to fill in the
descriptions completely for all attributes but I can create a documentation
skeleton for them.
Aishwarya
>
> Jason