Bug 30343

Summary: minor changes to ata(4) manpage
Product: Documentation Reporter: Giorgos Keramidas <charon>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Giorgos Keramidas 2001-09-05 19:10:00 UTC 
	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.
Comment 1 dima 2001-09-05 20:20:20 UTC 
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?
Comment 2 Murray Stokely freebsd_committer freebsd_triage 2001-09-27 08:30:18 UTC 
State Changed
From-To: open->closed

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!