Wed May 26 08:23:18 2021 UTC ()
update the list of platforms supporting loading kernels from raid.
expand the HISTORY section to include notable RF moments in netbsd.
bump date.


(mrg)
diff -r1.74 -r1.75 src/sbin/raidctl/raidctl.8

cvs diff -r1.74 -r1.75 src/sbin/raidctl/raidctl.8 (expand / switch to unified diff)

--- src/sbin/raidctl/raidctl.8 2018/01/18 00:32:49 1.74
+++ src/sbin/raidctl/raidctl.8 2021/05/26 08:23:18 1.75
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: raidctl.8,v 1.74 2018/01/18 00:32:49 mrg Exp $ 1.\" $NetBSD: raidctl.8,v 1.75 2021/05/26 08:23:18 mrg Exp $
2.\" 2.\"
3.\" Copyright (c) 1998, 2002 The NetBSD Foundation, Inc. 3.\" Copyright (c) 1998, 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation 6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Greg Oster 7.\" by Greg Oster
8.\" 8.\"
9.\" Redistribution and use in source and binary forms, with or without 9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions 10.\" modification, are permitted provided that the following conditions
11.\" are met: 11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright 12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer. 13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" 2. Redistributions in binary form must reproduce the above copyright
@@ -43,27 +43,27 @@ @@ -43,27 +43,27 @@
43.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 43.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
44.\" FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 44.\" FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45.\" 45.\"
46.\" Carnegie Mellon requests users of this software to return to 46.\" Carnegie Mellon requests users of this software to return to
47.\" 47.\"
48.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 48.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49.\" School of Computer Science 49.\" School of Computer Science
50.\" Carnegie Mellon University 50.\" Carnegie Mellon University
51.\" Pittsburgh PA 15213-3890 51.\" Pittsburgh PA 15213-3890
52.\" 52.\"
53.\" any improvements or extensions that they make and grant Carnegie the 53.\" any improvements or extensions that they make and grant Carnegie the
54.\" rights to redistribute these changes. 54.\" rights to redistribute these changes.
55.\" 55.\"
56.Dd January 6, 2016 56.Dd May 26, 2021
57.Dt RAIDCTL 8 57.Dt RAIDCTL 8
58.Os 58.Os
59.Sh NAME 59.Sh NAME
60.Nm raidctl 60.Nm raidctl
61.Nd configuration utility for the RAIDframe disk driver 61.Nd configuration utility for the RAIDframe disk driver
62.Sh SYNOPSIS 62.Sh SYNOPSIS
63.Nm 63.Nm
64.Op Fl v 64.Op Fl v
65.Fl A Op yes | no | forceroot | softroot 65.Fl A Op yes | no | forceroot | softroot
66.Ar dev 66.Ar dev
67.Nm 67.Nm
68.Op Fl v 68.Op Fl v
69.Fl a Ar component Ar dev 69.Fl a Ar component Ar dev
@@ -156,27 +156,28 @@ Note that all components of the set must @@ -156,27 +156,28 @@ Note that all components of the set must
156in the disklabel. 156in the disklabel.
157.It Fl A Ic no Ar dev 157.It Fl A Ic no Ar dev
158Turn off auto-configuration for the RAID set. 158Turn off auto-configuration for the RAID set.
159.It Fl A Ic forceroot Ar dev 159.It Fl A Ic forceroot Ar dev
160Make the RAID set auto-configurable, and also mark the set as being 160Make the RAID set auto-configurable, and also mark the set as being
161eligible to be the root partition. 161eligible to be the root partition.
162A RAID set configured this way will 162A RAID set configured this way will
163.Ar override 163.Ar override
164the use of the boot disk as the root device. 164the use of the boot disk as the root device.
165All components of the set must be of type 165All components of the set must be of type
166.Dv RAID 166.Dv RAID
167in the disklabel. 167in the disklabel.
168Note that only certain architectures 168Note that only certain architectures
169.Pq currently alpha, amd64, i386, pmax, sandpoint, sparc, sparc64, and vax 169.Pq currently arc, alpha, amd64, bebox, cobalt, emips, i386, landisk,
 170ofppc, pmax, sandpoint, sgimips, sparc, sparc64, and vax
170support booting a kernel directly from a RAID set. 171support booting a kernel directly from a RAID set.
171Please note that 172Please note that
172.Ic forceroot 173.Ic forceroot
173mode was referred to as 174mode was referred to as
174.Ic root 175.Ic root
175mode on earlier versions of 176mode on earlier versions of
176.Nx . 177.Nx .
177For compatibility reasons, 178For compatibility reasons,
178.Ic root 179.Ic root
179can be used as an alias for 180can be used as an alias for
180.Ic forceroot . 181.Ic forceroot .
181.It Fl A Ic softroot Ar dev 182.It Fl A Ic softroot Ar dev
182Like 183Like
@@ -492,26 +493,32 @@ fifo 100 @@ -492,26 +493,32 @@ fifo 100
492where the queuing method is specified as fifo (first-in, first-out), 493where the queuing method is specified as fifo (first-in, first-out),
493and the size of the per-component queue is limited to 100 requests. 494and the size of the per-component queue is limited to 100 requests.
494Other queuing methods may also be specified, but a discussion of them 495Other queuing methods may also be specified, but a discussion of them
495is beyond the scope of this document. 496is beyond the scope of this document.
496.Pp 497.Pp
497The final section, the 498The final section, the
498.Sq debug 499.Sq debug
499section, is optional. 500section, is optional.
500For more details on this the reader is referred to 501For more details on this the reader is referred to
501the RAIDframe documentation discussed in the 502the RAIDframe documentation discussed in the
502.Sx HISTORY 503.Sx HISTORY
503section. 504section.
504.Pp 505.Pp
 506Since
 507.Nx 10
 508RAIDframe has been been capable of autoconfiguration of components
 509originally configured on opposite endian systems. The current label
 510endianness will be retained.
 511.Pp
