NetBSD Problem Report #35213

From root@squirrel.raphael.g-system.at  Fri Dec  8 15:43:21 2006
Return-Path: <root@squirrel.raphael.g-system.at>
Received: from mail.netbsd.org (mail.netbsd.org [204.152.190.11])
	by narn.NetBSD.org (Postfix) with ESMTP id 3EF9063BA6D
	for <gnats-bugs@gnats.NetBSD.org>; Fri,  8 Dec 2006 15:43:21 +0000 (UTC)
Message-Id: <20061208154308.393B820A25@squirrel.raphael.g-system.at>
Date: Fri,  8 Dec 2006 16:43:07 +0100 (CET)
From: raphael@raphael.g-system.at
Reply-To: raphael@raphael.g-system.at
To: gnats-bugs@NetBSD.org
Subject: [PATCH] typo fixes in man pages: usb(4), wsdisplay(9), wsfont(9)
X-Send-Pr-Version: 3.95

>Number:         35213
>Category:       misc
>Synopsis:       fix typos found in manual pages, including paragraph rephrasing
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Dec 08 15:45:00 +0000 2006
>Closed-Date:    Mon May 18 00:09:34 +0000 2009
>Last-Modified:  Mon May 18 00:10:02 +0000 2009
>Originator:     Raphael Langerhorst
>Release:        NetBSD 4.99.3
>Organization:
Activenet
>Environment:
System: NetBSD squirrel.raphael.g-system.at 4.99.3 NetBSD 4.99.3 (ARMADILLO9) #34: Thu Dec 7 08:14:25 CET 2006 root@eagle.raphael.g-system.at:/usr/src/sys/arch/evbarm/compile/ARMADILLO9 evbarm
Architecture: arm
Machine: evbarm
>Description:
	I've been looking at wscons manual pages recently and corrected
the typos I found along the way...

>How-To-Repeat:
	Nothing to repeat.
>Fix:
	Apply patch below. PLESE review first.

I want to provide useful PRs to allow efficient processing.
If there is anything wrong (or improvable) with this one (wrong category, ...)
please let me know so I can provide better PRs in the future.

Thanks,
Raphael

Index: man4/usb.4
===================================================================
RCS file: /cvsroot/src/share/man/man4/usb.4,v
retrieving revision 1.81
diff -u -r1.81 usb.4
--- usb.4	3 Apr 2006 08:15:49 -0000	1.81
+++ usb.4	8 Dec 2006 12:40:47 -0000
@@ -263,7 +263,7 @@
 bus proceeds in several steps:
 .Bl -enum
 .It
-Any device specific driver can to attach to the device.
+Any device specific driver can attach to the device.
 .It
 If none is found, any device class specific driver can attach.
 .It
@@ -390,7 +390,7 @@
 .Va requests
 field is indexed by the transfer kind, i.e.
 .Va UE_* ,
-and indicates how many transfers of each kind that has been completed
+and indicates how many transfers of each kind have been completed
 by the controller.
 .It Dv USB_REQUEST Fa "struct usb_ctl_request"
 This command can be used to execute arbitrary requests on the control pipe.
Index: man9/wsdisplay.9
===================================================================
RCS file: /cvsroot/src/share/man/man9/wsdisplay.9,v
retrieving revision 1.19
diff -u -r1.19 wsdisplay.9
--- wsdisplay.9	15 Apr 2006 17:54:34 -0000	1.19
+++ wsdisplay.9	8 Dec 2006 12:42:19 -0000
@@ -143,7 +143,7 @@
 .Fa show_screen
 member defines a function for mapping a screen onto the physical
 display.
-This function is used for between switching screens.
+This function is used for switching between screens.
 The
 .Fa load_font
 member defines a function for loading a new font into the display.
@@ -170,21 +170,18 @@
 A structure used to attach the
 .Xr wsdisplay 4
 child device for the simple bit-mapped interface.
-If the full terminal-emulation interface is to be used, then
-.Em struct wsemuldisplaydev_attach_args
-should be used instead.
 It has the following members:
 .Bd -literal
 	const struct wsdisplay_accessops *accessops;
 	void *accesscookie;
 .Ed
+If the full terminal-emulation interface is to be used, then
+.Em struct wsemuldisplaydev_attach_args
+should be used instead.
 .It Fa struct wsemuldisplaydev_attach_args
 A structure used to attach the
 .Xr wsdisplay 4
 child device for the full terminal emulation interface.
