From: Martin Dalecki <dalecki@evision-ventures.com>
To: Gabor Kerenyi <wom@tateyama.hu>
Cc: linux-kernel@vger.kernel.org
Subject: Re: driver documentation
Date: Thu, 13 Jun 2002 13:03:52 +0200 [thread overview]
Message-ID: <3D087C18.6010406@evision-ventures.com> (raw)
In-Reply-To: <200206131954.41348.wom@tateyama.hu>
Użytkownik Gabor Kerenyi napisał:
> Hi!
>
> I have written a driver for a PCI card (produced by the company I work
> for) and it's working well. Now I should write a documentation, but
> I have never done such kind of low level tasks in a PC enviroment.
> I know what design docs and other docs are needed for a normal
> program (C, C++) but I have no idea how I could write a doc
> for a driver.
>
> Is there any template there? I bet you also had to write documentations
> if you work for a company.
>
> Can anybody give some advice? Of course I would like to write it
> using Linux, so please don't mention M$ only sws! (bad news that
> my boss would like to view it on M$ :(((( )
>
> (ps. I don't like flowcharts...)
Since I assume that the request is about documenting the
internals of the driver, I recommend that you look at
the javadoc similar embedded documentation mechanism found in
recent linux kernels. Just type in make doc on the top level
and see. Well if you are looking at what to put in there:
Just please look after the corresponding comments throughout
the kernel.
prev parent reply other threads:[~2002-06-13 11:03 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2002-06-13 10:54 driver documentation Gabor Kerenyi
2002-06-13 11:03 ` Martin Dalecki [this message]
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=3D087C18.6010406@evision-ventures.com \
--to=dalecki@evision-ventures.com \
--cc=linux-kernel@vger.kernel.org \
--cc=wom@tateyama.hu \
/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