On Fri, 2014-01-17 at 01:28 +0100, Hannes Frederic Sowa wrote: [...] > --- a/include/linux/kernel.h > +++ b/include/linux/kernel.h > @@ -193,6 +193,25 @@ extern int _cond_resched(void); > (__x < 0) ? -__x : __x; \ > }) > > +/** > + * trim - perform a reciprocal multiplication in order to "clamp" a > + * value into range [0, ep_ro), where the upper interval > + * endpoint is right-open. This is useful, e.g. for accessing > + * a index of an array containing ep_ro elements, for example. > + * Think of it as sort of modulus, only that the result isn't > + * that of modulo. ;) > + * More: http://homepage.cs.uiowa.edu/~jones/bcd/divide.html [...]
And you think trim() is an obvious name for that?! How about: scale_u32_to_range(). Also the first physical line of a kernel-doc comment (after the name) is a summary which is used, for example, in the summary line on a manual page. It seems like you have the summary and full description the wrong way round here. Ben. -- Ben Hutchings, Staff Engineer, Solarflare Not speaking for my employer; that's the marketing department's job. They asked us to note that Solarflare product names are trademarked. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
