On (06/19/07 00:36), Peter Memishian wrote:
>
> > I have a question when reviewing our design doc today. How do we
> > document the driver's private properties correctly after Brussel?
>
> Minimally, in the driver's manpage.
>
Well, documenting private properties is something that needs to be
done with extreme discretion, becuase private properties are an extremely
Unstable interface. However, there may be some private properties
that are worth documenting, and we also need a central place to
document public properties. I was looking into this yesterday, and,
so far, it seems like the existing documents that carry this type
of information are
(i) man page (e.g, section 7D man page for the driver, ieee802.3(5)
(ii) the "Solaris Tunable Parameters" available at docs.sun.com - this
does not have a section for drivers, but looks like a good place
to track Public properties
(iii) Platform notes exist for some drivers (I found some for qfe, dmfe, eri).
Maybe we should have one for each driver? This would be a good
place for documenting driver-private tunables.
Not sure if there are other places for documenting ndd/kstat tunables
for drivers. There does not seem to be a standard location across all
drivers that I could find.
--Sowmini
