Updated some documentation files.

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

CHANGES

@@ -7,13 +7,30 @@ ask CVS about it:
   * Determine which tags are valid, by running this command from the
     project root directory:
       cvs status -v -l Makefile
-    Valid tags are usually like form V-2-1-0 for version 2.1.0
+    Valid tags are usually like form V2-1-0 for version 2.1.0
   * Ask cvs for the difference between two versions:
       cvs diff -r TAG1 -r TAG2 DIFF-OPTIONS
     for example:
       cvs diff -r V2-0-0 -r V2-0-1 -u
 
-2.1.2 (19980116)
+2.2.0 (199902??)
+  All: Set copyrights to include 1999
+  All: Small bugfixes
+  I2C: Upgraded to newest archive of Simon Vogl
+  Module i2c-dev: NEW
+  Module i2c-ali15x3: NEW
+  Module i2c-via: This is old module bit-mb, now moved to the main lm_sensors
+     directories, and somewhat improved
+  Module sis5595: NEW
+  Modules: Renamed all bus modules to i2c-*, new directory lay-out
+  Library: Support for new chip drivers, several small bugs fixed
+  Library manual pages: NEW
+  Program i2cdetect: Moved to detect directory
+  Program detect.pl: NEW
+  Program doc-features: NEW
+  Program sensors: Added man-page
+  
+2.1.2 (19990116)
   Modules lm80.o, w83781d.o: fan-related Segmentation fault corrected
   Module gl518sm.o: yet more bug fixes. It should at long last be usable now
   Documentation in doc/kernel: NEW

CONTRIBUTORS

@@ -15,13 +15,15 @@ problems.
 * Frodo Looijaard <frodol@dds.nl>
   Took up the development of Alex' lm78 module. Large pieces of code were
   written by him. Designed lm_sensors version 2, and wrote most of its
-  core code.
+  core code, including many drivers.
 * William Morgan <wmorgan@cmu.edu>
   Helped with some patches in lm_sensors version 1. He provided us with
   the original CVS archive, and even managed to explain to us how to use
   it.
 * Kyösti Mälkki <kmalkki@cc.hut.fi>
-  Author of the i2c-via and sis5595 driver.
+  Author of the i2c-via and sis5595 drivers.
+* Mark D. Studebaker <mds@eng.paradyne.com>
+  Author of the i2c-ali15x3 driver.
 
 * Simon Vogl <simon@tk.uni-linz.ac.at>
   Wrote the new i2c kernel driver. This driver is indispensable for the

INSTALL

@@ -38,19 +38,25 @@ this package. Some interesting variables:
 * BINDIR ($(PREFIX)/bin)
   The directory where 'make install' installs all executables.
 * INCLUDEDIR ($(PREFIX)/include)
-  The basic directory where 'make install' installs your include files.
+  The base directory where 'make install' installs your include files.
   Actually, SYSINCLUDEDIR ($(INCLUDEDIR)/linux) is used for kernel header
   files, and LIBINCLUDEDIR ($(INCLUDEDIR)/sensors) is used for library
   header files.
+* MANDIR ($(PREFIX)/man)
+  The base directory where manual pages are installed. 
+* MANOWN, MANGRP (root, root)
+  Owner and group of installed manual pages
 
-Warning! In newer 2.1 kernels, there is support for I2C. This support is
-NOT compatible with this module! Actually, Simon Vogl's modules package 
+Warning! In 2.2 and newer 2.1 kernels, there is support for I2C. This support 
+is NOT compatible with this module! Actually, Simon Vogl's modules package 
 (which IS compatible) is scheduled to replace the current support. If you
 actually use these modules, you have a problem; they can not coexist
 with Simon's modules. Theoretically, you should be able to replace
 the old modules in the kernel tree with the new stuff in our i2c directory,
 recompile the kernel, and then compile our modules with I2C=0. If you try
-this, please share the results with us!
+this, please share the results with us! There have also been some rumors
+about the peaceful coexistence of both sets of modules, but others found
+some problems with it.
 
 Please make sure that /usr/include/linux and /usr/include/asm are symlinks 
 into the kernel tree which corresponds with the kernel version you are using
@@ -68,12 +74,13 @@ 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 src/i2c-proc.o
-  insmod src/smbus.o
-  insmod src/sensors.o
-  insmod src/isa.o
-  insmod src/piix4.o  # Or whatever SMBus controller you have
-  insmod src/lm78.o   # Or whatever hardware monitoring chip you have
+  insmod kernel/i2c-proc.o
+  insmod kernel/i2c-dev.o
+  insmod kernel/smbus.o
+  insmod kernel/sensors.o
+  insmod kernel/busses/isa.o
+  insmod kernel/busses/piix4.o # Or whatever SMBus controller you have
+  insmod kernel/chips/lm78.o   # Or whatever hardware monitoring chip you have
 Now you should have new directories under /proc/sys/dev/sensors and some files
 beginning with i2c in /proc/bus.
 
