cvs commit: src/share/man/man4 ath.4

[Giorgos Keramidas]

On 2006-05-12 09:20, "Bruce A. Mah" <bmah at freebsd.org> wrote:
>If memory serves me right, Giorgos Keramidas wrote:
>> keramida    2006-05-12 12:55:56 UTC
>>
>>   FreeBSD src repository (doc committer)
>>
>>   Modified files:
>>     share/man/man4       ath.4
>>   Log:
>>   After a mini-discussion with Sam Leffler, remove the hardcoded
>>   list of Atheros-based cards from ath(4).  The online list is
>>   always more up to date, anyway.
>>
>>   This invalidates:
>>
>>   PR:             docs/95360  http://www.FreeBSD.org/cgi/query-pr.cgi?pr=95360
>>   Submitted by:   Erik Nordstr:om Andersen <erik at erik-n-andersen.dk>
>
> Without expressing any opinion about the removal of this
> information: This commit makes the hardware notes look rather
> odd.  (Remember that the hardware notes are partially generated
> from manpages.)  Here's the entry for ath(4), as well as the
> the entry that immediately precedes it:
>
>    Cards supported by the cnw(4) driver include:
>
>      * Xircom CreditCard Netwave
>
>      * NetWave AirSurfer
>
>    A list of cards that are supported can be found at
>    http://customerproducts.atheros.com/customerproducts. The ath(4)
>    driver supports all Atheros Cardbus or PCI cards, except those
>    that are based on the AR5005VL chipset.
>
> It's not clear to me whether it'd be better to reword the above
> sentences in the manpage to make them more suitable for "dual
> use", or if it'd be better to hard-code some appropriate text
> into the hardware notes.  (In any case, please keep the Web
> pointer in the hardware notes if possible.)

Hmmm, I forgot about the special meaning of the "HARDWARE"
section.  What is a good way to write something that _can_
have a dual use?