Commit Graph

53 Commits

Author SHA1 Message Date
Oleksandr Shchirskyi 0d58395412 Document PPL in man md
Partial Parity Log (PPL) was not documented in the man md.
Added brief info about PPL.

Signed-off-by: Oleksandr Shchirskyi <oleksandr.shchirskyi@intel.com>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2021-03-08 10:15:51 -05:00
NeilBrown 97b51a2c2d Super1: allow RAID0 layout setting to be removed.
Once the RAID0 layout has been set, the RAID0 array cannot be assembled
on an older kernel which doesn't understand layouts.
This is an intentional safety feature, but sometimes people need the
ability to roll-back to a previously working configuration.

So add "--update=layout-unspecified" to remove RAID0 layout information
from the superblock.
Running "--assemble --update=layout-unspecified" will cause the assembly
the fail when run on a newer kernel, but will allow it to work on
an older kernel.

Signed-off-by: NeilBrown <neilb@suse.de>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2020-10-14 11:40:40 -04:00
Winston Weinert 5e592e1ed8 mdadm/md.4: update path to in-kernel-tree documentation
Documentation/md.txt was renamed to Documentation/admin-guide/md.rst
in linux commit 9d85025b0418163fae079c9ba8f8445212de8568 (Oct 26,
2016).

Signed-off-by: Winston Weinert <winston@ml1.net>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2020-08-07 09:46:21 -04:00
NeilBrown 027c099fd1 Assemble: add support for RAID0 layouts.
If you have a RAID0 array with varying sized devices
on a kernel before 5.4, you cannot assembling it on
5.4 or later without explicitly setting the layout.
This is now possible with
  --update=layout-original (For 3.13 and earlier kernels)
or
  --update=layout-alternate (for 3.14 and later kernels)

Signed-off-by: NeilBrown <neilb@suse.de>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2019-12-02 16:15:56 -05:00
NeilBrown 329dfc28de Create: add support for RAID0 layouts.
Since Linux 5.4 a layout is needed for RAID0 arrays with
varying device sizes.
This patch makes the layout of an array visible (via --examine)
and sets the layout on newly created arrays.
--layout=dangerous
can be used to avoid setting a layout so that they array
can be used on older kernels.

Tested-by: dann frazier <dann.frazier@canonical.com>
Signed-off-by: NeilBrown <neilb@suse.de>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2019-12-02 16:14:49 -05:00
Guoqing Jiang e53cb96869 mdadm/md.4: add the descriptions for bitmap sysfs nodes
The sysfs nodes under bitmap are not recorded in md.4,
add them based on md.rst and kernel source code.

Cc: NeilBrown <neilb@suse.com>
Signed-off-by: Guoqing Jiang <gqjiang@suse.com>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2019-09-30 15:22:32 -04:00
Zhilong Liu 17645275ca mdadm/md.4: set page-length as 1000 to avoid warnings from grotty
"nroff" ("man") or ("tbl") needs a long page to avoid warnings
from "grotty", set 'pl' as 1000 to fix the following issue.

This command invokes by Makefile rule.
linux-tjrh:~/mdadm # man -l md.4 > test
grotty:<standard input> (<standard input>):5967:
character above first line discarded
... ...

Signed-off-by: Zhilong Liu <zlliu@suse.com>
Signed-off-by: Jes Sorensen <jsorensen@fb.com>
2017-05-09 10:52:38 -04:00
NeilBrown 71574efb07 Add failfast support.
Allow per-device "failfast" flag to be set when creating an
array or adding devices to an array.

When re-adding a device which had the failfast flag, it can be removed
using --nofailfast.

failfast status is printed in --detail and --examine output.

Signed-off-by: NeilBrown <neilb@suse.com>
Signed-off-by: Jes Sorensen <Jes.Sorensen@redhat.com>
2016-11-28 08:50:36 -05:00
Song Liu 28f83f6d3b mdadm: Add description of write journal to md.4
Signed-off-by: Song Liu <songliubraving@fb.com>
Signed-off-by: Shaohua Li <shli@fb.com>
Signed-off-by: NeilBrown <neilb@suse.com>
2015-10-22 12:19:11 +11:00
NeilBrown bcbb92d4ee Remove some trailing white space
It looks ugly in my editor.

Signed-off-by: NeilBrown <neilb@suse.de>
2015-07-02 08:26:30 +10:00
NeilBrown 968d2a336e md.4: replace "bad block log" with "bad block list"
Elsewhere we use the term "list", and it is more accurate.
Logs are usually append-only.  This list isn't.

Signed-off-by: NeilBrown <neilb@suse.de>
2014-08-07 12:22:41 +10:00
NeilBrown f99a9e1563 md.4: Make tables narrow enough to fit.
If we use "Dev" instead of "Device" on the wide tables,
they fit better.

Signed-off-by: NeilBrown <neilb@suse.de>
2014-07-03 16:49:15 +10:00
Christoph Anton Mitterer 8dc92b41ac revised the documentation of RAID10 layouts
* Completely revised the documentation of the RAID10 layouts, with examples for
  n2,f2,o2 with and odd and an even number of underlying devices.

Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Signed-off-by: NeilBrown <neilb@suse.de>
2014-07-03 16:46:49 +10:00
Christoph Anton Mitterer 956a13fb85 align spelling of “RAID” and RAID levels
* Aligned the spelling of “RAID” to use captial letters in all places.
* Aligned the spelling of the RAID level names (LINEAR, RAID1, …) to use capital
  letters in all places, except for the string “faulty” in places where not the
  RAID level was meant.

Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
2013-07-10 23:32:22 +02:00
NeilBrown 5b905a7ec5 man pages: remove references to raidtools.
raidtools is so ancient now that it is uninteresting.

