From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id ; Thu, 13 Jun 2002 06:59:07 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id ; Thu, 13 Jun 2002 06:59:06 -0400 Received: from cttsv008.ctt.ne.jp ([210.166.4.137]:21928 "EHLO cttsv008.ctt.ne.jp") by vger.kernel.org with ESMTP id convert rfc822-to-8bit; Thu, 13 Jun 2002 06:59:05 -0400 Content-Type: text/plain; charset="us-ascii" From: Gabor Kerenyi To: linux-kernel@vger.kernel.org Subject: driver documentation Date: Thu, 13 Jun 2002 19:54:41 +0900 X-Mailer: KMail [version 1.4] MIME-Version: 1.0 Content-Transfer-Encoding: 8BIT Message-Id: <200206131954.41348.wom@tateyama.hu> Sender: linux-kernel-owner@vger.kernel.org X-Mailing-List: linux-kernel@vger.kernel.org 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...) Thanks Gabor