lkml.org 
[lkml]   [2007]   [Jul]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH 1/7] lguest: documentation pt I: Preparation
    On Tue, 24 Jul 2007 17:00:28 +0100 Alan Cox wrote:

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

    Yes, that's certainly a challenge with the current kernel-doc script.

    > 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

    which is what Rusty's extract script does.

    ---
    ~Randy
    *** Remember to use Documentation/SubmitChecklist when testing your code ***
    -
    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/

    \
     
     \ /
      Last update: 2007-07-24 18:55    [W:0.029 / U:0.984 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site