From: George Dunlap <George.Dunlap@citrix.com>
To: Stefano Stabellini <sstabellini@kernel.org>
Cc: "xen-devel@lists.xenproject.org" <xen-devel@lists.xenproject.org>,
Committers <committers@xenproject.org>,
"Bertrand.Marquis@arm.com" <Bertrand.Marquis@arm.com>
Subject: Re: kernel-doc and xen.git
Date: Thu, 30 Jul 2020 11:13:09 +0000 [thread overview]
Message-ID: <785FBD2D-A67C-4740-9C5B-2ECCD0AEBFFC@citrix.com> (raw)
In-Reply-To: <alpine.DEB.2.21.2007291644330.1767@sstabellini-ThinkPad-T480s>
> On Jul 30, 2020, at 2:27 AM, Stefano Stabellini <sstabellini@kernel.org> 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.
`git-grep ‘^/\*\*$’ ` turns up loads of instances of kernel-doc-style comments in the tree already. I think it makes complete sense to:
1. Start using tools to pull the existing ones into sphinx docs
2. Skim through the existing ones to make sure they’re accurate / useful
3. Add such comments for elements of key importance to the FUSA SIG
4. Encourage people include documentation for new features, &c
-George
next prev parent reply other threads:[~2020-07-30 11:13 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-30 1:27 kernel-doc and xen.git Stefano Stabellini
2020-07-30 11:13 ` George Dunlap [this message]
2020-07-30 13:07 ` Ian Jackson
2020-07-31 1:16 ` Stefano Stabellini
2020-07-31 11:29 ` Jan Beulich
2020-07-31 12:48 ` Bertrand Marquis
2020-07-31 12:51 ` George Dunlap
2020-07-31 16:18 ` Stefano Stabellini
2020-07-31 13:48 ` Andrew Cooper
2020-07-31 13:50 ` Bertrand Marquis
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=785FBD2D-A67C-4740-9C5B-2ECCD0AEBFFC@citrix.com \
--to=george.dunlap@citrix.com \
--cc=Bertrand.Marquis@arm.com \
--cc=committers@xenproject.org \
--cc=sstabellini@kernel.org \
--cc=xen-devel@lists.xenproject.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).