Re: [PATCH 1/7] lguest: documentation pt I: Preparation

From: Alan Cox
Date: Tue Jul 24 2007 - 11:53:53 EST


> P.S. I am currently considering a no-limericks policy for the LWN quote
> of the week.

The LWN quote of the week
Is I think rather weak
No poems allowed
To rise from the crowd
Its future looks terribly bleak

More seriously the documentation looks good, and it definitely wants a
date/release clearly mentioning so people know when it is obsolete

> Advantage: it does keep the source code + doc text together.
> Martin (former kernel-doc maintainer) was going to come up with
> some way to do this, but he abandoned it.

It's not clear to me how you then format the extracted material. It
doesn't really fit the kernel-doc idea of formats. It would probably be
far easier to teach a seperate tool to rip clearly marked blocks into
ASCII documentation files for that purpose

Alan
-
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/