d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use .Va for sysctls, not .Dv.

Browse Source 
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
This commit is contained in:
Edward Tomasz Napierala 2018-11-30 11:50:41 +00:00
parent 6ce4ddc466
commit 7b8bdbef02
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=341340
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
share/man/man4/ddb.4
View File

@ -109,7 +109,7 @@ it can be invoked locally with the
.Ql debug .Ql debug
.Xr keymap 5 .Xr keymap 5
action, usually mapped to Ctrl+Alt+Esc, or by setting the action, usually mapped to Ctrl+Alt+Esc, or by setting the
.Dv debug.kdb.enter .Va debug.kdb.enter
sysctl to 1. sysctl to 1.
The debugger is also invoked on kernel The debugger is also invoked on kernel
.Xr panic 9 .Xr panic 9
@ -1207,17 +1207,17 @@ Userspace processes may inspect and manage
capture state using capture state using
.Xr sysctl 8 : .Xr sysctl 8 :
.Pp .Pp
.Dv debug.ddb.capture.bufsize .Va debug.ddb.capture.bufsize
may be used to query or set the current capture buffer size. may be used to query or set the current capture buffer size.
.Pp .Pp
.Dv debug.ddb.capture.maxbufsize .Va debug.ddb.capture.maxbufsize
may be used to query the compile-time limit on the capture buffer size. may be used to query the compile-time limit on the capture buffer size.
.Pp .Pp
.Dv debug.ddb.capture.bytes .Va debug.ddb.capture.bytes
may be used to query the number of bytes of output currently in the capture may be used to query the number of bytes of output currently in the capture
buffer. buffer.
.Pp .Pp
.Dv debug.ddb.capture.data .Va debug.ddb.capture.data
returns the contents of the buffer as a string to an appropriately privileged returns the contents of the buffer as a string to an appropriately privileged
process. process.
.Pp .Pp
@ -1419,58 +1419,58 @@ Certain scripts are run automatically, if defined, for specific
events. events.
The follow scripts are run when various events occur: The follow scripts are run when various events occur:
.Bl -tag -width kdb.enter.powerfail .Bl -tag -width kdb.enter.powerfail
.It Dv kdb.enter.acpi .It Va kdb.enter.acpi
The kernel debugger was entered as a result of an The kernel debugger was entered as a result of an
.Xr acpi 4 .Xr acpi 4
event. event.
.It Dv kdb.enter.bootflags .It Va kdb.enter.bootflags
The kernel debugger was entered at boot as a result of the debugger boot The kernel debugger was entered at boot as a result of the debugger boot
flag being set. flag being set.
.It Dv kdb.enter.break .It Va kdb.enter.break
The kernel debugger was entered as a result of a serial or console break. The kernel debugger was entered as a result of a serial or console break.
.It Dv kdb.enter.cam .It Va kdb.enter.cam
The kernel debugger was entered as a result of a The kernel debugger was entered as a result of a
.Xr CAM 4 .Xr CAM 4
event. event.
.It Dv kdb.enter.mac .It Va kdb.enter.mac
The kernel debugger was entered as a result of an assertion failure in the The kernel debugger was entered as a result of an assertion failure in the
.Xr mac_test 4 .Xr mac_test 4
module of the module of the
TrustedBSD MAC Framework. TrustedBSD MAC Framework.
.It Dv kdb.enter.ndis .It Va kdb.enter.ndis
The kernel debugger was entered as a result of an The kernel debugger was entered as a result of an
.Xr ndis 4 .Xr ndis 4
breakpoint event. breakpoint event.
.It Dv kdb.enter.netgraph .It Va kdb.enter.netgraph
The kernel debugger was entered as a result of a The kernel debugger was entered as a result of a
.Xr netgraph 4 .Xr netgraph 4
event. event.
.It Dv kdb.enter.panic .It Va kdb.enter.panic
.Xr panic 9 .Xr panic 9
was called. was called.
.It Dv kdb.enter.powerfail .It Va kdb.enter.powerfail
The kernel debugger was entered as a result of a powerfail NMI on the sparc64 The kernel debugger was entered as a result of a powerfail NMI on the sparc64
platform. platform.
.It Dv kdb.enter.powerpc .It Va kdb.enter.powerpc
The kernel debugger was entered as a result of an unimplemented interrupt The kernel debugger was entered as a result of an unimplemented interrupt
type on the powerpc platform. type on the powerpc platform.
.It Dv kdb.enter.sysctl .It Va kdb.enter.sysctl
The kernel debugger was entered as a result of the The kernel debugger was entered as a result of the
.Dv debug.kdb.enter .Va debug.kdb.enter
sysctl being set. sysctl being set.
.It Dv kdb.enter.trapsig .It Va kdb.enter.trapsig
The kernel debugger was entered as a result of a trapsig event on the sparc64 The kernel debugger was entered as a result of a trapsig event on the sparc64
platform. platform.
.It Dv kdb.enter.unionfs .It Va kdb.enter.unionfs
The kernel debugger was entered as a result of an assertion failure in the The kernel debugger was entered as a result of an assertion failure in the
union file system. union file system.
.It Dv kdb.enter.unknown .It Va kdb.enter.unknown
The kernel debugger was entered, but no reason has been set. The kernel debugger was entered, but no reason has been set.
.It Dv kdb.enter.vfslock .It Va kdb.enter.vfslock
The kernel debugger was entered as a result of a VFS lock violation. The kernel debugger was entered as a result of a VFS lock violation.
.It Dv kdb.enter.watchdog .It Va kdb.enter.watchdog
The kernel debugger was entered as a result of a watchdog firing. The kernel debugger was entered as a result of a watchdog firing.
.It Dv kdb.enter.witness .It Va kdb.enter.witness
The kernel debugger was entered as a result of a The kernel debugger was entered as a result of a
.Xr witness 4 .Xr witness 4
violation. violation.
@ -1480,14 +1480,14 @@ In the event that none of these scripts is found,
.Nm .Nm
will attempt to execute a default script: will attempt to execute a default script:
.Bl -tag -width kdb.enter.powerfail .Bl -tag -width kdb.enter.powerfail
.It Dv kdb.enter.default .It Va kdb.enter.default
The kernel debugger was entered, but a script exactly matching the reason for The kernel debugger was entered, but a script exactly matching the reason for
entering was not defined. entering was not defined.
This can be used as a catch-all to handle cases not specifically of interest; This can be used as a catch-all to handle cases not specifically of interest;
for example, for example,
.Dv kdb.enter.witness .Va kdb.enter.witness
might be defined to have special handling, and might be defined to have special handling, and
.Dv kdb.enter.default .Va kdb.enter.default
might be defined to simply panic and reboot. might be defined to simply panic and reboot.
.El .El
.Sh HINTS .Sh HINTS
@ -1498,7 +1498,7 @@ debugging.
Modern server systems typically use IPMI to generate signals to enter the Modern server systems typically use IPMI to generate signals to enter the
debugger. debugger.
The The
.Dv devel/ipmitool .Va devel/ipmitool
port can be used to send the port can be used to send the
.Cd chassis power diag .Cd chassis power diag
command which delivers an NMI to the processor. command which delivers an NMI to the processor.
@ -1528,16 +1528,16 @@ and then releasing both.
The break to enter the debugger behavior may be enabled at run-time The break to enter the debugger behavior may be enabled at run-time
by setting the by setting the
.Xr sysctl 8 .Xr sysctl 8
.Dv debug.kdb.break_to_debugger .Va debug.kdb.break_to_debugger
to 1. to 1.
The alternate sequence to enter the debugger behavior may be enabled The alternate sequence to enter the debugger behavior may be enabled
at run-time by setting the at run-time by setting the
.Xr sysctl 8 .Xr sysctl 8
.Dv debug.kdb.alt_break_to_debugger .Va debug.kdb.alt_break_to_debugger
to 1. to 1.
The debugger may be entered by setting the The debugger may be entered by setting the
.Xr sysctl 8 .Xr sysctl 8
.Dv debug.kdb.enter .Va debug.kdb.enter
to 1. to 1.
.Sh FILES .Sh FILES
Header files mentioned in this manual page can be found below Header files mentioned in this manual page can be found below