From owner-freebsd-doc Tue May 21 12:30:14 2002 Delivered-To: freebsd-doc@hub.freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21]) by hub.freebsd.org (Postfix) with ESMTP id 1BCA937B40C for ; Tue, 21 May 2002 12:30:05 -0700 (PDT) Received: (from gnats@localhost) by freefall.freebsd.org (8.11.6/8.11.6) id g4LJU5D39033; Tue, 21 May 2002 12:30:05 -0700 (PDT) (envelope-from gnats) Date: Tue, 21 May 2002 12:30:05 -0700 (PDT) Message-Id: <200205211930.g4LJU5D39033@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org Cc: From: Giorgos Keramidas Subject: Re: docs/38289: Update to ata(4) manpage (broken ata tags for now) Reply-To: Giorgos Keramidas Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org The following reply was made to PR docs/38289; it has been noted by GNATS. From: Giorgos Keramidas To: Dmitry Morozovsky Cc: bug-followup@FreeBSD.ORG Subject: Re: docs/38289: Update to ata(4) manpage (broken ata tags for now) Date: Tue, 21 May 2002 18:31:06 +0300 On 2002-05-19 17:44, Dmitry Morozovsky wrote: > --- ata.4.orig Sun May 19 17:32:19 2002 > +++ ata.4 Sun May 19 17:38:53 2002 > @@ -76,7 +76,9 @@ > (WARNING might cause data loss on power failures) > .It Va hw.ata.tags > set to 1 to enable Tagged Queuing support, 0 to disable (default is disabled) > (only IBM DPTA and DTLA drives support that) > +.Pp > +XXX THIS FEATURE IS CURRENTLY BROKEN -- Do not try to enable it! XXX > .El > .Sh DESCRIPTION > This driver provides access to disk drives, ATAPI CD-ROM and DVD drives, I don't think "XXX" is a nice thing to have in running text. I tend to view the manpages as text that can be part of a typeset document, printed in PostScript form by a local printer. Moreover, the manpages should not document brokenness that can be fixed, for fear that they will continue to document brokenness long after the bug has been fixed, if the author of the code doesn't know that the manpage states the code is broken. A comment in LINT should be enough to let the users know that this particular feature might be the source of problems, when they're editing their kernel configuration and enabling the option. Of course, this is my humble opinion ;-) -- Giorgos Keramidas - http://www.FreeBSD.org keramida@FreeBSD.org - The Power to Serve To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message