From n-kogane@syd.odn.ne.jp  Fri Jun 12 20:51:31 2009
Return-Path: <n-kogane@syd.odn.ne.jp>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 9FBB01065670
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 12 Jun 2009 20:51:31 +0000 (UTC)
	(envelope-from n-kogane@syd.odn.ne.jp)
Received: from cmta108.odn.ne.jp (mta108.odn.ne.jp [143.90.14.71])
	by mx1.freebsd.org (Postfix) with ESMTP id 1FE498FC17
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 12 Jun 2009 20:51:30 +0000 (UTC)
	(envelope-from n-kogane@syd.odn.ne.jp)
Received: from vmta102.odn.ne.jp by cmta102.odn.ne.jp with ESMTP
          id <20090612201541757.JRVY.26560.cmta102.odn.ne.jp@mta102.odn.ne.jp>
          for <FreeBSD-gnats-submit@freebsd.org>;
          Sat, 13 Jun 2009 05:15:41 +0900
Received: from emta102.odn.ne.jp by vmta102.odn.ne.jp with ESMTP
          id <20090612201541710.BCKT.2524.vmta102.odn.ne.jp@mta102.odn.ne.jp>;
          Sat, 13 Jun 2009 05:15:41 +0900
Received: from kcesx30.koganemaru.co.jp ([143.90.90.6] [143.90.90.6])
          by emta102.odn.ne.jp with ESMTP
          id <20090612201541616.PHFT.4625.emta102.odn.ne.jp@mta102.odn.ne.jp>;
          Sat, 13 Jun 2009 05:15:41 +0900
Received: by kcesx30.koganemaru.co.jp (Postfix, from userid 100)
	id 0F2AD28442; Sat, 13 Jun 2009 05:11:47 +0900 (JST)
Message-Id: <20090612201147.0F2AD28442@kcesx30.koganemaru.co.jp>
Date: Sat, 13 Jun 2009 05:11:47 +0900 (JST)
From: n-kogane@syd.odn.ne.jp
Reply-To: n-kogane@syd.odn.ne.jp
To: FreeBSD-gnats-submit@freebsd.org
Cc: zml@FreeBSD.org
Subject: typos in fail.9
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         135520
>Category:       docs
>Synopsis:       [patch] typos in fail(9)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    brueffer
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Jun 12 21:00:07 UTC 2009
>Closed-Date:    Thu Oct 22 11:05:10 CEST 2009
>Last-Modified:  Thu Oct 22 11:05:10 CEST 2009
>Originator:     Nobuyuki Koganemaru
>Release:        FreeBSD 8.0-CURRENT i386
>Organization:
KOGANEMARU Computer Engineering Service Corporation.
>Environment:
System: FreeBSD kcesx35.koganemaru.co.jp 8.0-CURRENT FreeBSD 8.0-CURRENT #3: Fri May 29 23:21:44 JST 2009 root@kcesx35.koganemaru.co.jp:/usr/obj/usr/src/sys/GENERIC i386


>Description:
	I found some typos in fail.9.
	.\" $FreeBSD: src/share/man/man9/fail.9,v 1.2 2009/05/28 15:02:52 zml Exp $
	'execute' ... is not displayed.
>How-To-Repeat:
	Do "man 9 fail".
>Fix:

--- fail.9.orig	2009-06-13 05:01:27.000000000 +0900
+++ fail.9	2009-06-13 05:02:05.000000000 +0900
@@ -37,7 +37,7 @@
 .Nm KFAIL_POINT_GOTO ,
 .Nm fail_point ,
 .Nm DEBUG_FP
-.
+.\"
 .Nd fail points
 .Sh SYNOPSIS
 .In sys/fail.h
@@ -159,7 +159,7 @@
 .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.
+\&'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()

>Release-Note:
>Audit-Trail:

From: Gavin Atkinson <gavin@FreeBSD.org>
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/135520: [patch] typos in fail(9)
Date: Wed, 12 Aug 2009 15:53:33 +0100

 This problem is real, but I think the provided fix is incorrect.
 Updated patch at http://people.freebsd.org/~gavin/PRs/135520.diff
State-Changed-From-To: open->patched 
State-Changed-By: brueffer 
State-Changed-When: Fri Sep 18 16:06:07 CEST 2009 
State-Changed-Why:  
Fixed in HEAD, MFC pending. 


Responsible-Changed-From-To: freebsd-doc->brueffer 
Responsible-Changed-By: brueffer 
Responsible-Changed-When: Fri Sep 18 16:06:07 CEST 2009 
Responsible-Changed-Why:  
Fixed in HEAD, MFC pending. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=135520 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/135520: commit references a PR
Date: Fri, 18 Sep 2009 14:06:19 +0000 (UTC)

 Author: brueffer
 Date: Fri Sep 18 14:05:56 2009
 New Revision: 197310
 URL: http://svn.freebsd.org/changeset/base/197310
 
 Log:
   Fix mdoc, typos, contractions.
   
   This includes:
   PR:		135520
   Submitted by:	Nobuyuki Koganemaru
   Patch by:	gavin
   MFC after:	3 days
 
 Modified:
   head/share/man/man9/fail.9
 
 Modified: head/share/man/man9/fail.9
 ==============================================================================
 --- head/share/man/man9/fail.9	Fri Sep 18 13:48:38 2009	(r197309)
 +++ head/share/man/man9/fail.9	Fri Sep 18 14:05:56 2009	(r197310)
 @@ -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
  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 o
  .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
 _______________________________________________
 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"
 
State-Changed-From-To: patched->closed 
State-Changed-By: brueffer 
State-Changed-When: Thu Oct 22 11:04:55 CEST 2009 
State-Changed-Why:  
MFC done. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=135520 
>Unformatted:
