From phk@critter.freebsd.dk  Sat Nov  3 21:55:41 2007
Return-Path: <phk@critter.freebsd.dk>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id C3F9816A468
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  3 Nov 2007 21:55:41 +0000 (UTC)
	(envelope-from phk@critter.freebsd.dk)
Received: from phk.freebsd.dk (phk.freebsd.dk [130.225.244.222])
	by mx1.freebsd.org (Postfix) with ESMTP id 8208813C4BF
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  3 Nov 2007 21:55:40 +0000 (UTC)
	(envelope-from phk@critter.freebsd.dk)
Received: from critter.freebsd.dk (unknown [192.168.61.3])
	by phk.freebsd.dk (Postfix) with ESMTP id 133D017105
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  3 Nov 2007 21:30:25 +0000 (UTC)
Received: from critter.freebsd.dk (localhost [127.0.0.1])
	by critter.freebsd.dk (8.14.1/8.14.1) with ESMTP id lA3LUO4F009959
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 3 Nov 2007 21:30:24 GMT
	(envelope-from phk@critter.freebsd.dk)
Received: (from phk@localhost)
	by critter.freebsd.dk (8.14.1/8.14.1/Submit) id lA3LUOGH009958;
	Sat, 3 Nov 2007 21:30:24 GMT
	(envelope-from phk)
Message-Id: <200711032130.lA3LUOGH009958@critter.freebsd.dk>
Date: Sat, 3 Nov 2007 21:30:24 GMT
From: Poul-Henning Kamp <phk@critter.freebsd.dk>
Reply-To: Poul-Henning Kamp <phk@critter.freebsd.dk>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: formatting oddity in sysmouse(4)
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         117798
>Category:       docs
>Synopsis:       formatting oddity in sysmouse(4)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Nov 03 22:00:01 UTC 2007
>Closed-Date:    Tue Jun 14 22:37:32 UTC 2011
>Last-Modified:  Tue Jun 14 22:40:15 UTC 2011
>Originator:     Poul-Henning Kamp
>Release:        FreeBSD 7.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD critter.freebsd.dk 7.0-CURRENT FreeBSD 7.0-CURRENT #0: Sun Oct 14 08:43:54 UTC 2007 root@critter.freebsd.dk:/usr/obj/freebsd/src/sys/C5 i386


	
>Description:
	man 4 sysmouse has a formatting oddity:

                MOUSE_MOTION_EVENT and MOUSE_BUTTON_EVENT are newer interface
                and are designed to be used together.  They are intended to
                replace functions performed by MOUSE_ACTION alone.

     u          This union is one of

                data

                      struct mouse_data {
                          int x;


>How-To-Repeat:

>Fix:



>Release-Note:
>Audit-Trail:

From: Maxim Konovalov <maxim@macomnet.ru>
To: Poul-Henning Kamp <phk@critter.freebsd.dk>
Cc: bug-followup@freebsd.org
Subject: Re: docs/117798: formatting oddity in sysmouse(4)
Date: Sun, 4 Nov 2007 01:23:13 +0300 (MSK)

 > >Description:
 > 	man 4 sysmouse has a formatting oddity:
 >
 >                 MOUSE_MOTION_EVENT and MOUSE_BUTTON_EVENT are newer interface
 >                 and are designed to be used together.  They are intended to
 >                 replace functions performed by MOUSE_ACTION alone.
 >
 >      u          This union is one of
 >
 >                 data
 >
 >                       struct mouse_data {
 >                           int x;
 >
 >
 Why do you think so?  This section describes "union u" from struct
 mouse_info.
 
 -- 
 Maxim Konovalov

From: "Poul-Henning Kamp" <phk@phk.freebsd.dk>
To: Maxim Konovalov <maxim@macomnet.ru>
Cc: bug-followup@freebsd.org
Subject: Re: docs/117798: formatting oddity in sysmouse(4) 
Date: Sat, 03 Nov 2007 23:11:45 +0000

 In message <20071104012124.S24106@mp2.macomnet.net>, Maxim Konovalov writes:
 >> >Description:
 >> 	man 4 sysmouse has a formatting oddity:
 >>
 >>                 MOUSE_MOTION_EVENT and MOUSE_BUTTON_EVENT are newer interface
 >>                 and are designed to be used together.  They are intended to
 >>                 replace functions performed by MOUSE_ACTION alone.
 >>
 >>      u          This union is one of
 >>
 >>                 data
 >>
 >>                       struct mouse_data {
 >>                           int x;
 >>
 >>
 >Why do you think so?  This section describes "union u" from struct
 >mouse_info.
 
 While it may be technically correctly formatted, it certainly looks
 confusing to the casual user.
 
 The the union had been more sensibly named, it would not be a problem,
 but for a single letter name like 'u', I'd propos quoting it, to make
 it clear that it is the actual and entire name.
 
 -- 
 Poul-Henning Kamp       | UNIX since Zilog Zeus 3.20
 phk@FreeBSD.ORG         | TCP/IP since RFC 956
 FreeBSD committer       | BSD since 4.3-tahoe    
 Never attribute to malice what can adequately be explained by incompetence.

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/117798: commit references a PR
Date: Sun, 11 Jan 2009 21:59:56 +0000 (UTC)

 Author: trhodes
 Date: Sun Jan 11 21:59:42 2009
 New Revision: 187066
 URL: http://svn.freebsd.org/changeset/base/187066
 
 Log:
   Quote the "u" as it's the name of the union, this may prevent
   some confusion when reading the manual page.
   
   PR:		117798
   Discussed with:	keramida, brueffer
   Recommended by:	phk
 
 Modified:
   head/share/man/man4/sysmouse.4
 
 Modified: head/share/man/man4/sysmouse.4
 ==============================================================================
 --- head/share/man/man4/sysmouse.4	Sun Jan 11 21:45:23 2009	(r187065)
 +++ head/share/man/man4/sysmouse.4	Sun Jan 11 21:59:42 2009	(r187066)
 @@ -385,7 +385,7 @@ They are intended to replace functions p
  .Dv MOUSE_ACTION
  alone.
  .Pp
 -.It Dv u
 +.It Dv Sq u
  This union is one of
  .Pp
  .Bl -tag -width data -compact
 _______________________________________________
 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: trhodes 
State-Changed-When: Sun Jan 11 22:06:58 UTC 2009 
State-Changed-Why:  
Fix committed, thanks! 


Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Sun Jan 11 22:06:58 UTC 2009 
Responsible-Changed-Why:  
Over to me, MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=117798 
State-Changed-From-To: patched->closed 
State-Changed-By: gjb 
State-Changed-When: Tue Jun 14 22:37:20 UTC 2011 
State-Changed-Why:  
MFCd to stable/7. 


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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/117798: commit references a PR
Date: Tue, 14 Jun 2011 22:37:37 +0000 (UTC)

 Author: gjb (doc committer)
 Date: Tue Jun 14 22:37:09 2011
 New Revision: 223100
 URL: http://svn.freebsd.org/changeset/base/223100
 
 Log:
   MFC 187066 by trhodes:
   
   Quote the "u" as it's the name of the union, this may prevent
   some confusion when reading the manual page.
   
   PR:		117798
 
 Modified:
   stable/7/share/man/man4/sysmouse.4
 Directory Properties:
   stable/7/share/man/man4/   (props changed)
 
 Modified: stable/7/share/man/man4/sysmouse.4
 ==============================================================================
 --- stable/7/share/man/man4/sysmouse.4	Tue Jun 14 21:37:25 2011	(r223099)
 +++ stable/7/share/man/man4/sysmouse.4	Tue Jun 14 22:37:09 2011	(r223100)
 @@ -385,7 +385,7 @@ They are intended to replace functions p
  .Dv MOUSE_ACTION
  alone.
  .Pp
 -.It Dv u
 +.It Dv Sq u
  This union is one of
  .Pp
  .Bl -tag -width data -compact
 _______________________________________________
 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"
 
>Unformatted:
