Re: How to document dimension units for virtual files?

[Michael Holzheu]

Greg,

Greg KH <greg@xxxxxxxxx> wrote on 11/10/2006 07:53:36 AM:

> On Wed, Nov 08, 2006 at 07:27:56PM +0100, Michael Holzheu wrote:
> > If you want to export data to userspace via a virtual filesystem
> > like sysfs, the following rules are recommended:
>
> Um, does this mean you expect us to change all of the currently existing
> sysfs file names?  And people get mad at me when I just move sysfs
> symlinks around...

No, of course we should not change existing kernel interfaces.

> Look at the hwmon drivers, and the documentation in
> Documentation/hwmon/sysfs-interface for a description of how we have
> been documenting this already.

Yes, it is an option to document units in seperate files. But I personally
think,
that this is only the second best solution. Especially since normally
documentation is not read.

>
> In short, I don't really think we need to encode the units in the file
> name, somehow we have done pretty well without it so far :)

Why not trying to make things better than they used to be?

At least for our s390_hypfs I would like to use the suggested naming
scheme. It is new and therefore not burdened with other naming
conventions. Ok?

So, no "Documentation/filesystems/ExportData" patch?

Michael

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/