Signed-off-by: NeilBrown <neilb@suse.de>
2013-05-15 11:07:17 +10:00
Michael Tokarev dae45415a9 Trivial bugfix and spelling fixes.
And here's another trivial bugfix, now for spelling mistakes in various
places, authred by Sergey Kirpichev (Cc'ed) and carried in debian mdadm
package.


Signed-off-by: NeilBrown <neilb@suse.de>
2012-10-22 08:55:27 +11:00
NeilBrown bf95d0f38c Bad block log 2012-10-03 17:07:11 +10:00
Bill Allaire 1b17b4e4ff md.4: two typos fixed
Signed-off-by: Bill Allaire <vger@bogoflop.com>
Signed-off-by: NeilBrown <neilb@suse.de>
2011-08-23 09:13:08 +10:00
Bill Allaire 095407fa04 md.4: Fixed typo.
Signed-off-by: Bill Allaire <vger@bogoflop.com>
Signed-off-by: NeilBrown <neilb@suse.de>
2011-08-22 11:14:43 +10:00
Namhyung Kim 1e49aaa069 md.4: fix possible typos
Signed-off-by: Namhyung Kim <namhyung@gmail.com>
Signed-off-by: NeilBrown <neilb@suse.de>
2011-06-28 16:36:42 +10:00
NeilBrown c64881d7a2 Man page updates for new --grow options.
Describe all the new ways that mdadm can reshape arrays.

Signed-off-by: NeilBrown <neilb@suse.de>
2011-03-10 16:41:54 +11:00
NeilBrown c93e9d68d0 md.4: various improvements to new section on scrubbing.
Signed-off-by: NeilBrown <neilb@suse.de>
2010-01-29 10:21:56 +11:00
NeilBrown 1cc44574b2 md.4: add section on scrubbing and mismatch counts.
This relates to debian bug 405919

Signed-off-by: NeilBrown <neilb@suse.de>
2010-01-28 13:09:58 +11:00
NeilBrown e0fe762a63 mdadm.8: Man page updates
General review and update of mdadm.8
2009-06-02 14:06:05 +10:00
NeilBrown 37ea3936a6 Merge branch 'master' into from-stable
Conflicts:

	Create.c
	Manage.c
2008-08-07 14:12:25 +10:00
Dan Williams 800053d600 Documentation fixup for stripe_cache_size
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
2008-07-18 17:47:13 -07:00
Dan Williams a5ee6dfbf5 Document preread_bypass_threshold
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
2008-07-18 17:14:44 -07:00
Neil Brown 91c0038813 Fix confusing usage in md.4 man page.
"degraded write performance" could be confused with "write performance
when degraded".  It really means "reduced write performance", so say
that.
2008-07-08 10:03:09 +10:00
Neil Brown 02b76eeace Fix RAID acronym in man page.
The 'D' in 'RAID' stands for 'DISKS' even it md supports other 'devices'.
2008-05-05 19:43:58 +10:00
Neil Brown 519561f73f Fix possible bug with bitmap space allocation with v1.0 metadata
When adding a device to an array, make sure we don't reserve
so much space for the bitmap that there isn't room for the data.
2008-04-29 17:13:53 +10:00
Iustin Pop 3dacb89029 Explain the read-balancing algorithm for RAID1 better in md.4
From: Iustin Pop <iusty@k1024.org>

There are many questions on the mailing list about the RAID1 read
performance profile. This patch adds a new paragraph to the RAID1
section in md.4 that details what kind of speed-up one should expect
from RAID1.

Signed-off-by: Iustin Pop <iusty@k1024.org>
2007-09-11 16:20:19 +02:00
Scott Weikart 93e790afef Substantial corrections to man pages.
From: "Scott Weikart" <Scott.W@Benetech.org>

Thanks Scott!
2007-07-13 15:13:43 +10:00
Neil Brown bf40ab857f Typo in man page: Multipath has an L ... 2007-07-11 09:08:49 +10:00
Peter Samuelson b3f1c093b7 Hyphens and Other Manpage Typography, 2/4: proper nroff "em dash".
From: Peter Samuelson <peter@p12n.org>

\(em renders as "--" in ASCII, and a nice em dash (i.e., a dash the
width of the letter "m") in more capable formats like PostScript.

Signed-Off-By: Peter Samuelson <peter@p12n.org>
2007-05-08 17:13:25 +10:00
Peter Samuelson 35cc5be496 Hyphens and Other Manpage Typography, 1/4:
From: Peter Samuelson <peter@p12n.org>

 do not hyphenate terms:
  "override", "therein", "overwrite", "superblock format".

Signed-Off-By: Peter Samuelson <peter@p12n.org>
2007-05-08 17:13:03 +10:00
Neil Brown 1afe1167ae Minor manpage fixes 2007-05-08 17:12:50 +10:00
Neil Brown 8f21823f39 Minor man page and comment fixes
Thanks To: "Scott Weikart" <Scott.W@Benetech.org>
2006-10-09 11:16:33 +10:00
Neil Brown 90fc992e4e Explicitly state GPL license in man pages. 2006-08-07 11:12:25 +10:00
Neil Brown 2a940e3619 Document usage of version0.91 superblock. 2006-08-07 11:11:42 +10:00
Neil Brown b578481ca3 Support new offset layout for raid10
Requires 2.6.18.

Signed-off-by: Neil Brown <neilb@suse.de>
2006-05-15 02:46:54 +00:00
Neil Brown addc80c467 Updates to md.4
Particularly restiping and sysfs, but a few other bits too.

Signed-off-by: Neil Brown <neilb@suse.de>
2006-03-30 04:17:51 +00:00
Neil Brown a9d69660a3 Lots of little manpage updates.
Signed-off-by: Neil Brown <neilb@cse.unsw.edu.au>
2005-08-25 05:11:29 +00:00
Neil Brown 599e5a360b Add RAID10 and other stuff to md.4
Signed-off-by: Neil Brown <neilb@cse.unsw.edu.au>
2005-08-25 05:09:25 +00:00
Neil Brown 570c054247 Release 1.8.1 after some man page updates and other fixes.
Signed-off-by: Neil Brown <neilb@cse.unsw.edu.au>
2005-06-07 23:16:36 +00:00
Neil Brown b5e6464503 mdadm-1.8.0 2004-11-01 04:49:34 +00:00
Neil Brown 98c6faba80 mdadm-1.5.0 2004-01-22 02:10:29 +00:00
Neil Brown aa88f531b4 mdadm-1.3.0 2003-07-28 23:59:00 +00:00
Neil Brown 5787fa4906 mdadm-1.0.9 2003-02-12 00:17:26 +00:00
Neil Brown 2d46552003 mdadm-1.0.0 2002-05-10 04:06:19 +00:00
Neil Brown c913b90e6d mdadm-0.8.1 2002-04-05 22:00:28 +00:00