main: factor out code to parse layout for raid10 and faulty.

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

diff --git a/mdadm.conf.5 b/mdadm.conf.5
index 9876d279dc38af4f852494264c0e84a70b3b8d84..87a8c1bade0aadbbbb6a0abacf327a45b3bd98d9 100644 (file)
--- a/mdadm.conf.5
+++ b/mdadm.conf.5
@@ -182,10 +182,15 @@ or missing drive but no spare.
 
 .TP
 .B auto=
-This option declares to
+This option is rarely needed with mdadm-3.0, particularly if use with
+the Linux kernel v2.6.28 or later.
+It tells
 .I mdadm
-that it should try to create the device file of the array if it
-doesn't already exist, or exists but with the wrong device number.
+whether to use partitionable array or non-partitionable arrays and,
+in the absence of
+.IR udev ,
+how many partition devices to create.  From 2.6.28 all md array
+devices are partitionable, hence this option is not needed.
 
 The value of this option can be "yes" or "md" to indicate that a
 traditional, non-partitionable md array should be created, or "mdp",
@@ -333,18 +338,32 @@ The
 line gives a default value for the
 .B --homehost=
 option to mdadm.  There should be exactly one other word on the line.
-It should either exactly
+It should either be a host name, or one of the special words
 .B <system>
-or a host name.
+and
+.BR <ignore> .
 If
 .B <system>
 is given, then the
 .BR gethostname ( 2 )
 systemcall is used to get the host name.
-When arrays are created, this host name will be stored in the
-metadata.  When arrays are assembled using auto-assembly, only arrays
-with this host name stored in the metadata will be considered.
 
+If
+.B <ignore>
+is given, then a flag is set so that when arrays are being
+auto-assemble the checking of the recorded
+.I homehost
+is disabled.
+
+When arrays are created, this host name will be stored in the
+metadata.  When arrays are assembled using auto-assembly, arrays which
+do not record the correct homehost name in their metadata will be
+assembled using a 'foreign' name.  A 'foreign' name alway ends with a
+digit string (possibly preceded by an underscore) to differentiate it
+from any possible local name. e.g.
+.B /dev/md/1_1
+or
+.BR /dev/md/home0 .
 .TP
 .B AUTO
 A list of names of metadata format can be given, each preceded by a