505See 512See
506.Sx EXAMPLES 513.Sx EXAMPLES
507for a more complete configuration file example. 514for a more complete configuration file example.
508.Sh FILES 515.Sh FILES
509.Bl -tag -width /dev/XXrXraidX -compact 516.Bl -tag -width /dev/XXrXraidX -compact
510.It Pa /dev/{,r}raid* 517.It Pa /dev/{,r}raid*
511.Cm raid 518.Cm raid
512device special files. 519device special files.
513.El 520.El
514.Sh EXAMPLES 521.Sh EXAMPLES
515It is highly recommended that before using the RAID driver for real 522It is highly recommended that before using the RAID driver for real
516file systems that the system administrator(s) become quite familiar 523file systems that the system administrator(s) become quite familiar
517with the use of 524with the use of
@@ -1553,26 +1560,46 @@ scripts. @@ -1553,26 +1560,46 @@ scripts.
1553.Xr ccd 4 , 1560.Xr ccd 4 ,
1554.Xr raid 4 , 1561.Xr raid 4 ,
1555.Xr rc 8 1562.Xr rc 8
1556.Sh HISTORY 1563.Sh HISTORY
1557RAIDframe is a framework for rapid prototyping of RAID structures 1564RAIDframe is a framework for rapid prototyping of RAID structures
1558developed by the folks at the Parallel Data Laboratory at Carnegie 1565developed by the folks at the Parallel Data Laboratory at Carnegie
1559Mellon University (CMU). 1566Mellon University (CMU).
1560A more complete description of the internals and functionality of 1567A more complete description of the internals and functionality of
1561RAIDframe is found in the paper "RAIDframe: A Rapid Prototyping Tool 1568RAIDframe is found in the paper "RAIDframe: A Rapid Prototyping Tool
1562for RAID Systems", by William V. Courtright II, Garth Gibson, Mark 1569for RAID Systems", by William V. Courtright II, Garth Gibson, Mark
1563Holland, LeAnn Neal Reilly, and Jim Zelenka, and published by the 1570Holland, LeAnn Neal Reilly, and Jim Zelenka, and published by the
1564Parallel Data Laboratory of Carnegie Mellon University. 1571Parallel Data Laboratory of Carnegie Mellon University.
1565.Pp 1572.Pp
 1573RAIDframe was ported to
 1574.Nx
 1575by Greg Oster in 1998, who has maintained it since.
 1576In 1999, component labels, spares, automatic rebuilding of parity, and
 1577autoconfiguration of volumes were added.
 1578In 2000, root on RAID support was added (initially, with no support for
 1579loading kernels from RAID volumes, which has been added to many ports since.)
 1580In 2009, support for parity bimap was added, reducing parity resync time
 1581after a crash.
 1582In 2010, support for larger the 2TiB and non-512 sector devices was added.
 1583In 2018, support for 32-bit userland compatibility was added.
 1584In 2021, support for autoconfiguration from other-endian raid sets was added.
 1585.Pp
 1586Support for loading kernels from RAID 1 partitions was added for the
 1587alpha, pmax and vax ports in 2000, the the sgimips port in 2001,
 1588the x86 ports in 2003, the arc port in 2005, the landisk, sparc, and
 1589sparc64 ports in 2006, the cobalt port in 2007, the ofppc port in 2008,
 1590the bebox port in 2010, the emips port in 2011, and the sandpoint port
 1591in 2012.
 1592.Pp
1566The 1593The
1567.Nm 1594.Nm
1568command first appeared as a program in CMU's RAIDframe v1.1 distribution. 1595command first appeared as a program in CMU's RAIDframe v1.1 distribution.
1569This version of 1596This version of
1570.Nm 1597.Nm
1571is a complete re-write, and first appeared in 1598is a complete re-write, and first appeared in
1572.Nx 1.4 . 1599.Nx 1.4 .
1573.Sh COPYRIGHT 1600.Sh COPYRIGHT
1574.Bd -literal 1601.Bd -literal
1575The RAIDframe Copyright is as follows: 1602The RAIDframe Copyright is as follows:
1576 1603
1577Copyright (c) 1994-1996 Carnegie-Mellon University. 1604Copyright (c) 1994-1996 Carnegie-Mellon University.
1578All rights reserved. 1605All rights reserved.