Hey Neil. As you've decided in https://github.com/neilbrown/mdadm/pull/3 MD should be written in lower case letters... even though I'd have preferred upper case, I think we should have consistency here... so the attached patch changes the spelling of "MD" to "md" in all manpages (unless for headings). Cheers, Chris.
From f8ac28573b371aa7937fc5af12c96d5c15c0b954 Mon Sep 17 00:00:00 2001 From: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> Date: Tue, 17 Jun 2014 02:56:09 +0200 Subject: [PATCH] =?UTF-8?q?align=20spelling=20of=20=E2=80=9Cmd=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit • Aligned the spelling of “md” to use small letters in all places. Signed-off-by: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> --- md.4 | 14 +++++++------- mdadm.conf.5 | 2 +- mdassemble.8 | 8 ++++---- mdmon.8 | 10 +++++----- raid6check.8 | 10 +++++----- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/md.4 b/md.4 index 5f6c3a7..e13ca5e 100644 --- a/md.4 +++ b/md.4 @@ -60,7 +60,7 @@ starts at least 64K and less than 128K from the end of the device device down to a multiple of 64K and then subtract 64K). The available size of each device is the amount of space before the super block, so between 64K and 128K is lost when a device in -incorporated into an MD array. +incorporated into an md array. This superblock stores multi-byte fields in a processor-dependent manner, so arrays cannot easily be moved between computers with different processors. @@ -587,7 +587,7 @@ supports WRITE-BEHIND on RAID1 arrays. This allows certain devices in the array to be flagged as .IR write-mostly . -MD will only read from such devices if there is no +md will only read from such devices if there is no other option. If a write-intent bitmap is also provided, write requests to @@ -664,7 +664,7 @@ Each block device appears as a directory in .I sysfs (which is usually mounted at .BR /sys ). -For MD devices, this directory will contain a subdirectory called +For md devices, this directory will contain a subdirectory called .B md which contains various files for providing access to information about the array. @@ -695,7 +695,7 @@ described below. .TP .B md/sync_action This can be used to monitor and control the resync/recovery process of -MD. +md. In particular, writing "check" here will cause the array to read all data block and check that they are consistent (e.g. parity is correct, or all mirror replicas are the same). Any discrepancies found are @@ -725,7 +725,7 @@ memory_consumed = system_page_size * nr_disks * stripe_cache_size .TP .B md/preread_bypass_threshold This is only available on RAID5 and RAID6. This variable sets the -number of times MD will service a full-stripe-write before servicing a +number of times md will service a full-stripe-write before servicing a stripe that requires some "prereading". For fairness this defaults to 1. Valid values are 0 to stripe_cache_size. Setting this to 0 maximizes sequential-write throughput at the cost of fairness to threads @@ -740,7 +740,7 @@ This will disable the normal detection of md arrays that happens at boot time. If a drive is partitioned with MS-DOS style partitions, then if any of the 4 main partitions has a partition type of 0xFD, then that partition will normally be inspected to see if it is part of -an MD array, and if any full arrays are found, they are started. This +an md array, and if any full arrays are found, they are started. This kernel parameter disables this behaviour. .TP @@ -748,7 +748,7 @@ kernel parameter disables this behaviour. .TP .B raid=part These are available in 2.6 and later kernels only. They indicate that -autodetected MD arrays should be created as partitionable arrays, with +autodetected md arrays should be created as partitionable arrays, with a different major device number to the original non-partitionable md arrays. The device number is listed as .I mdp diff --git a/mdadm.conf.5 b/mdadm.conf.5 index 61267b6..15a79ab 100644 --- a/mdadm.conf.5 +++ b/mdadm.conf.5 @@ -48,7 +48,7 @@ The keywords are: A .B device line lists the devices (whole devices or partitions) that might contain -a component of an MD array. When looking for the components of an +a component of an md array. When looking for the components of an array, .I mdadm will scan these devices (or any devices listed on the command line). diff --git a/mdassemble.8 b/mdassemble.8 index 889675c..7a25f2a 100644 --- a/mdassemble.8 +++ b/mdassemble.8 @@ -1,7 +1,7 @@ .\" -*- nroff -*- .TH MDASSEMBLE 8 "" v3.3.1 .SH NAME -mdassemble \- assemble MD devices +mdassemble \- assemble md devices .I aka Linux Software RAID @@ -11,7 +11,7 @@ Linux Software RAID .SH DESCRIPTION .B mdassemble -is a tiny program that can be used to assemble MD devices inside an +is a tiny program that can be used to assemble md devices inside an initial ramdisk (initrd) or initramfs; it is meant to replace the in-kernel automatic RAID detection and activation. It can be built statically and linked against lightweight libc alternatives, like @@ -43,8 +43,8 @@ There are no options to .SS /etc/mdadm.conf The config file lists which devices may be scanned to see if -they contain MD super block, and gives identifying information -(e.g. UUID) about known MD arrays. See +they contain md super block, and gives identifying information +(e.g. UUID) about known md arrays. See .BR mdadm.conf (5) for more details. diff --git a/mdmon.8 b/mdmon.8 index 9bdf760..b8456ea 100644 --- a/mdmon.8 +++ b/mdmon.8 @@ -1,7 +1,7 @@ .\" See file COPYING in distribution for details. .TH MDMON 8 "" v3.3.1 .SH NAME -mdmon \- monitor MD external metadata arrays +mdmon \- monitor md external metadata arrays .SH SYNOPSIS @@ -87,7 +87,7 @@ writes that were dependent on this disk. After unblocking the kernel this disk is set to be removed+ from the member array. Finally the disk is marked failed in all other member arrays in the container. .IP -+ Note This behavior differs slightly from native MD arrays where ++ Note This behavior differs slightly from native md arrays where removal is reserved for a .B mdadm --remove event. In the external metadata case the container holds the final @@ -98,12 +98,12 @@ call is still required. .SS Containers: .P -External metadata formats, like DDF, differ from the native MD metadata +External metadata formats, like DDF, differ from the native md metadata formats in that they define a set of disks and a series of sub-arrays -within those disks. MD metadata in comparison defines a 1:1 +within those disks. md metadata in comparison defines a 1:1 relationship between a set of block devices and a RAID array. For example to create 2 arrays at different RAID levels on a single -set of disks, MD metadata requires the disks be partitioned and then +set of disks, md metadata requires the disks be partitioned and then each array can be created with a subset of those partitions. The supported external formats perform this disk carving internally. .P diff --git a/raid6check.8 b/raid6check.8 index 5003343..dfa7f33 100644 --- a/raid6check.8 +++ b/raid6check.8 @@ -7,7 +7,7 @@ .\" See file COPYING in distribution for details. .TH RAID6CHECK 8 "" v1.0.0 .SH NAME -raid6check \- check MD RAID6 device for errors +raid6check \- check md RAID6 device for errors .I aka Linux Software RAID @@ -24,7 +24,7 @@ component drive has the mismatch. Since it works at stripe level, it can report different drives with mismatches at different stripes. -"raid6check" requires a non-degraded RAID6 MD device as first +"raid6check" requires a non-degraded RAID6 md device as first parameter, a starting stripe (usually 0) and the number of stripes to be checked. If this third parameter is also 0, it will check the array up to @@ -36,10 +36,10 @@ In case of parity mismatches, "raid6check" reports, if possible, which component drive could be responsible. Otherwise it reports that it is not possible to find the component drive. -If the given MD device is not a RAID6, "raid6check" will, of +If the given md device is not a RAID6, "raid6check" will, of course, not continue. -If the RAID6 MD device is degraded, "raid6check" will report +If the RAID6 md device is degraded, "raid6check" will report an error and it will not proceed further. No write operations are performed on the array or the components. @@ -78,7 +78,7 @@ the RAID6 parameters. .SH BUGS Negative parameters can lead to unexpected results. -It is not clear what will happen if the RAID6 MD device gets +It is not clear what will happen if the RAID6 md device gets degraded during the check. .PP -- 2.0.0
<<attachment: smime.p7s>>