Show
Ignore:
Timestamp:
09/24/06 18:36:34 (2 years ago)
Author:
khali
Message:

Documentation update. I tried to remove or update all outdated stuff, it
looks better now, but that's still quite a mess which we'd need to cleanup.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • lm-sensors/trunk/README

    r4170 r4173  
    99OVERVIEW OF THE LM_SENSORS PACKAGE AND SUMMARY OF SUPPORTED DEVICES 
    1010 
    11 !!! This package is ONLY for 2.6, 2.5, and 2.4 kernels (2.4.10 or later) !!! 
    12 !!! THIS PACKAGE REQUIRES i2c-2.9.0 or later!!! 
     11!!! This package is ONLY for 2.6 and 2.4 kernels (2.4.10 or later).  !!! 
     12!!! For 2.4 kernels, this package requires i2c-2.9.0 or later.        !!! 
    1313 
    14 FOR 2.6/2.5 KERNELS, use only the userspace tools in this package! 
     14FOR 2.6 KERNELS, use only the userspace tools in this package! 
    1515Build and install them with 'make user' and 'make user_install'. 
    16 The kernel modules in this package will not compile for 2.6/2.5; 
     16The kernel modules in this package will NOT compile for 2.6; 
    1717use the drivers already in the 2.6 kernel. 
    1818 
    …… 
    2626kernels only (2.4.10 and later). 
    2727Use lm_sensors-2.4.5 for 2.0 kernels. 
    28 Use lm_sensors-2.7.0 for 2.2, 2.3, and 2.4.0 - 2.4.9 kernels. 
    29 Use the drivers already in the kernel for 2.6/2.5 kernels; if you need 
     28Use lm_sensors-2.7.0 for 2.2, and early 2.4 (up to 2.4.9) kernels. 
     29Use the drivers already in the kernel for 2.6 kernels; if you need 
    3030additional drivers in 2.6 please port and submit them to us. 
    3131 
    3232HOWEVER, the userspace tools in this package will work for 
    33 2.4, 2.5, and 2.6 kernels. 
    34  
    35 WARNING! You must have at least i2c-2.9.0. 
    36 EVEN IF your kernel does contain i2c support! 
     33both 2.4 and 2.6 kernels. 
    3734 
    3835The I2C[2] package in existing 2.4 kernels is NOT sufficient 
    39 for compilation of this package. 
    40  
    41 ADDITIONALLY, i2c-2.9.0 is API compatible to i2c releases 2.7.0 and earlier, 
    42 but is not API compatible to i2c releases 2.8.0 - 2.8.8 
    43 due to struct changes. Versions 2.8.x of i2c are considered deprecated. 
     36for compilation of this package. You need i2c-2.9.0 or later. 
    4437 
    4538See the lm_sensors download page for further guidance: 
    4639  http://www.lm-sensors.org/wiki/Download 
    4740 
    48  
    49 WARNING! If you downloaded this package through our SVN archive, you walk 
    50 the cutting edge. Things may not even compile! On the other hand, you will 
    51 be the first to profit from new drivers and other changes. Have fun! 
    5241 
    5342============================================================================= 
    …… 
    6049  ATI IXP200, IXP300, IXP400 
    6150  DEC 21272/21274 (Tsunami/Typhoon - on Alpha boards) 
    62   Intel I801 ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6 (82801xx), 6300ESB, ICH7 
     51  Intel I801 ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6/ICH7/ICH8 (82801xx), 6300ESB 
    6352  Intel PIIX4 (used in many Intel chipsets) 
    6453  Intel I810/I810E/I815/I845G GMCH 
    …… 
    8473  Genesys Logic GL518SM, GL520SM, GL523SM 
    8574  Intel Xeon processor embedded sensors 
    86   ITE IT8705F, IT8712F embedded sensors 
     75  ITE IT8705F, IT8712F 
    8776  Maxim MAX1617, MAX1617A, MAX1619, MAX6650, MAX6651, 
    8877        MAX6633, MAX6634, MAX6635, MAX6657, MAX6658, MAX6659 
    …… 
    121110 
    122111 
    123 We always appreciate testers. If you own a specific monitoring chip listed 
    124 on our 'new drivers' page, and are willing to help us out, please contact 
     112We always appreciate testers. If you own a specific monitoring chip we do 
     113not yet (properly) support, and are willing to help us out, please contact 
    125114us. Even if you have no programming knowledge, you could help us by running 
    126115new modules and reporting on the results and output. If you want to offer 
    …… 
    131120We *do* know what hardware we support, but usually, it is easier to 
    132121install everything and run sensors-detect. It will tell you what hardware 
    133 you have (and incidentally, what corresponding drivers are needed). You 
    134 could also take a look at http://mbm.livewiredev.com/ 
    135 (this lists chips found on many mainboard, but regrettably not the adapters 
    136 on them) or http://web01.fureai.or.jp/~hirobo/project/reserch_project.html 
    137 (yes, it is Japanese; you want the ninth column, and it again lists only 
    138 chips, not adapters). 
     122you have (and incidentally, what corresponding drivers are needed). 
    139123 
    140124 
    …… 
    162146Please read INSTALL before trying to compile and install these modules. 
    163147There is a lot of additional documentation in the doc/ subdirectory. 
    164 Amnong these is a list of supported busses and chips. Regrettably, there 
    165 are too many mainboards to keep a list of busses and chips used on them. 
    166 On the other hand, we provide a program called 'sensors-detect' which 
    167 tries to figure out what hardware is available on your system. 
    168148 
    169149The developers of this package can be reached through a mailing-list 
    …… 
    173153read the documentation and FAQ before you ask any questions! 
    174154 
    175 The latest version of this package can always be found on our homepage: 
    176 http://www.lm-sensors.org. Pre-release versions can be retrieved 
    177 through anonymous SVN; see doc/svn for details. 
     155The latest version of this package can always be found at: 
     156http://www.lm-sensors.org/wiki/Download. Pre-release versions can be 
     157retrieved through anonymous SVN; see doc/svn for details. 
    178158 
    179159This package may be distributed according to the GNU General Public