Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 6 Dec 2001 12:10:09 -0800
From:      Luigi Rizzo <rizzo@aciri.org>
To:        Robert Watson <rwatson@FreeBSD.org>
Cc:        cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org
Subject:   Re: cvs commit: src/share/man/man7 tuning.7
Message-ID:  <20011206121009.B74685@iguana.aciri.org>
In-Reply-To: <200112061950.fB6JoZS71169@freefall.freebsd.org>
References:  <200112061950.fB6JoZS71169@freefall.freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Dec 06, 2001 at 11:50:35AM -0800, Robert Watson wrote:
> rwatson     2001/12/06 11:50:35 PST
> 
>   Modified files:
>     share/man/man7       tuning.7 
>   Log:
>   o Add an additional .Pp between the send/recvbuffer comments and
>     the ones on ipfw.  Note to self: why does ipfw/dummynet count as
>     a sysctl in tuning(7)?

I have to admit it is the first time i read this manpage, and from
the CGI interface on www.freebsd.org, so the one i see might
be out of date, but I have the impression that the document should
be slightly restructured, by putting a short introduction paragraph
listing which subsystems are covered, mentioning that most of the
subsystems can be controlled/configured using kernel config options,
sysctls and boot-time tunables, and then completely removing the
SYSCTL section (whose content goes into the subsystem's sections).

Possible structure:

    STORAGE
	DISKS
	    Hardware performance tuning
	FILESYSTEMS
	    sizing partitions, disklabel, newfs, tunefs
	STRIPING
	    vinum, ccdconfig
	SWAP
	    swap size, partitioning, etc.
	MEMORY
	    mbufs, something else ?
	

    NETWORK
	DEVICES
	    which ones are good, which ones are bad, how to improve
	    performances (e.g. interrupt coalescing, polling,
	    issues related to PCI bus)
	FIREWALL
	    ipfw, ipfilter, dummynet, protection against attacks,
	IP stack
	    options related to the ip stack (forwarding, various
	    tcp things etc.)
	SOCKET
	    socket buffer sizes, hard limits, etc.

    HARDWARE
	(things here are not very tunable, but at least explain why
	performance might not be what you expect)

	CPU
	    specific issues for some CPUs if any
	MEMORY
	    performance differences between different types of memory
	BUS
	    performance issues of the PCI/ISA/USB/IDE/SCSI buses
	

I know it takes some work to restructure this manpage in this way, and
it might even become long enough to require splitting in separate
manpages, but i believe it would become a lot more readable.
Also, a lot of the text from the current manpage can
be recycled.

	cheers
	luigi
----------------------------------+-----------------------------------------
 Luigi RIZZO, luigi@iet.unipi.it  . ACIRI/ICSI (on leave from Univ. di Pisa)
 http://www.iet.unipi.it/~luigi/  . 1947 Center St, Berkeley CA 94704
 Phone: (510) 666 2927
----------------------------------+-----------------------------------------

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011206121009.B74685>