system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-07-22 02:37:15 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

tarfs.5: Document the importance of zstd framing

Browse source 
Reviewed by:	des, kib
MFC after:	1 week
Sponsored by:	Klara, Inc.
Differential Revision:	https://reviews.freebsd.org/D44628
This commit is contained in:
Mark Johnston 2024-04-04 10:54:25 -04:00
parent 91eca18551
commit d1801babad
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
share/man/man5/tarfs.5
View file

@ -61,6 +61,19 @@ sysctl setting and tunable.
Setting it to 0 will reset it to its default value.
Note that changes to this setting only apply to filesystems mounted
after the change.
.Pp
When the backing tar file is compressed with
.Xr zstd 1 ,
I/O performance can be improved by ensuring that compressed data is
broken up into multiple frames.
This helps minimize unnecessary decompression work.
When using
.Xr bsdtar 1
to create the tar file, this can be achieved using the
.Cm zstd:max-frame-size
and
.Cm ztsd:frame-per-file
options.
.Sh DIAGNOSTICS
If enabled by the
.Dv TARFS_DEBUG