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

[Peter Maydell]

On 25 February 2016 at 09:32, Cao jin <address@hidden> wrote:
> to match structure MemoryRegionOps definition
>
> Signed-off-by: Cao jin <address@hidden>
> ---
> And there seems are some out of date content in this file, like
> "cpu_register_io_memory()" mentioned in the last line, which is removed 
> several
> years ago in commit 97161e177. I am sure how to modify it, So I take the
> liberty to CC the guys in the cc-list(get list from get_maintainer.pl).k

The part that says
# - .old_mmio can be used to ease porting from code using
#   cpu_register_io_memory(). It should not be used in new code.

could be changed to say "has been used to ease porting from code that
used to use cpu_register_io_memory()" if you like. The information
here is not wrong, really, just the tense.

(There are just 32 uses of old_mmio left in the codebase, which
hopefully we may eventually get rid of.)

>  docs/memory.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/docs/memory.txt b/docs/memory.txt
> index 8745f76..1a3ad622 100644
> --- a/docs/memory.txt
> +++ b/docs/memory.txt
> @@ -297,7 +297,7 @@ various constraints can be supplied to control how these 
> callbacks are called:
>   - .valid.min_access_size, .valid.max_access_size define the access sizes
>     (in bytes) which the device accepts; accesses outside this range will
>     have device and bus specific behaviour (ignored, or machine check)
> - - .valid.aligned specifies that the device only accepts naturally aligned
> + - .valid.unaligned specifies that the device only accepts naturally aligned
>     accesses.  Unaligned accesses invoke device and bus specific behaviour.

This doesn't look like the right change, because (a) a field named
unaligned which you set true to specifiy that unaligned accesses
are invalid would be very confusing and (b) the comment in the
header file says that 'valid.unaligned' means that the device does
support unaligned accesses.

>   - .impl.min_access_size, .impl.max_access_size define the access sizes
>     (in bytes) supported by the *implementation*; other access sizes will be

We also seem to be missing documentation of valid.accepts.

thanks
-- PMM