Move calls to SET_ARRAY_INFO to common helper.

[thirdparty/mdadm.git] / mdadm.8

diff --git a/mdadm.8 b/mdadm.8
index 06d2af84d7687c2539369abaa9ea2d63ef033611..ab659fcb02c40d0ed8d2867310b454a52d38c509 100644 (file)
--- a/mdadm.8
+++ b/mdadm.8
@@ -1014,6 +1014,12 @@ activity to finish before returning.
 will return with success if it actually waited for every device
 listed, otherwise it will return failure.
 
+.TP
+.BR \-\-wait\-clean
+For each md device given, wait for the array to be marked clean before
+returning.  For native arrays this returns immediately as the kernel
+handles dirty-clean transistions at shutdown.  
+
 .SH For Incremental Assembly mode:
 .TP
 .BR \-\-rebuild\-map ", " \-r
@@ -1342,13 +1348,13 @@ be overridden with the
 .B \-\-force
 option.
 
-When creating an array with version-1 metadata a name for the host is
+When creating an array with version-1 metadata a name for the array is
 required.
 If this is not given with the
 .B \-\-name
 option,
 .I mdadm
-will chose a name based on the last component of the name of the
+will choose a name based on the last component of the name of the
 device being created.  So if
 .B /dev/md3
 is being created, then the name
@@ -1360,6 +1366,14 @@ is being created, then the name
 .B home
 will be used.
 
+When creating a partition based array, using 
+.I mdadm 
+with version-1.x metadata, the partition type should be set to 
+.B 0xDA
+(non fs-data). This type selection allows for greater precision since
+using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)],
+might create problems in the event of array recovery through a live cdrom.
+
 A new array will normally get a randomly assigned 128bit UUID which is
 very likely to be unique.  If you have a specific need, you can choose
 a UUID for the array by giving the
@@ -1721,7 +1735,7 @@ Currently the only support available is to
 change the "size" attribute
 for RAID1, RAID5 and RAID6.
 .IP \(bu 4
-increase the "raid-disks" attribute of RAID1, RAID5, and RAID6.
+increase the "raid\-devices" attribute of RAID1, RAID5, and RAID6.
 .IP \(bu 4
 add a write-intent bitmap to any array which supports these bitmaps, or
 remove a write-intent bitmap from such an array.
@@ -1929,6 +1943,16 @@ that no metadata updates are made and no attempt at resync or recovery
 happens.  Further devices that are found before the first write can
 still be added safely.
 
+
+.SH ENVIRONMENT
+This section describes environment variables that affect how mdadm
+operates.
+
+.TP
+.B MDADM_NO_MDMON
+Setting this value to 1 will prevent mdadm from automatically launching
+mdmon.  This variable is intended primarily for debugging mdadm/mdmon.
+
 .SH EXAMPLES
 
 .B "  mdadm \-\-query /dev/name-of-device"