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

Fix mdoc, typos, contractions.

Browse Source 
This includes:
PR:		135520
Submitted by:	Nobuyuki Koganemaru
Patch by:	gavin
MFC after:	3 days
This commit is contained in:
Christian Brueffer 2009-09-18 14:05:56 +00:00
parent 39df6da8cc
commit aa8775c640
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
share/man/man9/fail.9
View File

@ -37,7 +37,6 @@
.Nm KFAIL_POINT_GOTO ,
.Nm fail_point ,
.Nm DEBUG_FP
.
.Nd fail points
.Sh SYNOPSIS
.In sys/fail.h
@ -79,7 +78,7 @@ is derived from the
.Fn return
value set in the sysctl MIB.
See
.Sx SYSCTL SETTINGS
.Sx SYSCTL VARIABLES
below.
.Pp
The remaining
@ -100,7 +99,6 @@ is the equivalent of
.Sy KFAIL_POINT_CODE(...,
{ error_var = RETURN_VALUE; goto label;})
.El
.Pp
.Sh SYSCTL VARIABLES
The
.Fn KFAIL_POINT_*
@ -108,28 +106,28 @@ macros add sysctl MIBs where specified.
Many base kernel MIBs can be found in the
.Sy debug.fail_point
tree (referenced in code by
.Sy DEBUG_FP
).
.Sy DEBUG_FP ) .
.Pp
The sysctl variable may be set using the following grammar:
.Pp
.Bd -literal
<fail_point> ::
<term> ( "->" <term> )*
.Pp
<term> ::
( (<float> "%") | (<integer> "*" ) )*
<type>
[ "(" <integer> ")" ]
.Pp
<float> ::
<integer> [ "." <integer> ] |
"." <integer>
.Pp
<type> ::
"off" | "return" | "sleep" | "panic" | "break" | "print"
.Ed
.Pp
The <type>
argument specifies which action to take:
The <type> argument specifies which action to take:
.Bl -tag -width ".Dv return"
.It Sy off
Take no action (does not trigger fail point code)
@ -158,13 +156,13 @@ is evaluated before the count, i.e. "2%5*" means "2% of the time,
but only 5 times total".
.Pp
The operator -> can be used to express cascading terms.
If you specify <term1>-><term2>, it means that if <term1> doesn't
'execute', <term2> is evaluated.
If you specify <term1>-><term2>, it means that if <term1> does not
.Ql execute ,
<term2> is evaluated.
For the purpose of this operator, the return() and print() operators
are the only types that cascade.
A return() term only cascades if the code executes, and a print()
term only cascades when passed a non-zero argument.
.Pp
.Sh EXAMPLES
.Bl -tag
.It Sy sysctl debug.fail_point.foobar="2.1%return(5)"
@ -175,7 +173,7 @@ with RETURN_VALUE set to 5.
2/100ths of the time, execute
.Fa code
with RETURN_VALUE set to 5.
If that doesn't happen, 5% of the time execute
If that does not happen, 5% of the time execute
.Fa code
with RETURN_VALUE set to 22.
.It Sy sysctl debug.fail_point.foobar="5*return(5)->0.1%return(22)"
@ -186,9 +184,8 @@ Return 5 for 1 in 1000 executions, but only 5 times total.
.It Sy sysctl debug.fail_point.foobar="1%*sleep(50)"
1/100th of the time, sleep 50ms.
.El
.Pp
.Sh CAVEATS
It's easy to shoot yourself in the foot by setting fail points too
It is easy to shoot yourself in the foot by setting fail points too
aggressively or setting too many in combination.
For example, forcing
.Fn malloc
@ -201,7 +198,6 @@ Currently,
.Fn fail_point_eval
does not verify whether the context is appropriate for calling
.Fn msleep .
.Pp
.Sh AUTHORS
.An -nosplit
This manual page was written by