Bug 148580 - [sysctl][patch] Document some sys/kern sysctls
Summary: [sysctl][patch] Document some sys/kern sysctls
Status: Closed FIXED
Alias: None
Product: Base System
Classification: Unclassified
Component: kern (show other bugs)
Version: Unspecified
Hardware: Any Any
: Normal Affects Only Me
Assignee: Gavin Atkinson
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-07-13 22:10 UTC by Alt
Modified: 2018-10-02 19:22 UTC (History)
1 user (show)

See Also:
bugmeister: mfc-stable10?
bugmeister: mfc-stable9?
bugmeister: mfc-stable8?


Attachments
file.diff (2.61 KB, patch)
2010-07-13 22:10 UTC, Alt
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Alt 2010-07-13 22:10:01 UTC
Working on documenting sysctls

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


Patch attached with submission follows:
Comment 1 SterlingCamden 2010-08-09 00:21:24 UTC
(Bugathon)

Patch applies cleanly to 8.1-STABLE and works.

-- 
Sterling (Chip) Camden    | sterling@camdensoftware.com | 2048D/3A978E4F
http://camdensoftware.com | http://chipstips.com        | http://chipsquips.com
Comment 2 Gavin Atkinson freebsd_committer freebsd_triage 2010-08-09 09:59:15 UTC
Responsible Changed
From-To: freebsd-bugs->gavin

Grab this
Comment 3 Gavin Atkinson freebsd_committer freebsd_triage 2010-08-09 15:48:40 UTC
State Changed
From-To: open->patched

Patch committed to head (with some minor alterations) as r211102.  I'll 
merge this in a week.  Thanks for your submission!
Comment 4 dfilter service freebsd_committer freebsd_triage 2010-08-09 15:48:45 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"
Comment 5 Ed Maste freebsd_committer freebsd_triage 2018-10-02 19:22:17 UTC
Committed by gavin@