Re: [PATCH] Better document some regset helper functions

From: Roland McGrath
Date: Mon Apr 27 2009 - 23:00:58 EST


I'm all for better comments and your text looks fine to me.

The reason I had not used kerneldoc comments for those helpers is that
these are the private helpers purely for the use of arch code implementing
user_regset accessor functions. By contrast, the calls in linux/regset.h
that have kerneldoc comments are those that generic code (including future
modules, etc.) uses. When generating DocBook or man pages, the regset.h
functions are grouped together and those that have kerneldoc today make
sense to have there, but IMHO these inline helpers for arch code do not.


Thanks,
Roland
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/