Re: [PATCH][1/6] perfctr-2.7.3 for 2.6.7-rc1-mm1: core

From: Andrew Morton
Date: Tue Jun 22 2004 - 14:39:52 EST


Mikael Pettersson <mikpe@xxxxxxxxx> wrote:
>
> > We need (especially at this stage in the kernel cycle) at least a couple of
> > pages of design documentation which describes
>
> Speaking of documentation, I have a strong preference for using
> LaTeX for all papers, reports, docs, etc, except man pages.
> Is that an acceptable format?

Sounds fine, but excessive for this exercise. At this stage I'm asking for
sufficient description of the kernel patch to allow other developers to
understand and review the patch, maybe hack on it a bit. A couple of pages
of ascii should suffice. I'd consider it compulsory for patches of this
magnitude and scope.

Longer term, yes - having added a bunch of new syscalls to the kernel we
have a responsibility to document the user/kernel API for downstream users,
but that's not a requirement for reviewing the patch.
-
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/