From nobody@FreeBSD.org  Thu Jun 15 08:41:41 2006
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id D5F3D16A474
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 15 Jun 2006 08:41:41 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [216.136.204.117])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 448D743D46
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 15 Jun 2006 08:41:41 +0000 (GMT)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.13.1/8.13.1) with ESMTP id k5F8fetH007575
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 15 Jun 2006 08:41:40 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.13.1/8.13.1/Submit) id k5F8feg2007574;
	Thu, 15 Jun 2006 08:41:40 GMT
	(envelope-from nobody)
Message-Id: <200606150841.k5F8feg2007574@www.freebsd.org>
Date: Thu, 15 Jun 2006 08:41:40 GMT
From: Jelte Jansen <jelte@NLnetLabs.nl>
To: freebsd-gnats-submit@FreeBSD.org
Subject: Missing tunables in loader(8) manpage
X-Send-Pr-Version: www-2.3

>Number:         98974
>Category:       docs
>Synopsis:       Missing tunables in loader(8) manpage
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Jun 15 08:50:16 GMT 2006
>Closed-Date:    
>Last-Modified:  Mon Oct 30 21:30:19 GMT 2006
>Originator:     Jelte Jansen
>Release:        6.*
>Organization:
NLnet Labs
>Environment:
FreeBSD alpha.nlnetlabs.nl 6.0-RELEASE FreeBSD 6.0-RELEASE #0: Thu Nov  3 09:36:13 UTC 2005     root@x64.samsco.home:/usr/obj/usr/src/sys/GENERIC  i386

>Description:

Some tunables (at least kern.maxdsiz, to set the maximum allowed datasize for processes which defaults to 512 mb) are not documented in any manual page i could find. These would probably go in loader(8). The only place i found where it is even mentioned is /boot/defaults/loader.conf, but the information there is too sparse to know what values to use and what it's for.

>How-To-Repeat:
man loader

(no mention here)

grep maxdsiz /usr/src/sys/kern/subr_param.c

(is is a tunable)
>Fix:

Add text to the manpage, i propose something like:

kern.maxdsiz      Set the maximum allowed datasize resource limit for processes. This value defaults to 512 megabytes. The value should be entered in number of bytes, without modifiers. The value may not exceed addressable space.

But someone else can probably do a better job, i'm not sure if the no modifiers is still necessary.

There are probably other tunables that are not mentioned yet.

>Release-Note:
>Audit-Trail:

From: Ceri Davies <ceri@submonkey.net>
To: Jelte Jansen <jelte@NLnetLabs.nl>,
	<freebsd-gnats-submit@FreeBSD.org>
Cc: Tom Rhodes <trhodes@FreeBSD.org>
Subject: Re: docs/98974: Missing tunables in loader(8) manpage
Date: Thu, 15 Jun 2006 11:52:27 +0100

 On 15/6/06 09:41, "Jelte Jansen" <jelte@NLnetLabs.nl> wrote:
 
 > Some tunables (at least kern.maxdsiz, to set the maximum allowed datasize for
 > processes which defaults to 512 mb) are not documented in any manual page i
 > could find. These would probably go in loader(8). The only place i found where
 > it is even mentioned is /boot/defaults/loader.conf, but the information there
 > is too sparse to know what values to use and what it's for.
 
 Some moons ago, Tom Rhodes was working on a new manpage for tunables.
 
 Tom, is this still ongoing (or did it even get committed and I didn't
 notice)?
 
 Ceri
 
 

From: Tom Rhodes <trhodes@FreeBSD.org>
To: Ceri Davies <ceri@submonkey.net>
Cc: jelte@NLnetLabs.nl, freebsd-gnats-submit@FreeBSD.org
Subject: Re: docs/98974: Missing tunables in loader(8) manpage
Date: Thu, 15 Jun 2006 07:02:35 -0400

 On Thu, 15 Jun 2006 11:52:27 +0100
 Ceri Davies <ceri@submonkey.net> wrote:
 
 > On 15/6/06 09:41, "Jelte Jansen" <jelte@NLnetLabs.nl> wrote:
 > 
 > > Some tunables (at least kern.maxdsiz, to set the maximum allowed datasize for
 > > processes which defaults to 512 mb) are not documented in any manual page i
 > > could find. These would probably go in loader(8). The only place i found where
 > > it is even mentioned is /boot/defaults/loader.conf, but the information there
 > > is too sparse to know what values to use and what it's for.
 > 
 > Some moons ago, Tom Rhodes was working on a new manpage for tunables.
 > 
 > Tom, is this still ongoing (or did it even get committed and I didn't
 > notice)?
 
 And I was really wondering if I should follow up.  It appears
 there is a slight difference between tunables and sysctls.
 To be honest, I don't see it, but yea.  Anyway, I created a
 simple script to find and document as many as plausible:
 
 src/tools/tools/sysdoc
 
 If someone can do something better with it, then yay.  Eventually
 I may redo it in C, but I doubt.
 
 -- 
 Tom Rhodes

From: Ruslan Ermilov <ru@FreeBSD.org>
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/98974: Missing tunables in loader(8) manpage
Date: Tue, 31 Oct 2006 00:27:23 +0300

 For the record.  The src/tools/tools/sysdoc tool has nothing to
 do with loader(8) tunables; instead, a tool scans the installed
 kernel for sysctls which are not loader(8) tunables.  (Some of
 the sysctls also have the tunables of the same name, but not
 necessarily.)
 
 
 Cheers,
 -- 
 Ruslan Ermilov
 ru@FreeBSD.org
 FreeBSD committer
>Unformatted:
