Messages in this thread | | | Date | Wed, 3 Sep 2008 14:44:08 -0400 | From | Christoph Hellwig <> | Subject | Re: [PATCH 1/2] utrace core |
| |
On Wed, Sep 03, 2008 at 05:11:03AM -0700, Roland McGrath wrote: > > 5. Dummy in examiner -- not used (of course!) > > (Of course, that's why it's called that!) I found I had to add that or > the kerneldoc magic would freak out. The type name is used by users of > the API, so I wanted to have it documented with description text, but > its contents are all private to the utrace implementation. When I had > no magic /* public: */ comment or no fields declared after it, the 'make > htmldocs' et al process would barf.
Sounds like kerneldoc wants a fix for this. And btw, I don't think half-private structures are a good idea. Either make it completely private by just providing a forward declaration in the header, or put all members in the public definition with a comment describing they are not for users. We don't have the arguments of ABI problems or hiding visibility for maintaince reasons e.g. library APIs have.
| |