svn commit: r316751 - vendor/illumos/dist/man/man1m

[Josh Paetzel]

Author: jpaetzel
Date: Thu Apr 13 05:47:52 2017
New Revision: 316751
URL: https://svnweb.freebsd.org/changeset/base/316751

Log:
  5661 ZFS: "compression = on" should use lz4 if feature is enabled
  
  Reviewed by: Matthew Ahrens <mahrens at delphix.com>
  Reviewed by: Josef 'Jeff' Sipek <jeffpc at josefsipek.net>
  Reviewed by: Xin LI <delphij at freebsd.org>
  Approved by: Robert Mustacchi <rm at joyent.com>
  Author: Justin T. Gibbs <justing at spectralogic.com>
  
  illumos/illumos-gate at db1741f555ec79def5e9846e6bfd132248514ff

Modified:
  vendor/illumos/dist/man/man1m/zfs.1m

Modified: vendor/illumos/dist/man/man1m/zfs.1m
==============================================================================
--- vendor/illumos/dist/man/man1m/zfs.1m	Thu Apr 13 04:10:27 2017	(r316750)
+++ vendor/illumos/dist/man/man1m/zfs.1m	Thu Apr 13 05:47:52 2017	(r316751)
@@ -987,20 +987,25 @@ Changing this property affects only newl
 .sp
 .ne 2
 .na
-\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBgzip\fR |
-\fBgzip-\fR\fIN\fR | \fBzle\fR\fR | \fBlz4\fR
+\fB\fBcompression\fR=\fBon\fR | \fBoff\fR | \fBlzjb\fR | \fBlz4\fR |
+\fBgzip\fR | \fBgzip-\fR\fIN\fR | \fBzle\fR\fR
 .ad
 .sp .6
 .RS 4n
-Controls the compression algorithm used for this dataset. The \fBlzjb\fR
-compression algorithm is optimized for performance while providing decent data
-compression. Setting compression to \fBon\fR uses the \fBlzjb\fR compression
-algorithm. The \fBgzip\fR compression algorithm uses the same compression as
-the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
-value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
-(best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
-(which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
-algorithm compresses runs of zeros.
+Controls the compression algorithm used for this dataset.
+.sp
+Setting compression to \fBon\fR indicates that the current default
+compression algorithm should be used.  The default balances compression
+and decompression speed, with compression ratio and is expected to
+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
+new compression algorithms are added to ZFS and enabled on a pool, the
+default compression algorithm may change.  The current default compression
+algorthm is either \fBlzjb\fR or, if the \fBlz4_compress\fR feature is
+enabled, \fBlz4\fR.
+.sp
+The \fBlzjb\fR compression algorithm is optimized for performance while
+providing decent data compression.
 .sp
 The \fBlz4\fR compression algorithm is a high-performance replacement
 for the \fBlzjb\fR algorithm. It features significantly faster
@@ -1010,6 +1015,13 @@ the \fBlz4_compress\fR feature set to \f
 \fBzpool-features\fR(5) for details on ZFS feature flags and the
 \fBlz4_compress\fR feature.
 .sp
+The \fBgzip\fR compression algorithm uses the same compression as
+the \fBgzip\fR(1) command. You can specify the \fBgzip\fR level by using the
+value \fBgzip-\fR\fIN\fR where \fIN\fR is an integer from 1 (fastest) to 9
+(best compression ratio). Currently, \fBgzip\fR is equivalent to \fBgzip-6\fR
+(which is also the default for \fBgzip\fR(1)). The \fBzle\fR compression
+algorithm compresses runs of zeros.
+.sp
 This property can also be referred to by its shortened column name
 \fBcompress\fR. Changing this property affects only newly-written data.
 .RE