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

Randy Dunlap
2007-09-24T18:14:50Z

On Mon, 24 Sep 2007 19:00:41 +0100 Christoph Hellwig wrote:

> On Mon, Sep 24, 2007 at 10:56:32AM -0700, Randy Dunlap wrote:
> > I don't have a problem with a samples/ directory except (as I have
> > already pointed out) it means that people will end up having to look
> > in 2 places for the information that they need, i.e., both in
> > samples/ and in Documentation/. So I really don't see a big need
> > to split the samples and docs.
> >
> > What's wrong with building sample code in the Documentation/ directory?
>
> It's not really documentation, it's code :) If you want to build
> documentation from the samples use kerneldoc or similar to extrace the
> comments. Having Documentation/ purely for things not affecting the build
> make things a whole lot clearer, but if you absolutely insist on it
> we can put it under Documentation/ as long as it's fully integrated into
> kbuild and will be built as part of allmodconfig, unlike the current
> two patches showing code there.
> -

Yes, it has to be integrated into the build system, no doubt.

We really need to give Mathieu and David Wilder an answer so that they
can make progress (and I'm willing to help with this).

To do this, here's my test question:
How much of David's "trace code and documentation" patch can be put
into a samples/ directory?

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?

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