Re: [PATCH] include/linux/mutex.h: unclear reference to convention

Randy Dunlap
2007-09-25T15:35:45Z

On Tue, 25 Sep 2007 01:11:05 -0700 (PDT) Matti Linnanvuori wrote:

> If you want to maintain the convention of documenting the interface only in .c files,
> you should write the convention in so many places in .h files that no one could overlook it.
> But I think the convention is bad and it would be better to document the interface also in
> .h files where it is defined. The convention is bad because it requires people to jump to
> other files to understand .h files.

Then we would have comments in multiple places and they would
undoubtedly get out of sync. When that happens, which one do
you use? Bad.

I'll find some place to document this convention anyway. Maybe
it will help.

---
~Randy
Phaedrus says that Quality is about caring.