docs/52566: [PATCH] typing error in device_get_ivars.9 man page.

[Akira Ikeuchi]

>Number:         52566
>Category:       docs
>Synopsis:       Typing error in device_get_ivars.9 man page.
>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:   Thu May 22 04:00:26 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     Akira Ikeuchi
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
T.I.T. Corp.
>Environment:
System: FreeBSD vmware50.mic.mitsumi.co.jp 5.0-RELEASE FreeBSD 5.0-RELEASE #2: Mon Mar 3 10:27:48 JST 2003 root at vmware50.mic.mitsumi.co.jp:/usr/src/sys/i386/compile/VMWARE i386
	VMware 2.0.4 on MS-Windows, FreeBSD 5.0-RELEASE
>Description:
	Some typing errors are included in device_[gs]et_ivars.9 man page.
	These errors were added when updating ver.1.6 to ver.1.7.

	The first is in SYNOPSIS section, two device_get_ivars functions
	are exists, and no device_set_ivars function. Maybe, second
	device_get_ivars is typing error, and to be device_set_ivars.

	The second is in DESCRIPTION section. On the first line .Pp macro
	is not needed, but no affection.

	The third is in DESCRIPTION section. device_[gs]et_ivars functions
	is mis-typed to device_[gs]et_ivar. Last letter 's' is dropped.
>How-To-Repeat:
	man 9 device_get_ivars
>Fix:
	Patch below.

--- device_get_ivars.9.orig	Wed May 21 19:24:40 2003
+++ device_get_ivars.9	Wed May 21 19:25:13 2003
@@ -41,15 +41,14 @@
 .Ft void *
 .Fn device_get_ivars "device_t dev"
 .Ft void
-.Fn device_get_ivars "device_t dev" "void *ivar"
+.Fn device_set_ivars "device_t dev" "void *ivar"
 .Sh DESCRIPTION
-.Pp
 The
-.Nm device_get_ivar
+.Nm device_get_ivars
 function returns the bus-specific instance variables of a device.
 .Pp
 The
-.Nm device_set_ivar
+.Nm device_set_ivars
 function sets the bus-specific instance variables of a device.
 .Pp
 Typically, only bus drivers will use these functions.

>Release-Note:
>Audit-Trail:
>Unformatted:
 SEND-PR: -*- send-pr -*-
 SEND-PR: Lines starting with `SEND-PR' will be removed automatically, as
 SEND-PR: will all comments (text enclosed in `<' and `>').
 SEND-PR:
 SEND-PR: Please consult the following URL if you are not sure how to
 SEND-PR: fill out a problem report:
 SEND-PR: http://www.freebsd.org/doc/en/articles/problem-reports/article.html
 SEND-PR:
 SEND-PR: Note that the Synopsis field is mandatory.
 SEND-PR:
 SEND-PR: Please note that (unless you state otherwise) if your report
 SEND-PR: includes a patch then it will be taken under the same license as
 SEND-PR: the one on the file(s) you want to change.
 SEND-PR:
 SEND-PR: BE ADVISED THAT FREEBSD PROBLEM REPORTS ARE PUBLIC INFORMATION AND
 SEND-PR: WILL BE PUBLISHED AS-IS ON THE PROJECT'S MAILING LISTS AND WEB SITES.
 SEND-PR: DO NOT SUBMIT ANY INFORMATION YOU DO NOT WANT MADE PUBLIC.
 SEND-PR:
 SEND-PR: For sensitive security issues, consider contacting the FreeBSD
 SEND-PR: security officer team (security-officer at freebsd.org) directly.
 SEND-PR:
 SEND-PR: Choose from the following categories:
 SEND-PR:
 SEND-PR: advocacy  alpha     bin       conf      docs      gnu
 SEND-PR: i386      ia64      java      kern      misc      ports
 SEND-PR: powerpc   sparc64   standards www
 SEND-PR:
 To: FreeBSD-gnats-submit at freebsd.org
 From: Akira Ikeuchi <a_ikeuchi at mic.mitsumi.co.jp>
 Reply-To: Akira Ikeuchi <a_ikeuchi at mic.mitsumi.co.jp>
 Cc:
 X-send-pr-version: 3.113
 X-GNATS-Notify: