From njm@njm.me.uk  Sun Aug 29 09:59:15 2010
Return-Path: <njm@njm.me.uk>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id A878A1065670
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 29 Aug 2010 09:59:15 +0000 (UTC)
	(envelope-from njm@njm.me.uk)
Received: from smtp003.apm-internet.net (smtp003.apm-internet.net [85.119.248.52])
	by mx1.freebsd.org (Postfix) with SMTP id 20EE38FC1E
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 29 Aug 2010 09:59:14 +0000 (UTC)
Received: (qmail 33175 invoked from network); 29 Aug 2010 09:32:33 -0000
Received: from unknown (HELO oberon.njm.me.uk) (86.148.212.219)
  by smtp003.apm-internet.net with SMTP; 29 Aug 2010 09:32:33 -0000
Received: from titania.njm.me.uk (titania.njm.me.uk [192.168.144.130])
	by oberon.njm.me.uk (8.14.4/8.14.4) with ESMTP id o7T9WXe5090623
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 29 Aug 2010 10:32:33 +0100 (BST)
	(envelope-from njm@oberon.njm.me.uk)
Received: from titania.njm.me.uk (localhost [127.0.0.1])
	by titania.njm.me.uk (8.14.4/8.14.4) with ESMTP id o7T9WXTi070188
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 29 Aug 2010 10:32:33 +0100 (BST)
	(envelope-from njm@titania.njm.me.uk)
Received: (from njm@localhost)
	by titania.njm.me.uk (8.14.4/8.14.4/Submit) id o7T9WWSN070156;
	Sun, 29 Aug 2010 10:32:32 +0100 (BST)
	(envelope-from njm)
Message-Id: <201008290932.o7T9WWSN070156@titania.njm.me.uk>
Date: Sun, 29 Aug 2010 10:32:32 +0100 (BST)
From: "N.J. Mann" <njm@njm.me.uk>
Reply-To: "N.J. Mann" <njm@njm.me.uk>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [patch] gsched.8 fixes for errors in EXAMPLES section
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         150082
>Category:       docs
>Synopsis:       [patch] gsched.8 fixes for errors in EXAMPLES section
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    uqs
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Aug 29 10:00:23 UTC 2010
>Closed-Date:    Fri Sep 03 11:59:07 UTC 2010
>Last-Modified:  Fri Sep 03 11:59:07 UTC 2010
>Originator:     N.J. Mann
>Release:        FreeBSD 8.1-STABLE i386
>Organization:
>Environment:
System: FreeBSD titania.njm.me.uk 8.1-STABLE FreeBSD 8.1-STABLE #26 r211698M: Mon Aug 23 09:07:05 BST 2010 njm@titania.njm.me.uk:/usr/obj/usr/src/sys/titania i386


	
>Description:
	In the example in the EXAMPLES section of the gsched(8) man page it
begins by claiming that the example will 'create a scheduling provider for
disk /dev/da0'.  However, the example is actually for ad0.

Also, the example uses 'geom sched insert -s rr' .  There is no option 's'.
This should (probably) be 'geom sched insert -a rr'.  This was noted
by Bruce Cran[1] when gsched was originally committed to SVN, but seems to
have been ignored.

[1] http://docs.freebsd.org/cgi/getmsg.cgi?fetch=0+0+archive/2010/svn-src-all/20100502.svn-src-all

>How-To-Repeat:
	man gsched
>Fix:

	The first patch changes /dev/da0 to /dev/ad0 so that the example is
correct within itself.  The second patch changes '-s rr' to '-a rr'.

--- gsched.8.patch.diff begins here ---
--- gsched.8.orig	2010-08-29 09:56:38.000000000 +0100
+++ gsched.8	2010-08-29 09:58:03.000000000 +0100
@@ -135,7 +135,7 @@
 Exit status is 0 on success, and 1 if the command fails.
 .Sh EXAMPLES
 The following example shows how to create a scheduling provider for disk
-.Pa /dev/da0
+.Pa /dev/ad0
 , and how to destroy it.
 .Bd -literal -offset indent
 # Load the geom_sched module:
