From nobody@FreeBSD.org  Tue Jul 13 21:04:15 2010
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id B4F4F1065673
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 13 Jul 2010 21:04:15 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id 998588FC12
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 13 Jul 2010 21:04:15 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id o6DL4Faj057059
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 13 Jul 2010 21:04:15 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id o6DL4EQq057058;
	Tue, 13 Jul 2010 21:04:14 GMT
	(envelope-from nobody)
Message-Id: <201007132104.o6DL4EQq057058@www.freebsd.org>
Date: Tue, 13 Jul 2010 21:04:14 GMT
From: Galimov Albert <wtfcrap@mail.ru>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [sysctl][patch] Document some sys/kern sysctls
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         148580
>Category:       kern
>Synopsis:       [sysctl][patch] Document some sys/kern sysctls
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    gavin
>State:          patched
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Jul 13 21:10:01 UTC 2010
>Closed-Date:    
>Last-Modified:  Mon Aug  9 14:50:01 UTC 2010
>Originator:     Galimov Albert
>Release:        HEAD
>Organization:
>Environment:
>Description:
Working on documenting sysctls
>How-To-Repeat:

>Fix:
svn diff sys/kern/kern_ktrace.c sys/kern/init_main.c sys/kern/kern_cons.c


Patch attached with submission follows:

Index: sys/kern/kern_ktrace.c
===================================================================
--- sys/kern/kern_ktrace.c	(revision 210019)
+++ sys/kern/kern_ktrace.c	(working copy)
@@ -218,7 +218,7 @@
 	return (0);
 }
 SYSCTL_PROC(_kern_ktrace, OID_AUTO, request_pool, CTLTYPE_UINT|CTLFLAG_RW,
-    &ktr_requestpool, 0, sysctl_kern_ktrace_request_pool, "IU", "");
+    &ktr_requestpool, 0, sysctl_kern_ktrace_request_pool, "IU", "Pool buffer size for ktrace(1)");
 
 static u_int
 ktrace_resize_pool(u_int newsize)
Index: sys/kern/init_main.c
===================================================================
--- sys/kern/init_main.c	(revision 210019)
+++ sys/kern/init_main.c	(working copy)
@@ -100,9 +100,9 @@
 struct	proc *initproc;
 
 int	boothowto = 0;		/* initialized so that it can be patched */
-SYSCTL_INT(_debug, OID_AUTO, boothowto, CTLFLAG_RD, &boothowto, 0, "");
+SYSCTL_INT(_debug, OID_AUTO, boothowto, CTLFLAG_RD, &boothowto, 0, "Boot control flags");
 int	bootverbose;
-SYSCTL_INT(_debug, OID_AUTO, bootverbose, CTLFLAG_RW, &bootverbose, 0, "");
+SYSCTL_INT(_debug, OID_AUTO, bootverbose, CTLFLAG_RW, &bootverbose, 0, "Verbose flag");
 
 /*
  * This ensures that there is at least one entry so that the sysinit_set
@@ -648,7 +648,8 @@
 #endif
 static int init_shutdown_timeout = INIT_SHUTDOWN_TIMEOUT;
 SYSCTL_INT(_kern, OID_AUTO, init_shutdown_timeout,
-	CTLFLAG_RW, &init_shutdown_timeout, 0, "");
+	CTLFLAG_RW, &init_shutdown_timeout, 0, "Shutdown timeout of init(8). "
+		"Unused within kernel, but used to control init(8)");
 
 /*
  * Start the initial user process; try exec'ing each pathname in init_path.
Index: sys/kern/kern_cons.c
===================================================================
--- sys/kern/kern_cons.c	(revision 210019)
+++ sys/kern/kern_cons.c	(working copy)
@@ -341,7 +341,7 @@
 }
 
 SYSCTL_PROC(_kern, OID_AUTO, consmute, CTLTYPE_INT|CTLFLAG_RW,
-	0, sizeof(cn_mute), sysctl_kern_consmute, "I", "");
+	0, sizeof(cn_mute), sysctl_kern_consmute, "I", "State of the console muting");
 
 /*
  * Low level console routines.
@@ -429,7 +429,7 @@
 
 static int consmsgbuf_size = 8192;
 SYSCTL_INT(_kern, OID_AUTO, consmsgbuf_size, CTLFLAG_RW, &consmsgbuf_size, 0,
-    "");
+    "tty buffer size");
 
 /*
  * Redirect console output to a tty.
@@ -471,7 +471,7 @@
 /* Times per second to check for pending console tty messages. */
 static int constty_wakeups_per_second = 5;
 SYSCTL_INT(_kern, OID_AUTO, constty_wakeups_per_second, CTLFLAG_RW,
-    &constty_wakeups_per_second, 0, "");
+    &constty_wakeups_per_second, 0, "Times per second to check for pending console tty messages");
 
 static void
 constty_timeout(void *arg)


