On Fri, Apr 04, 2008 at 11:00:28AM -0400, Lee Schermerhorn wrote:
> PATCH 07/15 Mempolicy: Document {set|get}_policy() vm_ops APIs
>
> Against: 2.6.25-rc8-mm1
>
> Document mempolicy return value reference semantics assumed by
> the rest of the mempolicy code for the set_ and get_policy vm_ops
> in <linux/mm.h>--where the prototypes are defined--to inform any
> future mempolicy vm_op writers what the rest of the subsystem
> expects of them.
There is a kerneldoc way to write documentation for structures
and their members too. So if you go to the trouble of writing extensive
documentation I would recommend that format, because then it will
even end up in the automatically generated PDFs and manpages
But you might need to add an !F somewhere in Documentation/DocBook
Example from the docs:
/**
* struct my_struct - short description
* @a: first member
* @b: second member
*
* Longer description
*/
struct my_struct {
int a;
int b;
/* private: */
int c;
};
-Andi
--
To unsubscribe from this list: send the line "unsubscribe linux-numa" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