--- gsched.8.patch.diff ends here ---

--- gsched.8.patch2.diff begins here ---
--- gsched.8~	2010-08-29 09:58:03.000000000 +0100
+++ gsched.8	2010-08-29 10:16:32.000000000 +0100
@@ -143,7 +143,7 @@
 # Load some scheduler classes used by geom_sched:
 kldload gsched_rr gsched_as
 # Configure device ad0 to use scheduler 'rr':
-geom sched insert -s rr ad0
+geom sched insert -a rr ad0
 # Now provider ad0 uses the 'rr' algorithm;
 # the new geom is ad0.sched.
 # Remove the scheduler on the device:
--- gsched.8.patch2.diff ends here ---


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->uqs 
Responsible-Changed-By: uqs 
Responsible-Changed-When: Sun Aug 29 11:21:50 UTC 2010 
Responsible-Changed-Why:  
I'll take it. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/150082: commit references a PR
Date: Sun, 29 Aug 2010 11:32:54 +0000 (UTC)

 Author: uqs
 Date: Sun Aug 29 11:32:41 2010
 New Revision: 211962
 URL: http://svn.freebsd.org/changeset/base/211962
 
 Log:
   gsched(8): fix example usage, mdoc nits
   
   - ad0 was referred to as da0
   - wrong parameter -s instead of -a in example
   - use double quotes consistently
   
   PR:            docs/150082
   Submitted by:  N.J. Mann <njm@njm.me.uk>
   MFC after:     2 weeks
 
 Modified:
   head/sbin/geom/class/sched/gsched.8
 
 Modified: head/sbin/geom/class/sched/gsched.8
 ==============================================================================
 --- head/sbin/geom/class/sched/gsched.8	Sun Aug 29 08:19:07 2010	(r211961)
 +++ head/sbin/geom/class/sched/gsched.8	Sun Aug 29 11:32:41 2010	(r211962)
 @@ -25,7 +25,7 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd April 12, 2010
 +.Dd August 29, 2010
  .Dt GSCHED 8
  .Os
  .Sh NAME
 @@ -92,7 +92,7 @@ which in turn forwards requests to the e
  This operation allows one to start/stop a scheduling service
  on an already existing provider.
  .Pp
 -A subsequent 'destroy' will remove the newly created geom and
 +A subsequent "destroy" will remove the newly created geom and
  hook the provider back to the original geom.
  .It Cm configure
  Configure existing scheduling provider.  It supports the same options
 @@ -135,16 +135,16 @@ maximum amount of debug information is p
  Exit status is 0 on success, and 1 if the command fails.
  .Sh EXAMPLES
  The following example shows how to create a scheduling provider for disk
 -.Pa /dev/da0
 -, and how to destroy it.
 +.Pa /dev/ad0 ,
 +and how to destroy it.
  .Bd -literal -offset indent
  # Load the geom_sched module:
  kldload geom_sched
  # Load some scheduler classes used by geom_sched:
  kldload gsched_rr gsched_as
 -# Configure device ad0 to use scheduler 'rr':
 -geom sched insert -s rr ad0
 -# Now provider ad0 uses the 'rr' algorithm;
 +# Configure device ad0 to use scheduler "rr":
 +geom sched insert -a rr ad0
 +# Now provider ad0 uses the "rr" algorithm;
  # the new geom is ad0.sched.
  # Remove the scheduler on the device:
  geom sched destroy -v ad0.sched.
 _______________________________________________
 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: open->patched 
State-Changed-By: arundel 
State-Changed-When: Thu Sep 2 23:49:52 UTC 2010 
State-Changed-Why:  
Patched in HEAD (r211962). 
Needs only MFC to 8, since gsched doesn't exist in 7 if i'm not mistaken. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=150082 
State-Changed-From-To: patched->closed 
State-Changed-By: uqs 
State-Changed-When: Fri Sep 3 11:59:06 UTC 2010 
State-Changed-Why:  
Committed. Thanks! 

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