-If the simple bit-mapped interface is to be used, then
-.Em struct wsdisplaydev_attach_args
-should be used instead.
 It has the following members:
 .Bd -literal
 	int console;
@@ -192,6 +189,9 @@
 	const struct wsdisplay_accessops *accessops;
 	void *accesscookie;
 .Ed
+If the simple bit-mapped interface is to be used, then
+.Em struct wsdisplaydev_attach_args
+should be used instead.
 .It Fa struct wsdisplay_emulops
 A structure used to specify the display emulation functions.
 All displays intending to provide terminal emulation must provide
Index: man9/wsfont.9
===================================================================
RCS file: /cvsroot/src/share/man/man9/wsfont.9,v
retrieving revision 1.12
diff -u -r1.12 wsfont.9
--- wsfont.9	5 Jun 2005 15:36:47 -0000	1.12
+++ wsfont.9	8 Dec 2006 12:42:20 -0000
@@ -151,10 +151,10 @@
 .Fa stride .
 If
 .Fn wsfont_find
-is called with any of the parameters as 0, it indicates that we don't
+is called with all parameters set to 0, it indicates that we don't
 care about that aspect of the font.
 If the font is found a (nonnegative-valued) cookie is returned which
-can used with the other functions.
+can be used with the other functions.
 .Pp
 The
 .Fa bitorder
@@ -209,7 +209,7 @@
 .Fn wsfont_unlock
 will free resources used by temporary copies.
 .Pp
-The address of the wsdisplay_font pointer for the specified font is return in
+The address of the wsdisplay_font pointer for the specified font is returned in
 the
 .Fa ptr
 argument.
@@ -225,7 +225,7 @@
 .Fa c
 to glyph for font
 .Fa font .
-Returns the glyph or success or -1 on error.
+Returns the glyph on success or -1 on error.
 .El
 .Sh CODE REFERENCES
 This section describes places within the

>Release-Note:

>Audit-Trail:
From: Pavel Cahyna <pavel@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/35213: [PATCH] typo fixes in man pages: usb(4), wsdisplay(9), wsfont(9)
Date: Sun, 10 Dec 2006 00:44:19 +0100

 On Fri, Dec 08, 2006 at 03:45:00PM +0000, raphael@raphael.g-system.at wrote:

 > Index: man9/wsfont.9
 > ===================================================================
 > RCS file: /cvsroot/src/share/man/man9/wsfont.9,v
 > retrieving revision 1.12
 > diff -u -r1.12 wsfont.9
 > --- wsfont.9	5 Jun 2005 15:36:47 -0000	1.12
 > +++ wsfont.9	8 Dec 2006 12:42:20 -0000
 > @@ -151,10 +151,10 @@
 >  .Fa stride .
 >  If
 >  .Fn wsfont_find
 > -is called with any of the parameters as 0, it indicates that we don't
 > +is called with all parameters set to 0, it indicates that we don't
 >  care about that aspect of the font.

 To me it seems that the original text is correct and your change is wrong.
 Otherwise the patch looks OK.

State-Changed-From-To: open->closed
State-Changed-By: snj@NetBSD.org
State-Changed-When: Mon, 18 May 2009 00:09:34 +0000
State-Changed-Why:
Patch applied (minus the part Pavel pointed out as incorrect).  Thanks
and sorry it took so long.


From: Soren Jacobsen <snj@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/35213 CVS commit: src/share/man
Date: Mon, 18 May 2009 00:07:47 +0000

 Module Name:	src
 Committed By:	snj
 Date:		Mon May 18 00:07:47 UTC 2009

 Modified Files:
 	src/share/man/man4: usb.4
 	src/share/man/man9: wsdisplay.9 wsfont.9

 Log Message:
 Fix some typos and bad wording.  From Raphael Langerhorst in
 PR misc/35213, plus two small nits from me.


 To generate a diff of this commit:
 cvs rdiff -u -r1.90 -r1.91 src/share/man/man4/usb.4
 cvs rdiff -u -r1.21 -r1.22 src/share/man/man9/wsdisplay.9
 cvs rdiff -u -r1.13 -r1.14 src/share/man/man9/wsfont.9

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

>Unformatted:

Home	PR Database Search