diff mbox

[v3,1/2] doc/memory: fix typo

Message ID 1456486178-8074-2-git-send-email-caoj.fnst@cn.fujitsu.com
State New
Headers show

Commit Message

Cao jin Feb. 26, 2016, 11:29 a.m. UTC
Fix typo while also modify its description, make the text parallel to
the existing .impl.unaligned doc.

Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com>
---
 docs/memory.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Peter Maydell Feb. 26, 2016, 11:36 a.m. UTC | #1
On 26 February 2016 at 11:29, Cao jin <caoj.fnst@cn.fujitsu.com> wrote:
> Fix typo while also modify its description, make the text parallel to
> the existing .impl.unaligned doc.

This still isn't a typo...

> Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com>
> ---
>  docs/memory.txt | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/docs/memory.txt b/docs/memory.txt
> index 8745f76..306280e 100644
> --- a/docs/memory.txt
> +++ b/docs/memory.txt
> @@ -297,8 +297,9 @@ 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
> -   accesses.  Unaligned accesses invoke device and bus specific behaviour.
> + - .valid.unaligned specifies that the *device being modelled* supports
> +   unaligned accesses. if false, unaligned accesses will invoke the appropriate
> +   bus or CPU specific behaviour.

Needs to be a semicolon before the "if".

Either "something something. If foo" or "something something; if foo"
are correct as punctuation. Since we're aiming to follow the same
construction as the existing text for .impl.unaligned, we want the
semicolon and lowercase.

>   - .impl.min_access_size, .impl.max_access_size define the access sizes
>     (in bytes) supported by the *implementation*; other access sizes will be
>     emulated using the ones available.  For example a 4-byte write will be
> --
> 2.1.0

thanks
-- PMM
Cao jin Feb. 28, 2016, 10:48 a.m. UTC | #2
On 02/26/2016 07:36 PM, Peter Maydell wrote:
> On 26 February 2016 at 11:29, Cao jin <caoj.fnst@cn.fujitsu.com> wrote:

>
> Needs to be a semicolon before the "if".
>
> Either "something something. If foo" or "something something; if foo"
> are correct as punctuation. Since we're aiming to follow the same
> construction as the existing text for .impl.unaligned, we want the
> semicolon and lowercase.
>

interesting punctuation knowledge to me(as a non-native speaker). Thanks 
for the comment:)
diff mbox

Patch

diff --git a/docs/memory.txt b/docs/memory.txt
index 8745f76..306280e 100644
--- a/docs/memory.txt
+++ b/docs/memory.txt
@@ -297,8 +297,9 @@  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
-   accesses.  Unaligned accesses invoke device and bus specific behaviour.
+ - .valid.unaligned specifies that the *device being modelled* supports
+   unaligned accesses. if false, unaligned accesses will invoke the appropriate
+   bus or CPU specific behaviour.
  - .impl.min_access_size, .impl.max_access_size define the access sizes
    (in bytes) supported by the *implementation*; other access sizes will be
    emulated using the ones available.  For example a 4-byte write will be