Re: [Qemu-devel] [PATCH] doc/memory.txt: fix typo

[Cao jin <caoj.fnst@cn.fujitsu.com>]

On 02/25/2016 10:24 PM, Peter Maydell wrote:
> On 25 February 2016 at 13:30, Cao jin <caoj.fnst@cn.fujitsu.com> wrote:

>
> You're certainly right that the documentation as it stands is wrong.
> I don't think this is a simple typo though. Probably what happened
> was that when the API was being designed it started off with an
> 'unaligned' field, and then later the field name and semantics
> were changed but the docs weren't updated to match. My point was
> that just changing the name without looking at the behaviour we're
> actually implementing isn't correct.
>

Totally agree with the point.

>> I admit that, the description like ".valid.unaligned specifies that the
>> device only accepts naturally aligned accesses" looks very confusing. But
>> from the only caller memory_region_access_valid(), I think the original
>> maybe not quite good? how about this:
>
>> /.valid.unaligned specifies that the device accepts unaligned accesses.  If
>> false, Unaligned accesses invoke device and bus specific behaviour/
>
> I would suggest:
>
>    - .valid.unaligned specifies that the *device being modelled*
>      supports unaligned accesses; if false, unaligned accesses will
>      invoke the appropriate bus or CPU specific behaviour.
>

Does better. I want to pack this into a trivial patch first, because the 
original is not easy to read & understand

> (the idea being to make the text parallel to the existing
> .impl.unaligned docs so it's clear what the difference is.)
>
> thanks
> -- PMM
>
>
> .
>

-- 
Yours Sincerely,

Cao jin