libmultipath: use vector for for pp->hwe and mp->hwe
[multipath-tools/.git] / README
diff --git a/README b/README
index 89d5e19..2fc4a81 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,60 @@
-multipath-tools for Linux <http://christophe.varoqui.free.fr/>
+       multipath-tools for Linux <http://christophe.varoqui.free.fr/>
 
-This package provides the following binaries to drive the
-Device Mapper multipathing driver:
+
+This package provides the following binaries to drive the Device Mapper
+multipathing driver:
 
 multipath - Device mapper target autoconfig.
 multipathd - Multipath daemon.
 mpathpersist - Manages SCSI persistent reservations on dm multipath devices.
-kpartxrtx - Create device maps from partition tables.
+kpartx - Create device maps from partition tables.
+
+
+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
+
+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
+
+
+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
+
+
+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
+
+
+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
 
-To get latest code: git clone http://git.opensvc.com/multipath-tools/.git
 
-Mailing list: http://www.redhat.com/mailman/listinfo/dm-devel
-Gitweb: http://git.opensvc.com/?p=multipath-tools/.git
+Maintainer
+==========
+Christophe Varoqui <christophe.varoqui@opensvc.com>
+Device-mapper development mailing list <dm-devel@redhat.com>
 
-Current maintainer is Christophe Varoqui <christophe.varoqui@opensvc.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).