>Release-Note:
>Audit-Trail:

From: Chip Camden <sterling@camdensoftware.com>
To: bug-followup@FreeBSD.org, wtfcrap@mail.ru
Cc:  
Subject: Re: kern/148580: [sysctl][patch] Document some sys/kern sysctls
Date: Sun, 8 Aug 2010 16:21:24 -0700

 --CE+1k2dSO48ffgeK
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 Content-Transfer-Encoding: quoted-printable
 
 (Bugathon)
 
 Patch applies cleanly to 8.1-STABLE and works.
 
 --=20
 Sterling (Chip) Camden    | sterling@camdensoftware.com | 2048D/3A978E4F
 http://camdensoftware.com | http://chipstips.com        | http://chipsquips=
 .com
 
 --CE+1k2dSO48ffgeK
 Content-Type: application/pgp-signature
 Content-Disposition: inline
 
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.10 (FreeBSD)
 
 iQEcBAEBAgAGBQJMXzv0AAoJEIpckszW26+RPWQH/3354odwaz5hPMYh+ePIekl4
 rRfVOMm/jpEGHcqsh2Ds5OaTlmMmvpPwZpDe5U35AL8t09pryQPPaRmDJIGYUwaj
 iEMQlER/k4WNQi6H81rPW/9x457P/dvTbmO4cmEUFFZxRbY46HIZx+RG+oxsj/IE
 ncQQ7heBIxBy6fdFtO9zjU3BsuoKGcNKEvrI5poyG18EzprwoQufasNoq4OA5yNo
 JbOlYA8Dtaj9xormyyTuMKe9/XBppOdKkNP2cozhxIAVg8htkXHXBoNmsmu14fX3
 KY/4L2Gpss84dPtuYk1Tn5TIxslXB8F9fcTwnNsyY2NRNK2LXvv12/T6WAZMg7g=
 =rt+D
 -----END PGP SIGNATURE-----
 
 --CE+1k2dSO48ffgeK--
Responsible-Changed-From-To: freebsd-bugs->gavin 
Responsible-Changed-By: gavin 
Responsible-Changed-When: Mon Aug 9 08:59:15 UTC 2010 
Responsible-Changed-Why:  
Grab this 

