Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 29 Aug 2010 10:32:32 +0100 (BST)
From:      "N.J. Mann" <njm@njm.me.uk>
To:        FreeBSD-gnats-submit@FreeBSD.org
Subject:   docs/150082: [patch] gsched.8 fixes for errors in EXAMPLES section
Message-ID:  <201008290932.o7T9WWSN070156@titania.njm.me.uk>
Resent-Message-ID: <201008291000.o7TA0OfP030044@freefall.freebsd.org>

next in thread | raw e-mail | index | archive | help

>Number:         150082
>Category:       docs
>Synopsis:       [patch] gsched.8 fixes for errors in EXAMPLES section
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Aug 29 10:00:23 UTC 2010
>Closed-Date:
>Last-Modified:
>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:
>Unformatted:



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201008290932.o7T9WWSN070156>