Messages in this thread | | | Subject | Re: [PATCH 1/7] lguest: documentation pt I: Preparation | From | Rusty Russell <> | Date | Tue, 24 Jul 2007 13:27:39 +1000 |
| |
On Mon, 2007-07-23 at 20:06 -0700, Randy Dunlap wrote: > On Mon, 23 Jul 2007 19:21:13 -0700 Randy Dunlap wrote: > > It's great that Rusty took the time to produce all of this documentation. > > Few people do that today.
Thanks Randy, it was something of an experiment. We'll see if it has the desired effect (ie. encouraging new hackers).
> Neat as that is, I'm concerned that it will be difficult to maintain > (the order numbers at least -- or are they just difficult to set up > the first time?).
Setup was a pain, but maintenance hasn't been too bad. Most changes don't deeply alter the code structure. After major surgery I diff the documentation output to check I haven't broke anything major (eg. removed a title or a section terminator).
> 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.
Yeah, code documentation like this belongs in comments IMHO, and even there it can rot.
Thanks, Rusty.
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |