[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: kernel-doc and xen.git

  • To: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
  • From: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>
  • Date: Fri, 31 Jul 2020 13:50:12 +0000
  • Accept-language: en-GB, en-US
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=QaUnDIMDodH8Mw1jCxd8sOaB4OjY03ZR0m3EsXHBgI0=; b=ER9C5CK48Gk0CJaCKpA/mJDVyH4FqwlKDak+Jti6YCOE3tzEtbcbJ6lCBa1gu7p6Tn53OOUmZLoK7mnN3HatAwr/RvSVCr5jZ7Tg9JKszlQ7I7NOzzz1U/j8w9B49BaUhj8u5zXsIC0eAgDTDB1zqW+bpjIet1M5JKouYxR7bTAkeRSxEWaSHQ/2kqX7Es1NlniQCt5ySrHX0VrJ2h1/co6H70Ajrid2sYJaFSq2whaTUmGkCm4eVQthIAIVPKfdu/PHfJ5SpQ99neafYPKM0G4plcFMyFqfkmMUFkbfCOF+xN220DlLVnEAajhPg+KyAM2uM1Z6DTCs57w93PRCgQ==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=PF9bHSA3aJkNCvabwZSY8W6UFRSvtISUmJ5dps0Nq8wOiGlEVtoJRM2WqZZ4Q3hWljhcXZXpe7EzXEkPSPYqGayQzOBL7MgnwvUvLfVnICJe/Nks0T6/IiM4ZJEXat3LvsOGIkpdvkh+uPOuvWfRJ59G2ypYmydjxhBETSUZ5IaniUQYKxvS3GrJ9L/HUzGld3tXVt2K7Hy/QcYs/BD8F8ukbPtBF6kb7GjP6gxnteauHL1n8ueseEaA/7s1aFPewdkoScb18kNcsQnQaDoqOPtpxnyYLqkaC72lHX2ExbPUdvQIeVSVU7jWGKSWOgFALvOdnEeovoVwHUpxmH3fjQ==
  • Authentication-results-original: citrix.com; dkim=none (message not signed) header.d=none;citrix.com; dmarc=none action=none header.from=arm.com;
  • Cc: Xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>, nd <nd@xxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, "committers@xxxxxxxxxxxxxx" <committers@xxxxxxxxxxxxxx>
  • Delivery-date: Fri, 31 Jul 2020 13:50:27 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Nodisclaimer: true
  • Original-authentication-results: citrix.com; dkim=none (message not signed) header.d=none;citrix.com; dmarc=none action=none header.from=arm.com;
  • Thread-index: AQHWZhCqcVqKiEQuVU6MZpfTy49dJakhtkiAgAAAnAA=
  • Thread-topic: kernel-doc and xen.git

> On 31 Jul 2020, at 15:48, Andrew Cooper <andrew.cooper3@xxxxxxxxxx> wrote:
> On 30/07/2020 02:27, Stefano Stabellini wrote:
>> Hi all,
>> I would like to ask for your feedback on the adoption of the kernel-doc
>> format for in-code comments.
>> In the FuSa SIG we have started looking into FuSa documents for Xen. One
>> of the things we are investigating are ways to link these documents to
>> in-code comments in xen.git and vice versa.
>> In this context, Andrew Cooper suggested to have a look at "kernel-doc"
>> [1] during one of the virtual beer sessions at the last Xen Summit.
>> I did give a look at kernel-doc and it is very promising. kernel-doc is
>> a script that can generate nice rst text documents from in-code
>> comments. (The generated rst files can then be used as input for sphinx
>> to generate html docs.) The comment syntax [2] is simple and similar to
>> Doxygen:
>>    /**
>>     * function_name() - Brief description of function.
>>     * @arg1: Describe the first argument.
>>     * @arg2: Describe the second argument.
>>     *        One can provide multiple line descriptions
>>     *        for arguments.
>>     */
>> kernel-doc is actually better than Doxygen because it is a much simpler
>> tool, one we could customize to our needs and with predictable output.
>> Specifically, we could add the tagging, numbering, and referencing
>> required by FuSa requirement documents.
>> I would like your feedback on whether it would be good to start
>> converting xen.git in-code comments to the kernel-doc format so that
>> proper documents can be generated out of them. One day we could import
>> kernel-doc into xen.git/scripts and use it to generate a set of html
>> documents via sphinx.
>> At a minimum we'll need to start the in-code comment blocks with two
>> stars:
>>    /**
>> There could be also other small changes required to make sure the output
>> is appropriate.
>> Feedback is welcome!
> I think it goes without saying that I'm +1 to this in principle.
> We definitely have some /** comments already, but I have no idea if they
> are valid kernel-doc or not.  It seems that the kernel-doc has some
> ability to report warnings, so it would be interesting to see what that
> spits out.

From my first crash test, not much is “kernel-doc” friendly but the content
is there, it is only a matter of doing some formatting.

> I also think getting rid of our home-grown syntax for the public headers
> will be major improvement.  We actually have a reasonable amount of
> ancillary documentation
> As with everything else in the Sphinx docs, I'd request that we don't
> just blindly throw this in and call it done.  We need to curate
> additions properly to avoid the docs turning into a mess.  I'm happy to
> help out in my copious free time.

Thanks :-)




Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.