Messages in this thread | | | Date | Fri, 30 May 2008 00:24:52 -0500 | From | Paul Jackson <> | Subject | Re: [RFC] [PATCH 1/2] cpusets: restructure the function update_cpumask() and update_nodemask() |
| |
Randy wrote: > The nuance here is the difference in exported/non-exported vs. non-static/static.
Ok ... hmmm ... how to say this...
The documentation in Documentation/kernel-doc-nano-HOWTO.txt of kernel-doc is mostly focused on the details of the apparatus that converts the "/**" comments into various documenation formats, and has only somewhat buried and non-inviting documentation for kernel hackers wanting the "Kernel-Doc for Dummies" summary of how and when and where to create such "/**" comments.
For example, the distinction you note between: !E<filename> external (EXPORT_SYMBOL), and !I<filename> internal (not exported) is buried in the "How to make new SGML template files" section, which I would hope that I never had to read.
However ... in accordance with the usual rule that he who complains gets to fix it, I find this kernel-doc documentation to be PERFECT! ;).
-- I won't rest till it's the best ... Programmer, Linux Scalability Paul Jackson <pj@sgi.com> 1.940.382.4214
| |