tarfs.5: Provide some guidance on zstd frame sizes

Reviewed by:	des, emaste
MFC after:	2 weeks
Sponsored by:	Klara, Inc.
Differential Revision:	https://reviews.freebsd.org/D44636
This commit is contained in:
Mark Johnston 2024-04-05 11:28:55 -04:00
parent 60bc195745
commit fd56d24725

View file

@ -74,6 +74,15 @@ to create the tar file, this can be achieved using the
and
.Cm ztsd:frame-per-file
options.
Sensible frame sizes are powers of 2 between the system's base page size
(see
.Xr arch 7 )
and the value of the
.Sy kern.maxphys
sysctl.
Smaller frames will generally yield a worse compression ratio and require extra
kernel memory to maintain an index, and larger frames will on average require
more CPU time to access data when performing random I/O.
.Sh DIAGNOSTICS
If enabled by the
.Dv TARFS_DEBUG