Messages in this thread | | | From | David Brownell <> | Subject | Re: [PATCH 1/3] genclk: add generic framework for managing clocks. | Date | Sun, 13 Jul 2008 14:12:32 -0700 |
| |
On Saturday 12 July 2008, Andrew Morton wrote: > > +EXPORT_SYMBOL(clk_get_parent); > > As this is a new kernel-wide utility library, it is appropriate that > all of its public interfaces (at least) be documented. An appropriate > way of doing that is via kerneldoc annotation. Please don't forget to > document return values and call environment prerequisites (eg: requires > foo_lock, may be called from interrupt context, etc, etc).
That is, the stuff that's not already documented in <linux/clk.h>; that's where clk_get_parent() is documented, for example.
I'd suggest a separate (for review!) doc patch to add this to the stuff that's at the end of Documentation/DocBook/kernel-api.tmpl in 2.6.26 ... possibly the existing clk.h interface stuff should become a <sect1> and the new implementation glue should become a sibling <sect1>, that will cleanly separate the two.
- Dave -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |