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

Clean up ddb(4) slightly

Browse Source 
- Delete empty Li macro uses [1]. This removes some spaces between
  the optional command/subcommand arguments.
- Attempt to clarify "show lock" subcommand by being more
  terse/direct. This addresses an issue with a contraction [2].

MFC after:	1 week
Reported by:	make manlint [1], igor [2]
Reviewed by:	wblock
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D9858
This commit is contained in:
Enji Cooper 2017-03-03 18:44:20 +00:00
parent 1f827dab9e
commit 12edba1ef1
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,7 +60,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd July 13, 2016 .Dd March 3, 2017
.Dt DDB 4 .Dt DDB 4
.Os .Os
.Sh NAME .Sh NAME
@ -146,7 +146,7 @@ to be the same as
.Pp .Pp
The general command syntax is: The general command syntax is:
.Ar command Ns Op Li / Ns Ar modifier .Ar command Ns Op Li / Ns Ar modifier
.Oo Ar addr Oc Ns Op Li , Ns Ar count .Oo Ar addr Oc Ns Op , Ns Ar count
.Pp .Pp
A blank line repeats the previous command from the address A blank line repeats the previous command from the address
.Va next .Va next
@ -213,11 +213,11 @@ current line.
.Bl -tag -width indent -compact .Bl -tag -width indent -compact
.It Xo .It Xo
.Ic examine Ns Op Li / Ns Cm AISabcdghilmorsuxz ... .Ic examine Ns Op Li / Ns Cm AISabcdghilmorsuxz ...
.Oo Ar addr Oc Ns Op Li , Ns Ar count .Oo Ar addr Oc Ns Op , Ns Ar count
.Xc .Xc
.It Xo .It Xo
.Ic x Ns Op Li / Ns Cm AISabcdghilmorsuxz ... .Ic x Ns Op Li / Ns Cm AISabcdghilmorsuxz ...
.Oo Ar addr Oc Ns Op Li , Ns Ar count .Oo Ar addr Oc Ns Op , Ns Ar count
.Xc .Xc
Display the addressed locations according to the formats in the modifier. Display the addressed locations according to the formats in the modifier.
Multiple modifier formats display multiple locations. Multiple modifier formats display multiple locations.
@ -343,8 +343,8 @@ Set the named variable or register with the value of
.Ar expr . .Ar expr .
Valid variable names are described below. Valid variable names are described below.
.Pp .Pp
.It Ic break Ns Oo Li / Ns Cm u Oc Oo Ar addr Oc Ns Op Li , Ns Ar count .It Ic break Ns Oo Li / Ns Cm u Oc Oo Ar addr Oc Ns Op , Ns Ar count
.It Ic b Ns Oo Li / Ns Cm u Oc Oo Ar addr Oc Ns Op Li , Ns Ar count .It Ic b Ns Oo Li / Ns Cm u Oc Oo Ar addr Oc Ns Op , Ns Ar count
Set a break point at Set a break point at
.Ar addr . .Ar addr .
If If
@ -394,7 +394,7 @@ command, or by omitting
to get the default address of to get the default address of
.Va dot . .Va dot .
.Pp .Pp
.It Ic watch Oo Ar addr Oc Ns Op Li , Ns Ar size .It Ic watch Oo Ar addr Oc Ns Op , Ns Ar size
Set a watchpoint for a region. Set a watchpoint for a region.
Execution stops when an attempt to modify the region occurs. Execution stops when an attempt to modify the region occurs.
The The
@ -408,7 +408,7 @@ Attempts to watch wired kernel memory
may cause unrecoverable error in some systems such as i386. may cause unrecoverable error in some systems such as i386.
Watchpoints on user addresses work best. Watchpoints on user addresses work best.
.Pp .Pp
.It Ic hwatch Oo Ar addr Oc Ns Op Li , Ns Ar size .It Ic hwatch Oo Ar addr Oc Ns Op , Ns Ar size
Set a hardware watchpoint for a region if supported by the Set a hardware watchpoint for a region if supported by the
architecture. architecture.
Execution stops when an attempt to modify the region occurs. Execution stops when an attempt to modify the region occurs.
@ -424,11 +424,11 @@ Use
for setting watchpoints on kernel address locations only, and avoid for setting watchpoints on kernel address locations only, and avoid
its use on user mode address spaces. its use on user mode address spaces.
.Pp .Pp
.It Ic dhwatch Oo Ar addr Oc Ns Op Li , Ns Ar size .It Ic dhwatch Oo Ar addr Oc Ns Op , Ns Ar size
Delete specified hardware watchpoint. Delete specified hardware watchpoint.
.Pp .Pp
.It Ic step Ns Oo Li / Ns Cm p Oc Ns Op Li , Ns Ar count .It Ic step Ns Oo Li / Ns Cm p Oc Ns Op , Ns Ar count
.It Ic s Ns Oo Li / Ns Cm p Oc Ns Op Li , Ns Ar count .It Ic s Ns Oo Li / Ns Cm p Oc Ns Op , Ns Ar count
Single step Single step
.Ar count .Ar count
times. times.
@ -478,22 +478,22 @@ Otherwise, only print when the matching return is hit.
.It Xo .It Xo
.Ic trace Ns Op Li / Ns Cm u .Ic trace Ns Op Li / Ns Cm u
.Op Ar pid | tid Ns .Op Ar pid | tid Ns
.Op Li , Ns Ar count .Op , Ns Ar count
.Xc .Xc
.It Xo .It Xo
.Ic t Ns Op Li / Ns Cm u .Ic t Ns Op Li / Ns Cm u
.Op Ar pid | tid Ns .Op Ar pid | tid Ns
.Op Li , Ns Ar count .Op , Ns Ar count
.Xc .Xc
.It Xo .It Xo
.Ic where Ns Op Li / Ns Cm u .Ic where Ns Op Li / Ns Cm u
.Op Ar pid | tid Ns .Op Ar pid | tid Ns
.Op Li , Ns Ar count .Op , Ns Ar count
.Xc .Xc
.It Xo .It Xo
.Ic bt Ns Op Li / Ns Cm u .Ic bt Ns Op Li / Ns Cm u
.Op Ar pid | tid Ns .Op Ar pid | tid Ns
.Op Li , Ns Ar count .Op , Ns Ar count
.Xc .Xc
Stack trace. Stack trace.
The The
@ -518,7 +518,7 @@ only if the machine dependent code supports it.
.Ar addr .Ar addr
.Ar value .Ar value
.Op Ar mask Ns .Op Ar mask Ns
.Op Li , Ns Ar count .Op , Ns Ar count
.Xc .Xc
Search memory for Search memory for
.Ar value . .Ar value .
@ -768,12 +768,12 @@ Possible types include
Name of the lock. Name of the lock.
.It Ic flags: .It Ic flags:
Flags passed to the lock initialization function. Flags passed to the lock initialization function.
For exact possibilities see manual pages of possible lock types. .Em flags
values are lock class specific.
.It Ic state: .It Ic state:
Current state of a lock. Current state of a lock.
As well as .Em state
.Ic flags values are lock class specific.
it's lock-specific.
.It Ic owner: .It Ic owner:
Lock owner. Lock owner.
.El .El