[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] qemu-options.hx: Fix minor issues in icount documentation
From: |
Richard Henderson |
Subject: |
Re: [PATCH] qemu-options.hx: Fix minor issues in icount documentation |
Date: |
Tue, 24 Nov 2020 08:25:59 -0800 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 |
On 11/21/20 1:35 PM, Peter Maydell wrote:
> The documentation for the icount documentation has some minor issues:
> * in a couple of places it says "sleep=on|off" when in the context of the
> sentence it means specifically "sleep=on"
> * the synopsis line for the documentation has drifted out of sync
> with the synopsis line in the DEF() macro (used for "-help" output)
> * the synopsis line in the DEF() macro is missing a "][" between
> the sleep= part and the rr= part
> * the synopsis line doesn't indicate that rrsnapshot is an optional
> part of the rr=mode,rrfile=filename subgrouping
> * we don't document that sleep=on can't be used with shift=auto
> or align=on
> * the rr option description had some minor grammar and formatting
> errors and was a bit terse
> * in commit f1f4b57e88ff in 2015 the documentation of the sleep=
> suboption got added between the two paragraphs defining general
> behaviour of the icount option. This meant that the second
> paragraph talking about the behaviour of "this option" reads as
> if it's talking about sleep=on, when it's really describing -icount
> as a whole. The paragraph is better moved back up to above the
> sleep= section.
> * the summary text displayed in "-help" output didn't mention
> the record-and-replay part
>
> Fix these errors.
>
> Fixes: https://bugs.launchpad.net/qemu/+bug/1774412
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> qemu-options.hx | 42 ++++++++++++++++++++++++------------------
> 1 file changed, 24 insertions(+), 18 deletions(-)
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
r~