Documenting the VFS

Guillermo López Alejos
2005-08-13T19:05:06Z

Hi,

I'm writing documentation about the VFS. More concretely, I want to
document the following information about the methods defined in the
VFS interface (i.e. the struct *_operations):
- Prototype.
- Description (brief description of what the method has to do).
- Description of the parameters (explanation of the purpose of
each parameter).
- Return value (including possible error values).
- Responsibility (what the method is expected to do, including
specific cases).
- Default method (is there any method that can be used instead of
defining a new one?)
- Mandatory (Is the method mandatory? or it can be assigned a NULL?)

It is rather difficult to find this information by looking at the
kernel sources, and the documentation I have found does not provide
the details I'm looking for.

Where can I found an up to date documentation about the VFS interface?
If there is no such document, which is the correct mailing list to
submit my questions at? Is there any IRC channel to chat about this?
(I have visited a couple of times #kernelnewbies).

Thanks for your help and regards,

--
Guillermo