Make target to install binaries only

[thirdparty/mdadm.git] / mdadm.conf.5

diff --git a/mdadm.conf.5 b/mdadm.conf.5
index ced52186e7d2ecda224d0576318af2132aba20a8..27dbab18455d145790e502e101b1a02947ef7d13 100644 (file)
--- a/mdadm.conf.5
+++ b/mdadm.conf.5
@@ -152,7 +152,7 @@ to assemble the array.  Note that the devices
 listed there must also be listed on a DEVICE line.
 .TP
 .B level=
-The value is a raid level.  This is not normally used to
+The value is a RAID level.  This is not normally used to
 identify an array, but is supported so that the output of
 
 .B "mdadm \-\-examine \-\-scan"
@@ -256,8 +256,8 @@ mode (and was given the
 .B \-\-scan
 option).  There should only be one
 .B MAILADDR
-line and it should have only one address.
-
+line and it should have only one address.  Any subsequent addresses
+are silently ignored.
 
 .TP
 .B MAILFROM
@@ -293,8 +293,8 @@ line and it should be give only one program.
 .B CREATE
 The
 .B create
-line gives default values to be used when creating arrays and device entries for
-arrays.
+line gives default values to be used when creating arrays, new members
+of arrays, and device entries for arrays.
 These include:
 
 .RS 4
@@ -365,6 +365,16 @@ is given, then non-numeric
 device names will not be used even if the default changes in a future
 release of
 .IR mdadm .
+
+.TP
+.B bbl=no
+By default,
+.I mdadm
+will reserve space for a bad block list (bbl) on all devices
+included in or added to any array that supports them.  Setting
+.B bbl=no
+will prevent this, so newly added devices will not have a bad
+block log.
 .RE
 
 .TP
@@ -397,7 +407,9 @@ is given it is also possible to give an explicit name which will be
 used when creating arrays.  This is the only case when there can be
 more that one other word on the
 .B HOMEHOST
-line.
+line.  If there are other words, or other
+.B HOMEHOST
+lines, they are silently ignored.
 
 If
 .B <none>
@@ -461,6 +473,11 @@ The known metadata types are
 .BR ddf ,
 .BR imsm .
 
+.B AUTO
+should be given at most once.  Subsequent lines are silently ignored.
+Thus an earlier config file in a config directory will over-ride
+the setting in a later config file.
+
 .TP
 .B POLICY
 This is used to specify what automatic behavior is allowed on devices
@@ -475,7 +492,7 @@ A device may belong to several domains. The domain of an array is a union
 of domains of all devices in that array.  A spare can be automatically
 moved from one array to another if the set of the destination array's
 .I domains
-ppcontains all the
+contains all the
 .I domains
 of the new disk or if both arrays have the same
 .IR spare-group .
@@ -484,7 +501,7 @@ To update hot plug configuration it is necessary to execute
 .B mdadm \-\-udev\-rules
 command after changing the config file
 
-Key words used in the
+Keywords used in the
 .I POLICY
 line and supported values are:
 
@@ -508,6 +525,7 @@ or
 .TP
 .B action=
 include, re-add, spare, spare-same-slot, or force-spare
+.TP
 .B auto=
 yes, no, or homehost.
 
@@ -547,6 +565,48 @@ be automatically added to that array (or it's container)
 as above and the disk will become a spare in remaining cases
 .RE
 
+.TP
+.B PART-POLICY
+This is similar to
+.B POLICY
+and accepts the same keyword assignments.  It allows a consistent set
+of policies to applied to each of the partitions of a device.
+
+A
+.B PART-POLICY
+line should set
+.I type=disk
+and identify the path to one or more disk devices.  Each partition on
+these disks will be treated according to the
+.I action=
+setting  from this line.  If a
+.I domain
+is set in the line, then the domain associated with each patition will
+be based on the domain, but with
+.RB \(dq -part N\(dq
+appended, when N is the partition number for the partition that was
+found.
+
+.TP
+.B SYSFS
+The SYSFS line lists custom values of MD device's sysfs attributes which will be
+stored in sysfs after the array is assembled. Multiple lines are allowed and each
+line has to contain the uuid or the name of the device to which it relates.
+.RS 4
+.TP
+.B uuid=
+hexadecimal identifier of MD device. This has to match the uuid stored in the
+superblock.
+.TP
+.B name=
+name of the MD device as was given to
+.I mdadm
+when the array was created. It will be ignored if
+.B uuid
+is not empty.
+.TP
+.RS 7
+
 .SH EXAMPLE
 DEVICE /dev/sd[bcdjkl]1
 .br
@@ -617,6 +677,11 @@ CREATE group=system mode=0640 auto=part\-8
 HOMEHOST <system>
 .br
 AUTO +1.x homehost \-all
+.br
+SYSFS name=/dev/md/raid5 group_thread_cnt=4 sync_speed_max=1000000
+.br
+SYSFS uuid=bead5eb6:31c17a27:da120ba2:7dfda40d group_thread_cnt=4
+sync_speed_max=1000000
 
 .SH SEE ALSO
 .BR mdadm (8),