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.


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

1 files changed, 15 insertions, 54 deletions

diff --git a/INSTALL b/INSTALL
index c7ea4e89..89a53585 100644
--- a/INSTALL
+++ b/INSTALL
@@ -40,8 +40,8 @@ Option 1 is much easier and is recommended.
 Each of these ways will be described below in detail.
 
 NOTE: MAKE SURE YOU HAVE THE I2C-ALGO-BIT DRIVER (PART OF THE I2C PACKAGE)
-      COMPILED INTO YOUR KERNEL OR AVAILABLE AS A MODULE; SOME SENSORS
-      DRIVERS DEPEND ON IT!
+      COMPILED INTO YOUR KERNEL OR AVAILABLE AS A MODULE; SOME I2C/SMBUS
+      MASTER DRIVERS DEPEND ON IT!
 
 NOTE: IN EACH CASE, YOU WILL HAVE TO GET AND INSTALL THE I2C PACKAGE FIRST!
       SET COMPILE_KERNEL TO 0 IN THE MAIN MAKEFILE FOR OPTION 2, UNLESS
@@ -96,7 +96,7 @@ a very new kernel which already has limited or full i2c or lm_sensors
 support, but you want to use newer versions of the drivers. This is
 possible, but there are some pitfalls.
 
-If had compiled all i2c and lm_sensors drivers as modules, you are 
+If you had compiled all i2c and lm_sensors drivers as modules, you are 
 in luck. You can simply compile the newest versions of i2c and
 lm_sensors and install them. Just make sure the right modules are
 loaded (best bet: remove the old ones first).
@@ -124,9 +124,9 @@ having a different version of the kernel running than the version of the
 kernel header files against which you compiled it. But a perfect match
 is needed for the first two compilation options above.
 
-Let's say you want to use the lm_sensors modules with the kernel 2.1.12 you
+Let's say you want to use the lm_sensors modules with the kernel 2.4.32 you
 are running now. What you need, is the original tree in which you
-compiled that 2.1.12 kernel. A freshly unpacked 2.1.12 kernel will not
+compiled that 2.4.32 kernel. A freshly unpacked 2.4.32 kernel will not
 cut it, because `make *config dep' creates some files that are needed.
 And even then, you will run into trouble, because you may not have
 selected the exact same configuration variables. Plain advise: if you
@@ -144,11 +144,6 @@ modules because of either a `kernel-module version mismatch' or because
 of `unresolved kernel symbols'. If you get either of these messages,
 check your kernel tree!
 
-Note that some distributions are notably bad at this. To offset this
-somewhat, not the files in /usr/include/{linux,asm} are used, but instead
-those in /usr/src/linux/include/{linux,asm}. It is also possible to
-tell the Makefile the kernel is somewhere else than at /usr/src/linux.
-
 To keep problems to a minimum, please use a 'vanilla' kernel tree,
 as distributed on ftp://ftp.kernel/org/pub/linux/kernel, and not one
 patched by your distribution.
@@ -250,28 +245,13 @@ MANGRP (default: root)
   Group of manual pages.
 
 
-
-Handling the modules (compilation option 1)
-===========================================
-
-Run the command `depmod -a' to have the new modules recognised. Most
-distributions run this command when you boot, so if you were cross-
-compiling, you can skip this step.
-
-See doc/modules for a more detailed treatment.
-
-
 Patching the kernel (compilation option 2)
 ==========================================
 
 There is a special script which should be able to generate diffs against
-any 2.2 or 2.4 kernel (2.4.0 or later). Note that 2.3 kernels are no 
-longer supported for this compilation option (choose option 1 instead). 
-Please report any problems to our mailinglist. Note that it may fail, 
-and probably silently, if you have applied other patches to your kernel \
-tree, or for very new kernels.  It *is* safe to run it if your kernel 
-already has the lm_sensors drivers.  It will only work if you applied the 
-i2c patches first.
+any 2.4 kernel (2.4.10 or later).  Please report any problems to our
+mailing list.  It *is* safe to run it if your kernel already has the
+lm_sensors drivers.  It will only work if you applied the i2c patches first.
 
 ** Only a subset of the modules in lm_sensors are patched into the        **
 ** kernel by the script. See the file mkpatch/FILES to see if the         **
@@ -283,12 +263,12 @@ The kernel diffs are generated by the program `mkpatch.pl' in the mkpatch
 subdirectory. It needs two arguments: the first one is the root of the
 lm_sensors package, the second one is the root of the kernel tree against
 which the diffs will be generated. For example:
-  cd /tmp/lm_sensors-2.4.0
-  mkpatch/mkpatch.pl . /usr/src/linux > /tmp/sensors-patch
+  cd /tmp/lm_sensors-2.10.0
+  mkpatch/mkpatch.pl . /usr/src/linux > /tmp/sensors-2.10.0.patch
 You can apply the diffs as usual:
   cd /usr/src/linux
-  patch -p1 -E < /tmp/sensors-patch
-Genearation and application can easily be done in one step:
+  patch -p1 -E < /tmp/sensors-2.10.0.patch
+Generation and application can easily be done in one step:
   mkpatch/mkpatch.pl . /usr/src/linux | patch -p1 -E -d /usr/src/linux
 The generated diffs are of course only valid for the kernel version 
 against which mkpatch.pl was run.
@@ -314,14 +294,10 @@ i2c device files in the /dev directory. They are called /dev/i2c-%d,
 and are character devices with major device number 89 and minor device 
 number %d. The script prog/mkdev/mkdev.sh will create the files for you.
 
-There is a special scanning program installed called sensors-detect. It
+There is a scanning program installed called sensors-detect. It
 will scan all available I2C and SMBus adapters for all known devices,
-and give you a list of what modules you need to insert. It is written in
-Perl, and you will need at least Perl 5.004 to run it successfully.
-
-If `sensors' returns some error message about not being able to load
-libsensors, you have to add the directory in which it is installed
-(by default /usr/local/lib) to /etc/ld.so.conf and run `ldconfig'.
+and will also look for ISA, PCI and Super-I/O chips with sensors,
+and give you a list of what modules you need to insert.
 
 You can use the installed sensors program to get a report of all detected
 sensor devices. There is also a manual page for this program. Calling
@@ -331,18 +307,3 @@ information.
 
 There are many auxiliary programs not installed. You can find them under
 the prog subdirectory. A list can be found in doc/progs.
-
-
-Old and new I2C drivers
-=======================
-
-In the current 2.2 and 2.3 kernels, there are already I2C drivers, but
-they are not the same ones as in this package. They are much older, and
-have a very limited functionality compared with the drivers included
-here. Fortunately, they can co-exist peacefully, so you should not worry
-about it. Except for one thing: `#include <linux/i2c.h>' can cause the
-wrong header file to be included. If you patched the kernel (compilation
-option 3), you will have to use `#include <linux/i2c-old.h>' to include
-the old ones; in all other cases, including the old ones will probably
-be impossible without copying them explicitly to some place that will
-be checked first.