Man page update for containers etc.

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index 41486e64fec03fc0d4c0d4a23e838e1a44adc1c2..329cea023e583c1cd66658e7e8a37420cf850a0d 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -38,8 +38,9 @@ md devices,
 .BR RAID6 ,
 .BR RAID10 ,
 .BR MULTIPATH ,
+.BR FAULTY ,
 and
-.BR FAULTY .
+.BR CONTAINER .
 
 .B MULTIPATH
 is not a Software RAID mechanism, but does involve
@@ -50,6 +51,19 @@ each device is a path to one common physical storage device.
 is also not true RAID, and it only involves one device.  It
 provides a layer over a true device that can be used to inject faults.
 
+B CONTAINER
+is different again.  A CONTAINER is a collection of devices that are
+managed as a set.  This is similar to the set of devices connected to
+a hardware RAID controller.  The set of devices may contain a number
+of different RAID arrays each utilising some (or all) blocks from a
+number of the devices in the set.  For example, two devices in a 5-device set
+might form a RAID1 used the whole devices.  The remaining three might
+have a RAID5 over the first half of each device, and a RAID0 over the
+second half.
+
+With a CONTAINER, there is one set of metadata the describes 
+
+
 .\".I mdadm
 .\"is a program that can be used to create, manage, and monitor
 .\"MD devices.  As
@@ -905,6 +919,17 @@ the system to be marked as failed.  It can then be removed.
 same as
 .BR \-\-fail .
 
+.TP
+.BR \-\-write\-mostly
+Subsequent devices that are added or re-added will have the 'write-mostly'
+flag set.  This is only valid for RAID! and means that the 'md' driver
+will avoid reading from these devices if possible.
+.TP
+.BR \-\-readwrite
+Subsequent devices that are added or re-added will have the 'write-mostly'
+flag cleared.
+
+
 .P
 Each of these options require that the first device listed is the array
 to be acted upon, and the remainder are component devices to be added,
@@ -2138,11 +2163,8 @@ configuration file at all.
 .SH SEE ALSO
 For further information on mdadm usage, MD and the various levels of
 RAID, see:
-
 .IP
-.UR http://linux-raid.osdl.org/
-http://linux\-raid.osdl.org/
-.UE
+.B http://linux\-raid.osdl.org/
 .PP
 (based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO)
 .\".PP
@@ -2163,9 +2185,9 @@ The latest version of
 .I mdadm
 should always be available from
 .IP
-.UR http://www.kernel.org/pub/linux/utils/raid/mdadm/
-http://www.kernel.org/pub/linux/utils/raid/mdadm/
-.UE
+.B http://www.kernel.org/pub/linux/utils/raid/mdadm/
+.PP
+Related man pages:
 .PP
 .IR mdadm.conf (5),
 .IR md (4).