@@ -81,6 +88,11 @@ If you have installed the modules, as described within doc/modules, you can
 do 'modprobe isa && modprobe 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.
+
 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
 with lm_sensors version 2.1.0, these files will reflect the real chip
@@ -93,15 +105,17 @@ access sensor data in a more programmer-friendly way. It will be built as
 both a shared and a static library, and installed in your LIB directory
 (normally /usr/local/lib). It needs a configuration file, which is usually
 called 'sensors.conf', and can be placed in /etc, /usr/lib/sensors,
-/usr/local/lib/sensors, /usr/lib, or /usr/local/lib. [NOTE: No real
-config file documentation is written yet. A relatively well-commented
-example can be found in the etc directory.]
+/usr/local/lib/sensors, /usr/lib, or /usr/local/lib.
+
+Note that if you already have a config file, it is NOT overwritten! You
+may still want to do this by hand (`cp etc/sensors.conf.eg /etc/sensors.conf')
+as the example config file may be updated.
 
 Where version 1 of this package had the human-readable /proc/sensors file,
 this version includes a user-space program which gathers all data
 and displays it in a comparable format. This program is called 'sensors'.
 Everybody can use it to read sensors values; only root can use it to
-set minimum and maximum values.
+set minimum and maximum values (using the `-s' switch).
 
 If you want to run 'sensors' without installing the package, you must
 use the following command to make it able to find its shared library:
@@ -110,13 +124,6 @@ use the following command to make it able to find its shared library:
 Replace /WHEREVER/lm_sensors-2.X.Y with the base directory of the package
 source code.
 
-One of the next releases of this package will have a user-space probe program,
-which tells you which chips and busses are present, and which modules you
-will have to load. At this moment, just try to load the modules; if no chip
-or bus is detected, the module will fail to insert. [NOTE: not true for
-the bit-lp.o and bit-elv.o drivers. Don't try them without expecting 
-fake devices]
-
 Please examine the files in the doc subdirectory for more information, 
 especially about individual driver. You can always mail us at 
 <lm78@stimpy.netroedge.com>. Alternatively, consider useing the (free)

README

@@ -1,4 +1,3 @@
-
 This is the completely rewritten version of lm_sensors, a collection of
 modules for general SMBus access and hardware monitoring. There are quite
 a few changes compared with 1.x.y versions; read doc/version-2 for the
@@ -8,9 +7,18 @@ WARNING! If you downloaded this package through our CVS archive, you walk
 the cutting edge. Things may not even compile! On the other hand, you will
 be the first to profit from new drivers and other changes. Have fun!
 
-We expect many updates and new releases the next few weeks (with both bug
-fixes and new features), so check http://www.netroedge.com/~lm78 (our
-homepage) often.
+At least the following SMBus adapters are supported:
+  Intel PIIX4 (used in most Intel chipsets)
+  Acer Labs M1541 and M1543C (used in the Aladdin IV, V and Pro 2 chipsets)
+  VIA Technologies 82C586B (used in most VIA chipsets)
+
+At least the following hardware sensor chips are supported:
+  National Semicoductor LM75, LM78, LM78-J, LM79 and LM80
+  Winbond W83781D
+  Genesys Logic GL518SM
+  Analog Devices ADM1021 and ADM9240
+  SiS Southbridge (integrated in the chipset; the I2C adapter will also be
+    supported in the near future)
 
 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
@@ -58,12 +66,12 @@ The latest version of this package can always be found on our homepage:
 http://www.netroedge.com/~lm78. Pre-release  versions can be retrieved
 through anonymous CVS; see doc/cvs for more information.
 
-This whole package is copyright (c) 1998, 1999-1999 by Frodo Looijaard and Philip
-Edelbrock, except for (almost) everything in the i2c directory, which
-is copyright (c) 1995-1999 by Simon Vogl. See the individual files for
-more exact copyright information.  This package may be distributed
-according to the GNU General Public License (GPL), as included in the
-file COPYING.
+This whole package is copyright (c) 1998, 1999 by Frodo Looijaard and 
+Philip Edelbrock, except for (almost) everything in the i2c directory, which
+is copyright (c) 1995-1999 by Simon Vogl, and a few drivers written by
+other people. See the individual files for more exact copyright information.  
+This package may be distributed according to the GNU General Public License 
+(GPL), as included in the file COPYING.
 
 Note that at this moment, libsensors falls under the GPL, not the LGPL.
 In more human language, that means it is FORBIDDEN to link any application

README.directories

@@ -12,9 +12,10 @@ The directories within this package:
 * i2c
   Simon Vogl's i2c module, including any necessary patches, excluding any
   files which are removed by 'make clean'.
+* kernel
+  The kernel modules: general SMBus drivers, and specific chip and adapter
+  drivers.
 * lib
   The user-space sensors support library code
 * prog
   Several supporting programs, some of them use the library, some do not.
-* src
-  Our own module code.