ktr(4): Add some sysctl descriptions for viewing with sysctl -d.
authorSascha Wildner <saw@online.de>
Sat, 16 Jul 2011 19:34:50 +0000 (21:34 +0200)
committerSascha Wildner <saw@online.de>
Sat, 16 Jul 2011 19:34:50 +0000 (21:34 +0200)
sys/kern/kern_ktr.c
sys/sys/ktr.h

index 9f902f0..d10becf 100644 (file)
@@ -131,7 +131,8 @@ MALLOC_DEFINE(M_KTR, "ktr", "ktr buffers");
 SYSCTL_NODE(_debug, OID_AUTO, ktr, CTLFLAG_RW, 0, "ktr");
 
 int            ktr_entries = KTR_ENTRIES;
-SYSCTL_INT(_debug_ktr, OID_AUTO, entries, CTLFLAG_RD, &ktr_entries, 0, "");
+SYSCTL_INT(_debug_ktr, OID_AUTO, entries, CTLFLAG_RD, &ktr_entries, 0,
+    "Size of the event buffer");
 
 int            ktr_version = KTR_VERSION;
 SYSCTL_INT(_debug_ktr, OID_AUTO, version, CTLFLAG_RD, &ktr_version, 0, "");
@@ -140,7 +141,8 @@ static int  ktr_stacktrace = 1;
 SYSCTL_INT(_debug_ktr, OID_AUTO, stacktrace, CTLFLAG_RD, &ktr_stacktrace, 0, "");
 
 static int     ktr_resynchronize = 0;
-SYSCTL_INT(_debug_ktr, OID_AUTO, resynchronize, CTLFLAG_RW, &ktr_resynchronize, 0, "");
+SYSCTL_INT(_debug_ktr, OID_AUTO, resynchronize, CTLFLAG_RW,
+    &ktr_resynchronize, 0, "Resynchronize TSC 10 times a second");
 
 #if KTR_TESTLOG
 static int     ktr_testlogcnt = 0;
@@ -174,7 +176,8 @@ struct callout      ktr_resync_callout;
 #ifdef KTR_VERBOSE
 int    ktr_verbose = KTR_VERBOSE;
 TUNABLE_INT("debug.ktr.verbose", &ktr_verbose);
-SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0, "");
+SYSCTL_INT(_debug_ktr, OID_AUTO, verbose, CTLFLAG_RW, &ktr_verbose, 0,
+    "Log events to the console as well");
 #endif
 
 static void ktr_resync_callback(void *dummy __unused);
index 2f97505..dc933f9 100644 (file)
@@ -30,8 +30,6 @@
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
- * 
- * $DragonFly: src/sys/sys/ktr.h,v 1.12 2008/06/20 01:23:27 y0netan1 Exp $
  */
 /*
  * Generic Kernel trace buffer support.  
@@ -122,7 +120,8 @@ SYSCTL_DECL(_debug_ktr);
            SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, "");   \
            int ktr_ ## master ## _enable = KTR_AUTO_ENABLE;                \
            SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \
-                       &ktr_ ## master ## _enable, 0, "")
+               &ktr_ ## master ## _enable, 0,                              \
+               "Bit mask to control " __XSTRING(master) "'s event logging")
 
 #define KTR_INFO_MASTER_EXTERN(master)                                 \
            SYSCTL_DECL(_debug_ktr_ ## master);                         \
@@ -143,7 +142,7 @@ SYSCTL_DECL(_debug_ktr);
                1 << maskbit;                                           \
            SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask,  \
                CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro,   \
-               0, "");                                                 \
+               0, "Value of the " __XSTRING(name) " event in " __XSTRING(master) "'s mask"); \
            static struct ktr_info ktr_info_ ## master ## _ ## name = { \
                #master "_" #name,                                      \
                &ktr_ ## master ## _enable,                             \