Changeset 1175

Show
Ignore:
Timestamp:
09/08/01 18:27:32 (7 years ago)
Author:
mds
Message:

updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • lm-sensors/trunk/doc/developers/new_drivers

    r1097 r1175  
    1515  Tell us it's OK to put your name on the "New Drivers" page. 
    1616 
     17* Check out our latest code from CVS. 
     18  You should use this as a base for your development. 
     19  See instructions on our download page. 
     20 
    1721* Write the new driver.  
    1822  For a chip driver, use lm78.c as template. For an SMBus-only adapter,  
    …… 
    2529  the configuration file. 
    2630 
    27 * Meet Kernel coding standards 
     31* Meet Kernel coding standards. 
    2832  See Documentation/CodingStyle in the kernel source. 
    2933  Be sure and use 8 column tabs. 
    3034 
    31 * Add the driver to the Module.mk (makefile) 
     35* Meet /proc naming standards in the ctl_table (for chip drivers only). 
     36  See doc/developers/proc for information. 
     37 
     38* Add the driver to the Module.mk (makefile). 
    3239  Usually, you can just add it to KERNEL{CHIPS,DRIVERS}TARGETS in the 
    3340  Module.mk file in the directory itself. 
    …… 
    4148  information. 
    4249 
    43 * Check for external symbols 
     50* Check for external symbols. 
    4451  'nm --extern --defined' should only output symbols starting with __module, 
    4552  cleanup_module, init_module and some kernel versioning symbols. Mark all 
    4653  other symbols as static in your source file. 
    4754 
    48 * Test the module 
     55* Test the module. 
    4956  This is usually the boring part... 
    5057  Test both with 2.2.x and 2.4.x kernels. 
    5158 
    52 * Add detection information to prog/detect/sensors-detect 
     59* Add detection information to prog/detect/sensors-detect. 
    5360  This is a perl script that automatically detects what chips and adapters 
    54   are present. Contact Frodo if you need help. 
     61  are present. Contact us if you need help. 
    5562 
    56 * Add chip information to lib/chips.{c,h} (for chip drivers only) 
     63* Add chip information to lib/chips.{c,h} (for chip drivers only). 
    5764  Until you have done this, the chip will be invisible for user-level 
    58   programs. Again, contact Frodo if you need help with this. 
     65  programs which use libsensors. Use standard names in lib/chips.c; 
     66  see also the comments in etc/sensors.conf.eg for help. 
     67  Contact us if you need more assistance. 
    5968 
    60 * Add entries to etc/sensors.conf.eg (for chip drivers only) 
     69* Add entries to etc/sensors.conf.eg (for chip drivers only). 
    6170  If needed, you can set defaults here. 
    6271 
    63 * Add a dedicated procedure to prog/sensors/chips.[ch] (for chip drivers only) 
    64   This makes the included sensors program pretty-print your chip information. 
     72* Add a procedure to prog/sensors/chips.[ch] (for chip drivers only). 
     73  This is a function specific for your driver that 
     74  makes the included 'sensors' program pretty-print your chip information. 
    6575 
    6676* Add the name of the device to the README file. 
    …… 
    7282* Write a doc/chips/xxx or doc/busses/xxx file. 
    7383 
    74 * Make sure the GPL boilerplate and your name (and if applicable your 
    75   company's name) is at the top of the 
     84* Clearly specify licensing and copyright. 
     85  Make sure the GPL boilerplate and your name 
     86  (or if applicable your company's name) is at the top of the 
    7687  new driver so we know you are giving it to us under the GPL. 
    7788 
    78 * Submit the changes to us a patch against CVS. 
     89* Submit the changes to us. 
     90  Check out a clean version of CVS again (things will have changed since 
     91  you started), then submit the changes to us as a patch against CVS. 
    7992 
    8093---------------------------------------------------------------------