Messages in this thread | | | Date | Thu, 29 May 2008 22:57:08 -0500 | From | Paul Jackson <> | Subject | Re: [RFC] [PATCH 1/2] cpusets: restructure the function update_cpumask() and update_nodemask() |
| |
Randy wrote: > For static functions, it's up to the maintainer/developer whether to do that > or not. But if the functions already have kernel-doc, there's no strong > reason to remove it. And these look good currently, so I see no > good reason to change them.
Ok - thank-you for the explanation.
I had this vague recollection that kernel-doc was just for non-static functions, so when I saw Miao put kernel-doc comments on a static routine, I looked around to see if that was normal.
I didn't see mention of static functions in kernel-doc-nano-HOWTO.txt, and in a brief survey, didn't happen to see any static functions with kernel-doc comments. However my survey was so brief I even missed five such functions in the file I maintain, kernel/cpuset.c. So from that I came to the (apparently flawed) conclusion that it didn't make sense to kernel-doc static functions, and so advised Miao.
I don't quite see what purpose kernel-doc would have for static functions, and am still concerned that such would (mildly) clutter the presentation of the externally visible cpuset functions in which those who just use cpusets would be interested.
It remains, of course, important to have good documentation of functions, static or not, but I would expect developers working inside the kernel/cpuset.c file to look for documentation of functions static to that file within the code and comments of that file, not in kernel-doc.
However I am just the cpuset maintainer, not a kernel-doc expert.
I remain inclined toward removing the kernel-doc markings on static functions in kernel/cpuset.c, but if you wish, Randy, to make a renewed appeal for me not to do so, I will happily honor that appeal.
Life is good either way when we are discussing how to annotate documentation, rather than lamenting its absence.
If you, Randy, felt inclined to explain the value of kernel-doc comments on file static functions in kernel-doc-nano-HOWTO.txt, that might be valuable for the next person who travels this path.
Thank-you.
-- I won't rest till it's the best ... Programmer, Linux Scalability Paul Jackson <pj@sgi.com> 1.940.382.4214
| |