From: Andrew Morton <akpm@linux-foundation.org>
To: Rusty Russell <rusty@rustcorp.com.au>
Cc: Linus Torvalds <torvalds@linux-foundation.org>,
lkml - Kernel Mailing List <linux-kernel@vger.kernel.org>,
virtualization <virtualization@lists.linux-foundation.org>,
Rob Landley <rob@landley.net>,
"Randy.Dunlap" <rdunlap@xenotime.net>
Subject: Re: [PATCH 1/7] lguest: documentation pt I: Preparation
Date: Mon, 23 Jul 2007 18:20:27 -0700 [thread overview]
Message-ID: <20070723182027.ebe04818.akpm@linux-foundation.org> (raw)
In-Reply-To: <1185238908.1803.63.camel@localhost.localdomain>
On Tue, 24 Jul 2007 11:01:48 +1000
Rusty Russell <rusty@rustcorp.com.au> wrote:
> > But I worry that you're proposing adding what appears to be new
> > Documentation-related machinery and infrastructure when there's already
> > increased activity in that area from other people and we might all be
> > headed in different directions and stuff.
>
> It does add an lguest-specific script: I aimed for the minimal
> documentation script required to weave the code and documentation
> (basically extracts and orders by comment prefix, because code order
> isn't the same as optimal documentation order).
>
> This is great for lguest, where the entire codebase is small and
> self-contained enough to be woven into a narrative, and the maintainer
> is prepared to put in the cycles to keep it uptodate.
>
> But writing this documentation took *weeks*, to document 5000 lines of
> code. Perhaps this effort, if merged, will inspire others, but I've
> seen little indication so far: we have enough trouble getting them
> documenting a single public function.
Yeah, I suspect there will be insufficient interest and energy for anyone
else to take this anywhere.
Could you please redo the changes after "link lguest example launcher
non-static", which made a fairly big mess?
next prev parent reply other threads:[~2007-07-24 1:21 UTC|newest]
Thread overview: 56+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-07-21 1:17 [PATCH 1/7] lguest: documentation pt I: Preparation Rusty Russell
2007-07-21 1:18 ` [PATCH 2/7] lguest: documentation pt II: Guest Rusty Russell
2007-07-21 1:19 ` [PATCH 3/7] lguest: documentation pt III: Drivers Rusty Russell
2007-07-21 1:20 ` [PATCH 4/7] lguest: documentation pt IV: Launcher Rusty Russell
2007-07-21 1:20 ` Rusty Russell
2007-07-21 1:21 ` [PATCH 5/7] lguest: documentation pt V: Host Rusty Russell
2007-07-21 1:21 ` [PATCH 6/7] lguest: documentation pt VI: Switcher Rusty Russell
2007-07-21 1:24 ` [PATCH 7/7] lguest: documentation pt VII: FIXMEs Rusty Russell
2007-07-21 1:24 ` Rusty Russell
2007-07-21 1:21 ` [PATCH 6/7] lguest: documentation pt VI: Switcher Rusty Russell
2007-07-21 1:21 ` [PATCH 5/7] lguest: documentation pt V: Host Rusty Russell
2007-07-21 1:19 ` [PATCH 3/7] lguest: documentation pt III: Drivers Rusty Russell
2007-07-21 1:18 ` [PATCH 2/7] lguest: documentation pt II: Guest Rusty Russell
2007-07-24 0:12 ` [PATCH 1/7] lguest: documentation pt I: Preparation Andrew Morton
2007-07-24 1:01 ` Rusty Russell
2007-07-24 1:01 ` Rusty Russell
2007-07-24 1:18 ` Linus Torvalds
2007-07-24 1:51 ` Rusty Russell
2007-07-24 1:51 ` Rusty Russell
2007-07-24 9:52 ` Alan Cox
2007-07-24 10:28 ` Rusty Russell
2007-07-24 12:04 ` Alan Cox
2007-07-24 12:04 ` Alan Cox
2007-07-24 22:35 ` Rusty Russell
2007-07-24 22:35 ` Rusty Russell
2007-07-24 10:28 ` Rusty Russell
2007-07-24 9:52 ` Alan Cox
2007-07-24 2:28 ` Rene Herman
2007-07-24 2:28 ` Rene Herman
2007-07-24 9:33 ` Alan Cox
2007-07-24 9:33 ` Alan Cox
2007-07-24 1:18 ` Linus Torvalds
2007-07-24 1:20 ` Andrew Morton [this message]
2007-07-24 1:39 ` Rusty Russell
2007-07-24 1:39 ` Rusty Russell
2007-07-24 1:20 ` Andrew Morton
2007-07-25 22:22 ` Rob Landley
2007-07-25 22:22 ` Rob Landley
2007-07-26 3:35 ` Rusty Russell
2007-07-27 18:32 ` Rob Landley
2007-07-27 18:32 ` Rob Landley
2007-07-26 3:35 ` Rusty Russell
2007-07-24 2:21 ` Randy Dunlap
2007-07-24 2:21 ` Randy Dunlap
2007-07-24 3:06 ` Randy Dunlap
2007-07-24 3:06 ` Randy Dunlap
2007-07-24 3:27 ` Rusty Russell
2007-07-24 3:27 ` Rusty Russell
2007-07-25 19:30 ` Rob Landley
2007-07-25 19:30 ` Rob Landley
2007-07-24 15:13 ` Jonathan Corbet
2007-07-24 15:13 ` Jonathan Corbet
2007-07-24 16:00 ` Alan Cox
2007-07-24 16:57 ` Randy Dunlap
2007-07-24 0:12 ` Andrew Morton
-- strict thread matches above, loose matches on Subject: below --
2007-07-21 1:17 Rusty Russell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20070723182027.ebe04818.akpm@linux-foundation.org \
--to=akpm@linux-foundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@xenotime.net \
--cc=rob@landley.net \
--cc=rusty@rustcorp.com.au \
--cc=torvalds@linux-foundation.org \
--cc=virtualization@lists.linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.