public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: "Guillermo López Alejos" <glalejos@gmail.com>
To: Linux Kernel mailing list <linux-kernel@vger.kernel.org>
Subject: Documenting the VFS
Date: Sat, 13 Aug 2005 21:05:03 +0200	[thread overview]
Message-ID: <4fec73ca05081312054f1d1dd9@mail.gmail.com> (raw)

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

             reply	other threads:[~2005-08-13 19:05 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-08-13 19:05 Guillermo López Alejos [this message]
2005-08-13 19:55 ` Documenting the VFS Stephane Wirtel
2005-08-18  7:55 ` Daniel Phillips
  -- strict thread matches above, loose matches on Subject: below --
2005-08-13 20:47 Steve French

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=4fec73ca05081312054f1d1dd9@mail.gmail.com \
    --to=glalejos@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    /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