Bug 150082

Summary:

[patch] gsched.8 fixes for errors in EXAMPLES section

Product:

Documentation

Reporter:

N.J. Mann <njm>

Component:

Books & Articles

Assignee:

Ulrich Spörlein <uqs>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
gsched.8.patch.diff	none
file.diff	none

Description N.J. Mann 2010-08-29 11:00:23 UTC

	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

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'.
How-To-Repeat: 	man gsched

Comment 1 Ulrich Spörlein freebsd_committer

2010-08-29 12:21:50 UTC

Responsible Changed
From-To: freebsd-doc->uqs

I'll take it.

Comment 2 dfilter service freebsd_committer

2010-08-29 12:32:54 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"

Comment 3 Alexander Best freebsd_committer

2010-09-03 00:49:52 UTC

State Changed
From-To: open->patched

Patched in HEAD (r211962). 
Needs only MFC to 8, since gsched doesn't exist in 7 if i'm not mistaken.

Comment 4 Ulrich Spörlein freebsd_committer

2010-09-03 12:59:06 UTC

State Changed
From-To: patched->closed

Committed. Thanks!