libmultipath: allow dumping only "local" hwtable in snprint_config
[multipath-tools/.git] / README
diff --git a/README b/README
index 64bf214..2fc4a81 100644 (file)
--- a/README
+++ b/README
@@ -1,52 +1,60 @@
-Dependancies :
-==============
+       multipath-tools for Linux <http://christophe.varoqui.free.fr/>
 
-These libs have been dropped in the multipath tree :
-  
-o libdevmapper : comes with device-mapper-XXXX.tar.gz
-  See www.sistina.com
-o libsysfs : comes with sysutils or udev
-  See ftp.kernel.org/pub/linux/utils/kernel/hotplug/
-o klibc
-  See ftp.kernel.org/pub/linux/libs/klibc/
 
-External :
+This package provides the following binaries to drive the Device Mapper
+multipathing driver:
 
-o Linux kernel 2.6.10-rc with udm2 patchset (or greater)
-  ftp://sources.redhat.com/pub/dm/
-  
-How it works :
-==============
+multipath - Device mapper target autoconfig.
+multipathd - Multipath daemon.
+mpathpersist - Manages SCSI persistent reservations on dm multipath devices.
+kpartx - Create device maps from partition tables.
 
-Get a path list in sysfs.
 
-For each path, a wwid is retrieved by a callout program.
-Only White Listed HW can retrieve this info.
+Releases
+========
+Tarballs are not generated anymore, to get a specific release do:
+git clone https://git.opensvc.com/multipath-tools/.git
+cd multipath-tools
+git tag
+git archive --format=tar.gz --prefix=multipath-tools-X.Y.Z/ X.Y.Z > ../multipath-tools-X.Y.Z.tar.gz
 
-Coalesce the paths according to pluggable policies and store
- the result in mp array.
+Alternatively it may be obtained from gitweb, go to:
+https://git.opensvc.com/?p=multipath-tools/.git;a=tags
+select a release-tag and then click on "snapshot". Or get it with
+wget "https://git.opensvc.com/?p=multipath-tools/.git;a=snapshot;sf=tgz;h=refs/tags/X.Y.Z" -O multipath-tools-X.Y.Z.tar.gz
 
-Feed the maps to the kernel device mapper.
 
-The naming of the corresponding block device is handeld 
-by udev with the help of the devmap_name proggy. It is 
-called by the following rule in /etc/udev/udev.rules :
+Source code
+===========
+To get latest devel code: git clone https://git.opensvc.com/multipath-tools/.git
+Gitweb: https://git.opensvc.com/?p=multipath-tools/.git
 
-KERNEL="dm-[0-9]*", PROGRAM="/sbin/devmap_name %M %m", \
-NAME="%k", SYMLINK="%c"
 
-Notes :
-=======
+Add storage devices
+===================
+Follow the instructions in the libmultipath/hwtable.c header.
+
+
+Mailing list (subscribers-only)
+============
+To subscribe and archives: https://www.redhat.com/mailman/listinfo/dm-devel
+Searchable: https://marc.info/?l=dm-devel
 
-o 2.4.21 version of DM does not like even segment size.
-  if you enconter pbs with this, upgrade DM.
 
-Credits :
+Changelog
 =========
+pre-0.4.5: https://web.archive.org/web/20070309224034/http://christophe.varoqui.free.fr/wiki/wakka.php?wiki=ChangeLog
+post-0.4.5: https://git.opensvc.com/?p=multipath-tools/.git;a=log
 
-o Heavy cut'n paste from sg_utils. Thanks goes to D. 
-  Gilbert.
-o Light cut'n paste from dmsetup. Thanks Joe Thornber.
-o Greg KH for the nice sysfs API.
-o The klibc guys (Starving Linux Artists :), espacially
-  for their nice Makefiles and specfile
+
+Maintainer
+==========
+Christophe Varoqui <christophe.varoqui@opensvc.com>
+Device-mapper development mailing list <dm-devel@redhat.com>
+
+Licence
+=======
+The multipath-tools source code is covered by several different
+licences. Refer to the individual source files for details.
+Source files which do not specify a licence are shipped under
+LGPL-2.0 (see LICENSES/LGPL-2.0).