kern/148580: [sysctl][patch] Document some sys/kern sysctls

[Galimov Albert]

>Number:         148580
>Category:       kern
>Synopsis:       [sysctl][patch] Document some sys/kern sysctls
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-bugs
>State:          open
>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:
>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:
>Unformatted: