mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-17 10:01:01 +03:00
Man page white space and spelling corrections
Correct some misspelled words and grammatical errors, and remove trailing white space in the man pages. Signed-off-by: Ned Bass <bass6@llnl.gov> Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes #4115
This commit is contained in:
parent
a58df6f536
commit
6b4e21c60e
@ -48,7 +48,7 @@ Check continuation line indentation inside of functions. Sun's C style
|
|||||||
states that all statements must be indented to an appropriate tab stop,
|
states that all statements must be indented to an appropriate tab stop,
|
||||||
and any continuation lines after them must be indented \fIexactly\fP four
|
and any continuation lines after them must be indented \fIexactly\fP four
|
||||||
spaces from the start line. This option enables a series of checks
|
spaces from the start line. This option enables a series of checks
|
||||||
designed to find contination line problems within functions only. The
|
designed to find continuation line problems within functions only. The
|
||||||
checks have some limitations; see CONTINUATION CHECKING, below.
|
checks have some limitations; see CONTINUATION CHECKING, below.
|
||||||
.LP
|
.LP
|
||||||
.TP 4
|
.TP 4
|
||||||
@ -80,7 +80,7 @@ types. Used as part of the putback checks.
|
|||||||
.LP
|
.LP
|
||||||
.TP 4
|
.TP 4
|
||||||
.B \-o \fIconstructs\fP
|
.B \-o \fIconstructs\fP
|
||||||
Allow a comma-seperated list of additional constructs. Available
|
Allow a comma-separated list of additional constructs. Available
|
||||||
constructs include:
|
constructs include:
|
||||||
.LP
|
.LP
|
||||||
.TP 10
|
.TP 10
|
||||||
@ -111,8 +111,8 @@ must also give no errors. This way, files can only become more clean.
|
|||||||
.LP
|
.LP
|
||||||
.SH CONTINUATION CHECKING
|
.SH CONTINUATION CHECKING
|
||||||
.LP
|
.LP
|
||||||
The continuation checker is a resonably simple state machine that knows
|
The continuation checker is a reasonably simple state machine that knows
|
||||||
something about how C is layed out, and can match parenthesis, etc. over
|
something about how C is laid out, and can match parenthesis, etc. over
|
||||||
multiple lines. It does have some limitations:
|
multiple lines. It does have some limitations:
|
||||||
.LP
|
.LP
|
||||||
.TP 4
|
.TP 4
|
||||||
@ -135,7 +135,7 @@ Some continuation error messages deserve some additional explanation
|
|||||||
.B
|
.B
|
||||||
multiple statements continued over multiple lines
|
multiple statements continued over multiple lines
|
||||||
A multi-line statement which is not broken at statement
|
A multi-line statement which is not broken at statement
|
||||||
boundries. For example:
|
boundaries. For example:
|
||||||
.RS 4
|
.RS 4
|
||||||
.HP 4
|
.HP 4
|
||||||
if (this_is_a_long_variable == another_variable) a =
|
if (this_is_a_long_variable == another_variable) a =
|
||||||
|
@ -280,7 +280,7 @@ Issued when there is an I/O failure in a vdev in the pool.
|
|||||||
\fBprobe_failure\fR
|
\fBprobe_failure\fR
|
||||||
.ad
|
.ad
|
||||||
.RS 12n
|
.RS 12n
|
||||||
Issued when a probe fails on a vdev. This would occur if a vdeev
|
Issued when a probe fails on a vdev. This would occur if a vdev
|
||||||
have been kicked from the system outside of ZFS (such as the kernel
|
have been kicked from the system outside of ZFS (such as the kernel
|
||||||
have removed the device).
|
have removed the device).
|
||||||
.RE
|
.RE
|
||||||
@ -443,7 +443,7 @@ Physical FRU location.
|
|||||||
\fBvdev_state\fR
|
\fBvdev_state\fR
|
||||||
.ad
|
.ad
|
||||||
.RS 12n
|
.RS 12n
|
||||||
State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to open, 5=faulted, 6=degraded, 7=healty).
|
State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to open, 5=faulted, 6=degraded, 7=healthy).
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.sp
|
.sp
|
||||||
|
@ -1169,7 +1169,7 @@ Defines a threshold at which metaslab groups should be eligible for
|
|||||||
allocations. The value is expressed as a percentage of free space
|
allocations. The value is expressed as a percentage of free space
|
||||||
beyond which a metaslab group is always eligible for allocations.
|
beyond which a metaslab group is always eligible for allocations.
|
||||||
If a metaslab group's free space is less than or equal to the
|
If a metaslab group's free space is less than or equal to the
|
||||||
the threshold, the allocator will avoid allocating to that group
|
threshold, the allocator will avoid allocating to that group
|
||||||
unless all groups in the pool have reached the threshold. Once all
|
unless all groups in the pool have reached the threshold. Once all
|
||||||
groups have reached the threshold, all groups are allowed to accept
|
groups have reached the threshold, all groups are allowed to accept
|
||||||
allocations. The default value of 0 disables the feature and causes
|
allocations. The default value of 0 disables the feature and causes
|
||||||
@ -1582,7 +1582,7 @@ Default value: \fB1,048,576\fR.
|
|||||||
\fBzio_delay_max\fR (int)
|
\fBzio_delay_max\fR (int)
|
||||||
.ad
|
.ad
|
||||||
.RS 12n
|
.RS 12n
|
||||||
Max zio millisec delay before posting event
|
Max zio millisecond delay before posting event
|
||||||
.sp
|
.sp
|
||||||
Default value: \fB30,000\fR.
|
Default value: \fB30,000\fR.
|
||||||
.RE
|
.RE
|
||||||
|
@ -402,7 +402,7 @@ or smaller can take advantage of this feature.
|
|||||||
|
|
||||||
When this feature is enabled, the contents of highly-compressible blocks are
|
When this feature is enabled, the contents of highly-compressible blocks are
|
||||||
stored in the block "pointer" itself (a misnomer in this case, as it contains
|
stored in the block "pointer" itself (a misnomer in this case, as it contains
|
||||||
the compresseed data, rather than a pointer to its location on disk). Thus
|
the compressed data, rather than a pointer to its location on disk). Thus
|
||||||
the space of the block (one sector, typically 512 bytes or 4KB) is saved,
|
the space of the block (one sector, typically 512 bytes or 4KB) is saved,
|
||||||
and no additional i/o is needed to read and write the data block.
|
and no additional i/o is needed to read and write the data block.
|
||||||
|
|
||||||
|
@ -374,7 +374,7 @@ Deduplication is the process for removing redundant data at the block-level, red
|
|||||||
.sp
|
.sp
|
||||||
\fBWARNING: DO NOT ENABLE DEDUPLICATION UNLESS YOU NEED IT AND KNOW EXACTLY WHAT YOU ARE DOING!\fR
|
\fBWARNING: DO NOT ENABLE DEDUPLICATION UNLESS YOU NEED IT AND KNOW EXACTLY WHAT YOU ARE DOING!\fR
|
||||||
.sp
|
.sp
|
||||||
Deduplicating data is a very resource-intensive operation. It is generally recommended that you have \fIat least\fR 1.25 GB of RAM per 1 TB of storage when you enable deduplication. But calculating the exact requirenments is a somewhat complicated affair. Please see the \fBOracle Dedup Guide\fR for more information..
|
Deduplicating data is a very resource-intensive operation. It is generally recommended that you have \fIat least\fR 1.25 GB of RAM per 1 TB of storage when you enable deduplication. But calculating the exact requirements is a somewhat complicated affair. Please see the \fBOracle Dedup Guide\fR for more information..
|
||||||
.sp
|
.sp
|
||||||
Enabling deduplication on an improperly-designed system will result in extreme performance issues (extremely slow filesystem and snapshot deletions etc.) and can potentially lead to data loss (i.e. unimportable pool due to memory exhaustion) if your system is not built for this purpose. Deduplication affects the processing power (CPU), disks (and the controller) as well as primary (real) memory.
|
Enabling deduplication on an improperly-designed system will result in extreme performance issues (extremely slow filesystem and snapshot deletions etc.) and can potentially lead to data loss (i.e. unimportable pool due to memory exhaustion) if your system is not built for this purpose. Deduplication affects the processing power (CPU), disks (and the controller) as well as primary (real) memory.
|
||||||
.sp
|
.sp
|
||||||
@ -854,7 +854,7 @@ work well on a wide variety of workloads. Unlike all other settings for
|
|||||||
this property, \fBon\fR does not select a fixed compression type. As
|
this property, \fBon\fR does not select a fixed compression type. As
|
||||||
new compression algorithms are added to ZFS and enabled on a pool, the
|
new compression algorithms are added to ZFS and enabled on a pool, the
|
||||||
default compression algorithm may change. The current default compression
|
default compression algorithm may change. The current default compression
|
||||||
algorthm is either \fBlzjb\fR or, if the \fBlz4_compress\fR feature is
|
algorithm is either \fBlzjb\fR or, if the \fBlz4_compress\fR feature is
|
||||||
enabled, \fBlz4\fR.
|
enabled, \fBlz4\fR.
|
||||||
.sp
|
.sp
|
||||||
The \fBlzjb\fR compression algorithm is optimized for performance while
|
The \fBlzjb\fR compression algorithm is optimized for performance while
|
||||||
@ -1230,7 +1230,7 @@ Because \fBSMB\fR shares requires a resource name, a unique resource name is con
|
|||||||
.sp
|
.sp
|
||||||
If the \fBsharesmb\fR property is set to \fBoff\fR, the file systems are unshared.
|
If the \fBsharesmb\fR property is set to \fBoff\fR, the file systems are unshared.
|
||||||
.sp
|
.sp
|
||||||
In Linux, the share is created with the ACL (Access Control List) "Everyone:F" ("F" stands for "full permissions", ie. read and write permissions) and no guest access (which means samba must be able to authenticate a real user, system passwd/shadow, ldap or smbpasswd based) by default. This means that any additional access control (dissalow specific user specific access etc) must be done on the underlaying filesystem.
|
In Linux, the share is created with the ACL (Access Control List) "Everyone:F" ("F" stands for "full permissions", ie. read and write permissions) and no guest access (which means samba must be able to authenticate a real user, system passwd/shadow, ldap or smbpasswd based) by default. This means that any additional access control (disallow specific user specific access etc) must be done on the underlaying filesystem.
|
||||||
.sp
|
.sp
|
||||||
.in +2
|
.in +2
|
||||||
Example to mount a SMB filesystem shared through ZFS (share/tmp):
|
Example to mount a SMB filesystem shared through ZFS (share/tmp):
|
||||||
|
@ -722,7 +722,7 @@ A text string consisting of printable ASCII characters that will be stored such
|
|||||||
.ad
|
.ad
|
||||||
.sp .6
|
.sp .6
|
||||||
.RS 4n
|
.RS 4n
|
||||||
Threshold for the number of block ditto copies. If the reference count for a deduplicated block increases above this number, a new ditto copy of this block is automatically stored. The default setting is 0 which causes no ditto copies to be created for deduplicated blocks. The miniumum legal nonzero setting is 100.
|
Threshold for the number of block ditto copies. If the reference count for a deduplicated block increases above this number, a new ditto copy of this block is automatically stored. The default setting is 0 which causes no ditto copies to be created for deduplicated blocks. The minimum legal nonzero setting is 100.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.sp
|
.sp
|
||||||
@ -1913,7 +1913,7 @@ Do dry run, do not actually perform the split. Print out the expected configurat
|
|||||||
.ad
|
.ad
|
||||||
.sp .6
|
.sp .6
|
||||||
.RS 4n
|
.RS 4n
|
||||||
Set \fIaltroot\fR for \fInewpool\fR and automaticaly import it. This can be useful to avoid mountpoint collisions if \fInewpool\fR is imported on the same filesystem as \fIpool\fR.
|
Set \fIaltroot\fR for \fInewpool\fR and automatically import it. This can be useful to avoid mountpoint collisions if \fInewpool\fR is imported on the same filesystem as \fIpool\fR.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.sp
|
.sp
|
||||||
|
Loading…
Reference in New Issue
Block a user