qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Cornelia Huck <cohuck@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>,
	qemu-arm@nongnu.org, qemu-devel@nongnu.org
Subject: Re: [PATCH for-8.0] docs/system/arm/cpu-features.rst: Fix formatting
Date: Thu, 16 Mar 2023 12:11:05 +0100	[thread overview]
Message-ID: <87h6ul0x4m.fsf@redhat.com> (raw)
In-Reply-To: <20230316105808.1414003-1-peter.maydell@linaro.org>

On Thu, Mar 16 2023, Peter Maydell <peter.maydell@linaro.org> wrote:

> The markup for the Arm CPU feature documentation is incorrect,
> and results in the HTML not rendering correctly -- the first
> line of each description is rendered in boldface as if it
> were part of the option name.
>
> Reformat to match the styling used in cpu-models-x86.rst.inc.
>
> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/1479
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/system/arm/cpu-features.rst | 68 ++++++++++++++------------------
>  1 file changed, 30 insertions(+), 38 deletions(-)

(...)

> @@ -217,16 +210,15 @@ TCG VCPU Features
>  TCG VCPU features are CPU features that are specific to TCG.
>  Below is the list of TCG VCPU features and their descriptions.
>  
> -  pauth-impdef             When ``FEAT_Pauth`` is enabled, either the
> -                           *impdef* (Implementation Defined) algorithm
> -                           is enabled or the *architected* QARMA algorithm
> -                           is enabled.  By default the impdef algorithm
> -                           is disabled, and QARMA is enabled.
> +``pauth-impdef``
> +  When ``FEAT_Pauth`` is enabled, either the *impdef* (Implementation
> +  Defined) algorithm is enabled or the *architected* QARMA algorithm
> +  is enabled.  By default the impdef algorithm is disabled, and QARMA
> +  is enabled.
>  
> -                           The architected QARMA algorithm has good
> -                           cryptographic properties, but can be quite slow
> -                           to emulate.  The impdef algorithm used by QEMU
> -                           is non-cryptographic but significantly faster.
> +  The architected QARMA algorithm has good ryptographic properties,

You dropped a 'c' here ----------------------^

> +  but can be quite slow to emulate.  The impdef algorithm used by QEMU
> +  is non-cryptographic but significantly faster.
>  
>  SVE CPU Properties
>  ==================



  reply	other threads:[~2023-03-16 11:12 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-16 10:58 [PATCH for-8.0] docs/system/arm/cpu-features.rst: Fix formatting Peter Maydell
2023-03-16 11:11 ` Cornelia Huck [this message]
2023-03-16 11:41   ` Peter Maydell
2023-03-21 11:56     ` Peter Maydell
2023-03-21 12:20       ` Cornelia Huck

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=87h6ul0x4m.fsf@redhat.com \
    --to=cohuck@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-arm@nongnu.org \
    --cc=qemu-devel@nongnu.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).