Re: [patch 6/7] Linux Kernel Markers - Documentation

Randy Dunlap
2007-09-24T18:24:54Z

Christoph Hellwig wrote:
> On Mon, Sep 24, 2007 at 11:13:18AM -0700, Randy Dunlap wrote:
>> Documentation/trace/src/Makefile | 7 +
>> Documentation/trace/src/README | 18 +
>> Documentation/trace/src/fork_trace.c | 119 +++++++
>> Documentation/trace/trace.txt | 164 ++++++++++
>> include/linux/trace.h | 99 ++++++
>> lib/Kconfig | 9 +
>> lib/Makefile | 2 +
>> lib/trace.c | 563 +++++++++++++++++++++++++++
>> +++++++
>> 8 files changed, 981 insertions(+), 0 deletions(-)
>>
>>
>> All of the trace/src/ subdirectory?
>
> Yes, but only as a single file. We don't really want READMES in source
> directories. Instead these 18 lines would do a perfect comment on the
> top of the file.

That might be OK for this case, but sometimes it makes sense to have
README etc. about how to use the software. So you would want this
in the Documentation/ tree? That makes it harder on users.

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