From: Julien Grall <julien.grall@arm.com>
To: Stefano Stabellini <sstabellini@kernel.org>
Cc: chenbaodong <chenbaodong@mxnavi.com>,
"xen-devel@lists.xenproject.org" <xen-devel@lists.xenproject.org>,
nd <nd@arm.com>
Subject: Re: [Xen-devel] [PATCH] xen/arm: io: add function swap_mmio_handler()
Date: Mon, 24 Jun 2019 22:18:10 +0100 [thread overview]
Message-ID: <c253cdaf-658d-01ce-9d32-273db4a84f17@arm.com> (raw)
In-Reply-To: <alpine.DEB.2.21.1906241313480.2468@sstabellini-ThinkPad-T480s>
Hi,
On 6/24/19 9:17 PM, Stefano Stabellini wrote:
> On Mon, 24 Jun 2019, Julien Grall wrote:
>> Hi Stefano,
>>
>> On 24/06/2019 19:27, Stefano Stabellini wrote:
>>> On Mon, 24 Jun 2019, Stefano Stabellini wrote:
>>>> On Thu, 13 Jun 2019, chenbaodong wrote:
>>> Let me add that if you prefer to document one of the other interfaces
>>> listed above in my email, you are welcome to pick another one. For
>>> example, we are also missing a doc about the DomU memory map, listing
>>> all memory regions with addresses and sizes, both MMIO and normal
>>> memory. For that, most of the information is:
>>>
>>> xen/include/public/arch-arm.h
>>>
>>> A well written in-code comment in arch-arm.h would be OK, or also a
>>> document under docs/misc/arm.
>>
>> Please no duplication, it is already quite hard to maintain one place.
>> Instead, we should document all the headers in a documented format that
>> can be extracted automatically.
>
> As we have no such thing today (as far as I am aware), please make a
> proposal with a bit more details, otherwise I don't think Baodong will
> be able to take the next step.
I don't have a concrete proposal so far. Except that documentation
outside of the headers is a no-go from my side. The goal of documenting
within the headers rather than outside is you also help the developer of
guest OS.
A few weeks ago Ian Jackson pointed to docs/xen-headers for a potential
syntax. Sadly, there are no documentation of the script so far. I
haven't had time to look it so far.
Cheers,
--
Julien Grall
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
next prev parent reply other threads:[~2019-06-24 21:18 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-12 5:42 [Xen-devel] [PATCH] xen/arm: io: add function swap_mmio_handler() Baodong Chen
2019-06-12 9:08 ` Julien Grall
2019-06-12 10:08 ` chenbaodong
2019-06-12 12:21 ` Julien Grall
2019-06-13 0:31 ` chenbaodong
2019-06-24 18:18 ` Stefano Stabellini
2019-06-24 18:27 ` Stefano Stabellini
2019-06-24 19:27 ` Julien Grall
2019-06-24 20:17 ` Stefano Stabellini
2019-06-24 21:18 ` Julien Grall [this message]
2019-06-24 23:59 ` Stefano Stabellini
2019-06-25 8:46 ` Julien Grall
2019-06-27 23:30 ` chenbaodong
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=c253cdaf-658d-01ce-9d32-273db4a84f17@arm.com \
--to=julien.grall@arm.com \
--cc=chenbaodong@mxnavi.com \
--cc=nd@arm.com \
--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).