DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 
Guidelines for all kernel drivers

Documentation

Proper documentation is essential for drivers being productized.

Each driver should be accompanied by the following information.

One way to provide this information is to create a Section 7 or Section HW manual page that installs with the driver software.

Drivers for devices that are configured with a ScoAdmin manager (such as network and graphics adapter cards) should include relevant information in a context-sensitive file that is installed with the ODSSI tools as part of the driver installation process. See ``Creating help files for network driver configuration'' for instructions and sample files specific to MDI drivers.

We recommend that driver writers generate a functional specification, test plan, and test report. The discipline of writing such documents often improves the quality of the code, and the information is invaluable when maintenance work is required at a later date.


© 2005 The SCO Group, Inc. All rights reserved.
OpenServer 6 and UnixWare (SVR5) HDK - June 2005