d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Grammatical and spelling improvements.

Browse Source 
Reviewed by:	pjd
This commit is contained in:
Ceri Davies 2004-11-04 19:12:43 +00:00
parent eeaa69102a
commit d608b5ab7e
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=137221
7 changed files with 65 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sbin/geom/class/concat/gconcat.8
View File

@ -157,9 +157,9 @@ The default value is shown next to each variable.
Debug level of the
.Nm CONCAT
GEOM class.
This can be set to a number between 0 and 3, both included.
This can be set to a number between 0 and 3 inclusive.
If set to 0 minimal debug information is printed, and if set to 3 the
maximum amount of debug information in printed.
maximum amount of debug information is printed.
.El
.Sh EXAMPLES
The following example shows how to configure four disks for automatic

8
sbin/geom/class/label/glabel.8
View File

@ -72,7 +72,7 @@
.Sh DESCRIPTION
The
.Nm
utility is used for GEOM providers labelization.
utility is used for GEOM provider labelization.
A label can be set up on a GEOM provider in two ways:
.Dq manual
or
@ -132,7 +132,7 @@ Set up a label
for the given provider.
This is the
.Dq automatic
method, where metadata is stored in provider's last sector.
method, where metadata is stored in a provider's last sector.
The kernel module
.Pa geom_label.ko
will be loaded if it is not loaded already.
@ -178,9 +178,9 @@ The default value is shown next to each variable.
Debug level of the
.Nm LABEL
GEOM class.
This can be set to a number between 0 and 2, both included.
This can be set to a number between 0 and 2 inclusive.
If set to 0 minimal debug information is printed, and if set to 2 the
maximum amount of debug information in printed.
maximum amount of debug information is printed.
.El
.Sh EXAMPLES
The following example shows how to set up a label for disk

42
sbin/geom/class/mirror/gmirror.8
View File

@ -104,13 +104,13 @@
The
.Nm
utility is used for mirrors (RAID1) configuration.
After a mirror creation, all components are detected and configured
After a mirror's creation, all components are detected and configured
automatically.
All operations like failure detection, stale components detection, rebuild
of stale components etc.\& are done automatically as well.
All operations like failure detection, stale component detection, rebuild
of stale components, etc.\& are also done automatically.
The
.Nm
utility uses on-disk metadata (the last provider's sector) to store all needed
utility uses on-disk metadata (stored in the provider's last sector) to store all needed
information.
Since the last sector is used for this purpose, it is possible to place a root
file system on a mirror.
@ -121,11 +121,11 @@ indicates an action to be performed:
.Bl -tag -width ".Cm deactivate"
.It Cm label
Create a mirror.
Components order is important, because priority is based on its position
The order of components is important, because a component's priority is based on its position
(starting from 0).
Component with the biggest priority is used by prefer balance algorithm
and also is used as a master component when resynchronization is needed
after, e.g. a power failure if device was open for writing.
The component with the biggest priority is used by prefer balance algorithm
and is also used as a master component when resynchronization is needed,
e.g.\& after a power failure when the device was open for writing.
.Pp
Additional options include:
.Bl -tag -width ".Fl b Ar balance"
@ -147,10 +147,10 @@ Hardcode providers' names in metadata.
.It Fl n
Turn off autosynchronization of stale components.
.It Fl s Ar slice
When using
When using the
.Nm split
balance algorithm and I/O READ request is bigger than or equal to this value,
I/O request will be split into N pieces, where N is the number of active
balance algorithm and an I/O READ request is bigger than or equal to this value,
the I/O request will be split into N pieces, where N is the number of active
component.
.El
.It Cm clear
@ -177,8 +177,8 @@ balance algorithm.
.El
.It Cm rebuild
Rebuild the given mirror components forcibly.
If autosynchronization wasn't turn off for the given device, this command
hopefully will not be used.
If autosynchronization was not turned off for the given device, this command
should be unnecessary.
.It Cm insert
Add the given component(s) to the existing mirror.
.Pp
@ -187,7 +187,7 @@ Additional options include:
.It Fl h
Hardcode providers' names in metadata.
.It Fl i
Mark component(s) as inacitve immediatelly after insertion.
Mark component(s) as inactive immediately after insertion.
.It Fl p Ar priority
Specifies priority of the given component(s).
.El
@ -200,9 +200,9 @@ Mark the given component(s) as inactive, so it will not be automatically
connected to the mirror.
.It Cm forget
Forget about components which are not connected.
This command is useful when disk failed and can't be reconnected, so
This command is useful when a disk has failed and can not be reconnected, preventing the
.Cm remove
command can't be used to remove it.
command from being used to remove it.
.It Cm stop
Stop the given mirror.
.Pp
@ -212,7 +212,7 @@ Additional options include:
Stop the given mirror even if it is opened.
.El
.It Cm list
List every currently configured devices, if a list of devices is passed as a
List every currently configured devices; if a list of devices is passed as a
parameter then only those devices will be shown.
.It Cm load
Load
@ -250,7 +250,7 @@ gmirror label -v -b round-robin data da0
gmirror insert data da1
.Ed
.Pp
Create a mirror, but do not use automatic sunchronization feature.
Create a mirror, but do not use automatic synchronization feature.
Add another disk and rebuild it:
.Bd -literal -offset indent
gmirror label -v -n -b load data da0 da1
@ -265,7 +265,7 @@ gmirror insert data da1
.Ed
.Pp
Create a mirror, deactivate one component, do the backup and connect it again.
It will not be resynchronized, if there is no need to (there were no writes in
It will not be resynchronized, if there is no need to do so (there were no writes in
the meantime):
.Bd -literal -offset indent
gmirror label data da0 da1
@ -290,6 +290,6 @@ utility appeared in
.Sh AUTHORS
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org
.Sh BUGS
There should be a way to change component's priority inside a running mirror.
There should be a way to change a component's priority inside a running mirror.
.Pp
There should be a section with implementation description.
There should be a section with an implementation description.

12
sbin/geom/class/nop/gnop.8
View File

@ -64,8 +64,8 @@
The
.Nm
utility is used for setting up transparent providers on existing ones.
Its main purpose is testing other GEOM classes, as it allows force providers
removal and I/O errors simulation with a given probability.
Its main purpose is testing other GEOM classes, as it allows forced provider
removal and I/O error simulation with a given probability.
It is also a good starting point for implementing new GEOM classes.
.Pp
The first argument to
@ -74,7 +74,7 @@ indicates an action to be performed:
.Bl -tag -width ".Cm configure"
.It Cm create
Set up a transparent provider on the given devices.
If operation succeded, new provider should appear with name
If the operation succeeds, the new provider should appear with name
.Pa /dev/ Ns Ao Ar dev Ac Ns Pa .nop .
The kernel module
.Pa geom_nop.ko
@ -127,14 +127,14 @@ The default value is shown next to each variable.
Debug level of the
.Nm NOP
GEOM class.
This can be set to a number between 0 and 2, both included.
This can be set to a number between 0 and 2 inclusive.
If set to 0 minimal debug information is printed, and if set to 2 the
maximum amount of debug information in printed.
maximum amount of debug information is printed.
.El
.Sh EXAMPLES
The following example shows how to create a transparent provider for disk
.Pa /dev/da0
with 50% failure probability and destroy it.
with 50% failure probability, and how to destroy it.
.Bd -literal -offset indent
gnop create -v -f 50 da0
gnop destroy -v da0.nop

43
sbin/geom/class/raid3/graid3.8
View File

@ -81,14 +81,14 @@
.Sh DESCRIPTION
The
.Nm
utility is used for RAID3 arrays configuration.
After a device creation, all components are detected and configured
utility is used for RAID3 array configuration.
After a device is created, all components are detected and configured
automatically.
All operations like failure detection, stale components detection, rebuild
of stale components etc.\& are done automatically as well.
All operations such as failure detection, stale component detection, rebuild
of stale components, etc.\& are also done automatically.
The
.Nm
utility uses on-disk metadata (the last provider's sector) to store all needed
utility uses on-disk metadata (the provider's last sector) to store all needed
information.
.Pp
The first argument to
@ -97,8 +97,9 @@ indicates an action to be performed:
.Bl -tag -width ".Cm configure"
.It Cm label
Create a RAID3 device.
The last given component will contain parity data, all the rest - regular data.
Number of components has to be equal to 3, 5, 9, 17, etc\&. (2^n + 1).
The last given component will contain parity data, whilst the others
will all contain regular data.
The number of components must be equal to 3, 5, 9, 17, etc\&. (2^n + 1).
.Pp
Additional options include:
.Bl -tag -width ".Fl h"
@ -108,8 +109,8 @@ Hardcode providers' names in metadata.
Turn off autosynchronization of stale components.
.It Fl r
Use parity component for reading in round-robin fashion.
Without this option parity component is not used at all for reading operations
when device is in complete state.
Without this option the parity component is not used at all for reading operations
when the device is in a complete state.
With this option specified random I/O read operations are even 40% faster,
but sequential reads are slower.
One cannot use this option if the
@ -117,13 +118,13 @@ One cannot use this option if the
option is also specified.
.It Fl w
Use verify reading feature.
When reading from device in complete state, read data also from parity component
When reading from a device in a complete state, also read data from the parity component
and verify the data by comparing XORed regular data with parity data.
If verification fails,
If verification fails, an
.Er EIO
error is returned and value of sysctl
error is returned and the value of the
.Va kern.geom.raid3.stat.parity_mismatch
is increased.
sysctl is increased.
One cannot use this option if the
.Fl r
option is also specified.
@ -154,13 +155,13 @@ Turn off verify reading.
.El
.It Cm rebuild
Rebuild the given component forcibly.
If autosynchronization wasn't turn off for the given device, this command
hopefully will not be used.
If autosynchronization was not turned off for the given device, this command
should be unnecessary.
.It Cm insert
Add the given component to the existing array, if one of the component was
Add the given component to the existing array, if one of the components was
removed previously with the
.Cm remove
command or one component is missing and will not be connected again.
command or if one component is missing and will not be connected again.
.Pp
Additional options include:
.Bl -tag -width ".Fl h"
@ -178,7 +179,7 @@ Additional options include:
Stop the given array even if it is opened.
.El
.It Cm list
List every currently configured devices, if a list of devices is passed as a
List every currently configured device; if a list of devices is passed as a
parameter then only those devices will be shown.
.It Cm load
Load
@ -196,7 +197,7 @@ Additional options include:
Be more verbose.
.El
.Sh EXAMPLES
Use 3 disks to setup a RAID3 array (use round-robin reading feature).
Use 3 disks to setup a RAID3 array (with the round-robin reading feature).
Create a file system, mount it, then unmount it and stop device:
.Bd -literal -offset indent
graid3 label -v -r data da0 da1 da2
@ -209,7 +210,7 @@ graid3 unload
.Ed
.Pp
.Pp
Create a RAID3 array, but do not use automatic sunchronization feature.
Create a RAID3 array, but do not use the automatic synchronization feature.
Rebuild parity component:
.Bd -literal -offset indent
graid3 label -n data da0 da1 da2
@ -238,4 +239,4 @@ utility appeared in
.Sh AUTHORS
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org
.Sh BUGS
There should be a section with implementation description.
There should be a section with an implementation description.

16
sbin/geom/class/stripe/gstripe.8
View File

@ -78,7 +78,7 @@
.Sh DESCRIPTION
The
.Nm
utility is used for setting up stripe on two or more disks.
utility is used for setting up a stripe on two or more disks.
The striped device can be configured using two different methods:
.Dq manual
or
@ -118,7 +118,7 @@ The kernel module
.Pa geom_stripe.ko
will be loaded if it is not loaded already.
.It Cm stop
Turn off existing striped device by its
Turn off an existing striped device by its
.Ar name .
This command does not touch on-disk metadata!
.It Cm destroy
@ -166,7 +166,7 @@ The default value is shown next to each variable.
Debug level of the
.Nm STRIPE
GEOM class.
This can be set to a number between 0 and 3, both included.
This can be set to a number between 0 and 3 inclusive.
If set to 0 minimal debug information is printed, and if set to 3 the
maximum amount of debug information in printed.
.It Va kern.geom.stripe.fast : No 1
@ -178,7 +178,7 @@ Compared to
.Dq "economic mode"
.Dq "fast mode"
uses more memory, but it is much faster for smaller stripe sizes.
If enough memory cannot be allocated
If enough memory cannot be allocated,
.Nm STRIPE
will fall back to
.Dq "economic mode" .
@ -191,15 +191,15 @@ This
variable is read-only and can only be set as a tunable in
.Xr loader.conf 5 .
.It Va kern.geom.stripe.fast_failed
How many times
A count of how many times
.Dq "fast mode"
failed because of insufficient amount of memory.
If this value is big, you should considern increasing
has failed due to an insufficient amount of memory.
If this value is large, you should consider increasing the
.Va kern.geom.stripe.maxmem
value.
.El
.Sh EXAMPLES
The following example shows how to set up striped device from four disks with a
The following example shows how to set up a striped device from four disks with a
4 KB stripe size for automatic configuration,
create a file system on it,
and mount it:

4
sbin/geom/core/geom.8
View File

@ -42,9 +42,9 @@ utility is used to control various GEOM classes.
A class has to be aware of
.Xr geom 8
comunication methods, but there are also some standard commands
which can be used for existing, not
which can be used for existing
.Xr geom 8
aware classes.
unaware classes.
Here is the list of standard commands:
.Bl -tag -width ".Cm unload"
.It Cm help