From charon@labs.gr  Wed Sep  5 11:01:17 2001
Return-Path: <charon@labs.gr>
Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5])
	by hub.freebsd.org (Postfix) with ESMTP id 965FA37B405
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  5 Sep 2001 11:01:16 -0700 (PDT)
Received: from hades.hell.gr (patr530-b030.otenet.gr [195.167.121.158])
	by mailsrv.otenet.gr (8.11.5/8.11.5) with ESMTP id f85I1D717239
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 5 Sep 2001 21:01:13 +0300 (EEST)
Received: (from charon@localhost)
	by hades.hell.gr (8.11.6/8.11.6) id f85HYPJ02439;
	Wed, 5 Sep 2001 20:34:25 +0300 (EEST)
	(envelope-from charon)
Message-Id: <200109051734.f85HYPJ02439@hades.hell.gr>
Date: Wed, 5 Sep 2001 20:34:25 +0300 (EEST)
From: Giorgos Keramidas <charon@labs.gr>
Reply-To: Giorgos Keramidas <charon@labs.gr>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: minor changes to ata(4) manpage
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         30343
>Category:       docs
>Synopsis:       minor changes to ata(4) manpage
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Sep 05 11:10:00 PDT 2001
>Closed-Date:    Thu Sep 27 00:30:18 PDT 2001
>Last-Modified:  Thu Sep 27 00:32:21 PDT 2001
>Originator:     Giorgos Keramidas
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hades.hell.gr 5.0-CURRENT FreeBSD 5.0-CURRENT #5: Tue Sep 4 19:49:44 EEST 2001 root@hades.hell.gr:/usr/obj/usr/src/sys/CHARON i386

>Description:

	The manpage of ata(4) describes how to enable hw.ata.wc by
	setting it to 1, but does not describe how to turn it off.  Of
	course, setting to 0 disables it, and it *is* set to 0 by
	default, but state that explicitly in the manpage.

	Also reword a warning that follows this to make it clearer
	that it is with the sysctl 'enabled' that there is a danger
	for data corruption.

>How-To-Repeat:

	$ man 4 ata

	Look for the description of hw.ata.wc sysctl knob.

>Fix:

Index: ata.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/ata.4,v
retrieving revision 1.20
diff -u -r1.20 ata.4
--- ata.4       14 Jul 2001 19:40:46 -0000      1.20
+++ ata.4       5 Sep 2001 17:33:07 -0000
@@ -66,8 +66,8 @@
 .It Va hw.ata.atapi_dma
 set to 1 for DMA access 0 for PIO (default is PIO).
 .It Va hw.ata.wc
-set to 1 to enable Write Caching (default is disabled)
-(WARNING might cause data loss on power failures)
+set to 1 to enable or 0 to disable Write Caching (default is disabled)
+(WARNING: enabling this might cause data loss on power failures)
 .It Va hw.ata.tags
 set to 1 to enable Tagged Queuing support (default is disabled)
 (only IBM DPTA and DTLA drives support that)
>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: Giorgos Keramidas <charon@labs.gr>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/30343: minor changes to ata(4) manpage 
Date: Wed, 05 Sep 2001 12:20:20 -0700

 Giorgos Keramidas <charon@labs.gr> wrote:
 > >Description:
 > 
 > 	The manpage of ata(4) describes how to enable hw.ata.wc by
 > 	setting it to 1, but does not describe how to turn it off.  Of
 > 	course, setting to 0 disables it, and it *is* set to 0 by
 > 	default, but state that explicitly in the manpage.
 
 I don't see the reason behind this.  This change just makes the manual
 page inconsistent with itself (since it wouldn't describe how to
 disable hw.ata.tags) and probably most others as well.
 
 Am I missing something?
State-Changed-From-To: open->closed 
State-Changed-By: murray 
State-Changed-When: Thu Sep 27 00:30:18 PDT 2001 
State-Changed-Why:  
The 4 options were indeed inconsistent with each other to begin with, 
and this patch didn't address all of those issues.  I believe the 
intention of the man page was to list sysctl options as : 

Set to 1 for FOO functionality, 0 for BAR functionality (FOO default). 

So thats what I standardized everything on.  Thanks for the submission! 


http://www.FreeBSD.org/cgi/query-pr.cgi?pr=30343 
>Unformatted:
