Bug 218538 - tuning(7) should be either strictly maintained, or removed
Summary: tuning(7) should be either strictly maintained, or removed
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: freebsd-bugs (Nobody)
URL: https://man.freebsd.org/tuning/7
Keywords: needs-patch, needs-qa
Depends on:
Blocks:
 
Reported: 2017-04-10 12:55 UTC by Oclair
Modified: 2022-10-23 03:53 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Oclair 2017-04-10 12:55:37 UTC
man tuning comes with the OS, it contains information that may be out of date, and generally not a good idea to provide advice which can be reversed or negated with incremental updates.  There are plenty of tuning guides not included with the OS, but when one is included with the OS it must be up to date.

Example the following excerpt seems to come from the 4.x days, certainly it is not include or allude to the suggestions to improve performance under ZFS:

<exceprt man tuning FreeBSD 11.0-RELEASE-p8           May 9, 2016>
STRIPING DISKS
     In larger systems you can stripe partitions from several drives together
     to create a much larger overall partition.  Striping can also improve the
     performance of a file system by splitting I/O operations across two or
     more disks.  The gstripe(8), gvinum(8), and ccdconfig(8) utilities may be
     used to create simple striped file systems.  Generally speaking, striping
     smaller partitions such as the root and /var/tmp, or essentially read-
     only partitions such as /usr is a complete waste of time.  You should
     only stripe partitions that require serious I/O performance, typically
     /var, /home, or custom partitions used to hold databases and web pages.
     Choosing the proper stripe size is also important.  File systems tend to
     store meta-data on power-of-2 boundaries and you usually want to reduce
     seeking rather than increase seeking.  This means you want to use a large
     off-center stripe size such as 1152 sectors so sequential I/O does not
     seek both disks and so meta-data is distributed across both disks rather
     than concentrated on a single disk.  If you really need to get
     sophisticated, we recommend using a real hardware RAID controller from
     the list of FreeBSD supported controllers.
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2022-03-05 18:51:19 UTC
See also:
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2022-10-23 03:00:39 UTC
The absence of a section for examples is remarkable: 

<https://www.freebsd.org/cgi/man.cgi?query=tuning&sektion=7&manpath=FreeBSD#EXAMPLES>