http://www.freebsd.org/cgi/query-pr.cgi?pr=148580 
State-Changed-From-To: open->patched 
State-Changed-By: gavin 
State-Changed-When: Mon Aug 9 14:48:40 UTC 2010 
State-Changed-Why:  
Patch committed to head (with some minor alterations) as r211102.  I'll 
merge this in a week.  Thanks for your submission! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=148580 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: kern/148580: commit references a PR
Date: Mon,  9 Aug 2010 14:48:45 +0000 (UTC)

 Author: gavin
 Date: Mon Aug  9 14:48:31 2010
 New Revision: 211102
 URL: http://svn.freebsd.org/changeset/base/211102
 
 Log:
   Add descriptions to a handful of sysctl nodes.
   
   PR:		kern/148580
   Submitted by:	Galimov Albert <wtfcrap mail.ru>
   MFC after:	1 week
 
 Modified:
   head/sys/kern/init_main.c
   head/sys/kern/kern_cons.c
   head/sys/kern/kern_ktrace.c
 
 Modified: head/sys/kern/init_main.c
 ==============================================================================
 --- head/sys/kern/init_main.c	Mon Aug  9 14:33:25 2010	(r211101)
 +++ head/sys/kern/init_main.c	Mon Aug  9 14:48:31 2010	(r211102)
 @@ -100,9 +100,11 @@ struct	vmspace vmspace0;
  struct	proc *initproc;
  
  int	boothowto = 0;		/* initialized so that it can be patched */
 -SYSCTL_INT(_debug, OID_AUTO, boothowto, CTLFLAG_RD, &boothowto, 0, "");
 +SYSCTL_INT(_debug, OID_AUTO, boothowto, CTLFLAG_RD, &boothowto, 0,
 +	"Boot control flags, passed from loader");
  int	bootverbose;
 -SYSCTL_INT(_debug, OID_AUTO, bootverbose, CTLFLAG_RW, &bootverbose, 0, "");
 +SYSCTL_INT(_debug, OID_AUTO, bootverbose, CTLFLAG_RW, &bootverbose, 0,
 +	"Control the output of verbose kernel messages");
  
  /*
   * This ensures that there is at least one entry so that the sysinit_set
 @@ -647,7 +649,8 @@ SYSCTL_STRING(_kern, OID_AUTO, init_path
  #endif
  static int init_shutdown_timeout = INIT_SHUTDOWN_TIMEOUT;
  SYSCTL_INT(_kern, OID_AUTO, init_shutdown_timeout,
 -	CTLFLAG_RW, &init_shutdown_timeout, 0, "");
 +	CTLFLAG_RW, &init_shutdown_timeout, 0, "Shutdown timeout of init(8). "
 +	"Unused within kernel, but used to control init(8)");
  
  /*
   * Start the initial user process; try exec'ing each pathname in init_path.
 
 Modified: head/sys/kern/kern_cons.c
 ==============================================================================
 --- head/sys/kern/kern_cons.c	Mon Aug  9 14:33:25 2010	(r211101)
 +++ head/sys/kern/kern_cons.c	Mon Aug  9 14:48:31 2010	(r211102)
 @@ -341,7 +341,8 @@ sysctl_kern_consmute(SYSCTL_HANDLER_ARGS
  }
  
  SYSCTL_PROC(_kern, OID_AUTO, consmute, CTLTYPE_INT|CTLFLAG_RW,
 -	0, sizeof(cn_mute), sysctl_kern_consmute, "I", "");
 +	0, sizeof(cn_mute), sysctl_kern_consmute, "I",
 +	"State of the console muting");
  
  /*
   * Low level console routines.
 @@ -429,7 +430,7 @@ cnputs(char *p)
  
  static int consmsgbuf_size = 8192;
  SYSCTL_INT(_kern, OID_AUTO, consmsgbuf_size, CTLFLAG_RW, &consmsgbuf_size, 0,
 -    "");
 +    "Console tty buffer size");
  
  /*
   * Redirect console output to a tty.
 @@ -471,7 +472,8 @@ constty_clear(void)
  /* Times per second to check for pending console tty messages. */
  static int constty_wakeups_per_second = 5;
  SYSCTL_INT(_kern, OID_AUTO, constty_wakeups_per_second, CTLFLAG_RW,
 -    &constty_wakeups_per_second, 0, "");
 +    &constty_wakeups_per_second, 0,
 +    "Times per second to check for pending console tty messages");
  
  static void
  constty_timeout(void *arg)
 
 Modified: head/sys/kern/kern_ktrace.c
 ==============================================================================
 --- head/sys/kern/kern_ktrace.c	Mon Aug  9 14:33:25 2010	(r211101)
 +++ head/sys/kern/kern_ktrace.c	Mon Aug  9 14:48:31 2010	(r211102)
 @@ -218,7 +218,8 @@ sysctl_kern_ktrace_request_pool(SYSCTL_H
  	return (0);
  }
  SYSCTL_PROC(_kern_ktrace, OID_AUTO, request_pool, CTLTYPE_UINT|CTLFLAG_RW,
 -    &ktr_requestpool, 0, sysctl_kern_ktrace_request_pool, "IU", "");
 +    &ktr_requestpool, 0, sysctl_kern_ktrace_request_pool, "IU",
 +    "Pool buffer size for ktrace(1)");
  
  static u_int
  ktrace_resize_pool(u_int newsize)
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
>Unformatted:
