Bug 106425

Summary: [PATCH] add a HARDWARE-section to ata(4)
Product: Documentation Reporter: Niclas Zeising <niclas.zeising>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Niclas Zeising 2006-12-06 21:50:03 UTC
The ata(4) manual page lacks a HARDWARE section which make the auto-generation of harware notes fail, or rather, no chip sets supported bu ata(4) shows up in the hardware notes.

There was a pr complaining about this last week, unfortunately I can't find it at the moment, so I'll file a new pr.

Fix: The attached patch tries to add a proper hardware section based on the chip sets already listed in ata(4). The list is rather long, and can maybe be tweaked so it becomes shorter. If you find a way to do so, feel free.

Patch attached with submission follows:
How-To-Repeat: man 4 ata
Comment 1 Maxim Konovalov 2006-12-07 07:02:10 UTC
Hello Niclas,

I failed to find any ata(4) related changes in your patch.  Are you
sure you submitted a correct one?

-- 
Maxim Konovalov
Comment 2 Niclas Zeising 2006-12-07 09:47:29 UTC
On 12/7/06, Maxim Konovalov <maxim@macomnet.ru> wrote:
> Hello Niclas,
>
> I failed to find any ata(4) related changes in your patch.  Are you
> sure you submitted a correct one?
>
> --
> Maxim Konovalov
>

Uhm... This patch was not the correct one, sorry. I know you should
always triple-check, but somehow i failed to to that. I blame me being
tired.
I'll find the correct patch and send it. Sorry for the confusion.
Regards!
//Niclas
Comment 3 Simon L. B. Nielsen freebsd_committer freebsd_triage 2006-12-09 13:31:10 UTC
On 2006.12.07 18:04:23 +0100, Niclas Zeising wrote:

> And, as promised, the correct patch. I apologize for the confusion, I 
> attached the wrong file yesterday night.
> //Niclas

> --- src/share/man/man4/ata.4.orig	2006-12-06 19:56:35.000000000 +0100
> +++ src/share/man/man4/ata.4	2006-12-06 22:03:04.000000000 +0100
> @@ -98,55 +98,314 @@

[cut]

Just for historic info... I didn't commit my change to add a HARDWARE
section for ata(4), though I did do the conversion, since it just
didn't see that useful to list chipsets in the Hardware notes.  I'm
not against adding a hardware section, that just why there isn't one
today.

Anyway, if this is to be committed it should be OK'ed by sos@ IMO.

-- 
Simon L. Nielsen
Comment 4 Niclas Zeising 2006-12-09 14:00:56 UTC
Simon L. Nielsen wrote:
> On 2006.12.07 18:04:23 +0100, Niclas Zeising wrote:
> 
>> And, as promised, the correct patch. I apologize for the confusion, I 
>> attached the wrong file yesterday night.
>> //Niclas
> 
>> --- src/share/man/man4/ata.4.orig	2006-12-06 19:56:35.000000000 +0100
>> +++ src/share/man/man4/ata.4	2006-12-06 22:03:04.000000000 +0100
>> @@ -98,55 +98,314 @@
> 
> [cut]
> 
> Just for historic info... I didn't commit my change to add a HARDWARE
> section for ata(4), though I did do the conversion, since it just
> didn't see that useful to list chipsets in the Hardware notes.  I'm
> not against adding a hardware section, that just why there isn't one
> today.

Okay, I didn't look through the archives to see if anyone already done 
the work once. I just noticed the section missing when someone filed a 
PR about no devices supported by ata(4) was present in the hardware 
notes. I am also not sure if I really like the long list that I've made 
in the hardware section, I just didn't know a better way to do it and 
get them generated properly in the hardware notes. Maybe we should just 
add the list manually in the hardware notes. I think we should have the 
supported chipsets listed somewhere though, so you know what piece of 
hardware you should buy.

> 
> Anyway, if this is to be committed it should be OK'ed by sos@ IMO.
> 

That sounds reasonable.
Regards!
//Niclas
Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2008-01-26 10:17:58 UTC
State Changed
From-To: open->closed

Patch was submitted privately, but the discussion appears to show the issue 
was resolved as submitter was going to discuss patch with sos.  Thanks for 
the submission! 


Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2008-01-26 10:17:58 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

Over to me, as closer, in case of follow up.