From owner-freebsd-doc@FreeBSD.ORG Sun Nov 4 02:40:02 2007 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 73BD716A420 for ; Sun, 4 Nov 2007 02:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 6472813C4B5 for ; Sun, 4 Nov 2007 02:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.14.1/8.14.1) with ESMTP id lA42e2iS023353 for ; Sun, 4 Nov 2007 02:40:02 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.1/8.14.1/Submit) id lA42e2Nu023349; Sun, 4 Nov 2007 02:40:02 GMT (envelope-from gnats) Date: Sun, 4 Nov 2007 02:40:02 GMT Message-Id: <200711040240.lA42e2Nu023349@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: "Poul-Henning Kamp" Cc: Subject: Re: docs/117798: formatting oddity in sysmouse(4) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Poul-Henning Kamp List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 04 Nov 2007 02:40:02 -0000 The following reply was made to PR docs/117798; it has been noted by GNATS. From: "Poul-Henning Kamp" To: Maxim Konovalov 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.