Many documentation updates

git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@408 7894878c-1315-0410-8ee3-d5d059ff63e0

CHANGES

@@ -13,6 +13,19 @@ ask CVS about it:
     for example:
       cvs diff -r V2-0-0 -r V2-0-1 -u
 
+2.3.0 (19990424)
+  All: Many, many changes and improvements
+  All: Many small bugs and problems removed
+  Modules: New insmod parameters
+  Modules: Much improved chip detection
+  Module maxilife: NEW
+  Module adm1021: MAX1617A now also supported
+  Module adm9024: DS1780 now also supported
+  Module w83781d: W83782D and W83783S now also supported
+  Program sensors-detect: NEW
+  Library: All chips now supported
+  Documentation: Very much improved
+
 2.2.1 (19990218)
   All: Removed compile warnings
   Module i2c-dev: Small bug removed if DEBUG=1 was used

INSTALL

@@ -54,6 +54,9 @@ Some interesting Makefile variables:
   The directory where 'make install' installs the shared and static libraries.
 * BINDIR ($(PREFIX)/bin)
   The directory where 'make install' installs all executables.
+* SBINDIR ($(PREFIX)/sbin)
+  The directory where 'make install' installs all system programs (programs
+  which can only be run by root).
 * INCLUDEDIR ($(PREFIX)/include)
   The base directory where 'make install' installs your include files.
   Actually, SYSINCLUDEDIR ($(INCLUDEDIR)/linux) is used for kernel header
@@ -92,6 +95,7 @@ TESTING AND RUNNING
 When you have compiled this package, you will be left with a lot of modules.
 It can be tricky to know which modules you need to insert. For this reason,
 I suggest you go the 'modprobe' way, as described within doc/modules.
+
 If you just want to run a test without installing them, try the following:
   insmod i2c/i2c-core.o
   insmod kernel/smbus.o
@@ -109,10 +113,12 @@ do:
   modprobe i2c-isa && modprobe i2c-piix4 && modprobe lm78 && modprobe i2c-proc
 (the last is optional) from any directory to reach the same situation.
 
-There is a program 'detect.pl' in prog/detect which should tell you at least
-what bus driver you should insert. This program is not completely failsafe,
-but it may at least help. It will be expanded to cover chip detection too,
-in the future.
+But instead of doing any of the above things, please read doc/modules and
+do a 'make install'. After that, you can run 'sensors-detect'. This Perl
+program will detect all hardware available on your system, and tell you
+what drivers you need to insert. First check whether you have /dev/i2c-*
+files (at least 4 of them), and if not, create them by running 'mkdev.sh'
+in directory prog/mkdev.
 
 Do not panic if some (or all) of the values in the /proc/sys/dev/sensors/*/*
 files do not seem to correspond to anything in earlier versions. Starting

README

@@ -18,20 +18,25 @@ At least the following SMBus adapters are supported:
 
 At least the following hardware sensor chips are supported:
   National Semicoductor LM75, LM78, LM78-J, LM79 and LM80
-  Winbond W83781D
-  Genesys Logic GL518SM
+  Winbond W83781D, W83782D and W83783S
+  Genesys Logic GL518SM (several revisions)
   Analog Devices ADM1021 and ADM9240
   SiS Southbridge (integrated in the chipset; the I2C adapter will also be
     supported in the near future)
-  Maxtor MAX1617
+  Maxtor MAX1617 and MAX1617A
+  Dallas Semiconductor DS1780
+  Hewlett Packard Maxilife (several revisions)
+
+We also support some miscellaneous chips:
+  Linear Technologies LTC1710
+  Dimms with EEPROMs
 
 We could use some testers of hardware. If you own a specific monitoring
 chip or I2C bus, and are willing to help us out, please contact us - even
 if you did so before. Even if you have no programming knowledge, you could
 help us by running new modules and reporting on the results and output. 
 If you want to offer more substantial help, this is very welcome too, of
-course. We have access to LM78(-J), LM79, LM75, Winbond W83781D and
-GL518SM chips, and PIIX4 and VIA chipsets.
+course.
 
 
 SMBus, also known as System Management Bus, is a protocol for communicating
@@ -58,8 +63,8 @@ Please read INSTALL before trying to compile and install these modules.
 There is a lot of additional documentation in the doc/ subdirectory.
 Amnong these is a list of supported busses and chips. Regrettably, there
 are too many mainboards to keep a list of busses and chips used on them.
-We will provide a user-space utility which probes for the presence of
-chips and busses in one of the next releases.
+On the other hand, we provide a program called 'sensors-detect' which
+tries to figure out what hardware is available on your system.
 
 The developers of this package can be reached through the email address
 <lm78@stimpy.netroedge.com>. Do not hesitate to mail us if you have questions,

README.directories

@@ -6,7 +6,7 @@ The directories within this package:
   Packages from other sources. Currently, it contains Simon Vogl's i2c code
   (mod-????????.tar.gz).
 * doc
-  Documentation about the modules within this package
+  Documentation about the modules within this package, and all other things
 * etc
   Configuration files
 * i2c

TODO

@@ -3,7 +3,6 @@ Many, many things. Most notably:
 KERNEL MODULES
 ==============
 
-* Module documentation!!!
 * maxilife.c: Introduce new insmod variables
 * maxilife.c: Round REG_TO_VID correctly
 * icspll.c: Rewrite. The current implementation simply can't work at all.
@@ -54,7 +53,6 @@ LIBRARY
 * Some library routines are pretty inefficient right now.
 * Library should be split in more separate files, for better linking
   behaviour.
-* Many chips are not yet supported by the library.
 
 PROGRAMS
 ========