On Fri, 11 Oct 2024 at 10:50, Paolo Bonzini <pbonz...@redhat.com> wrote:
>
> Always use a named reference for clarity, and ensure the space is escaped if 
> the
> footnote must attach to the preceding word.
>
> Signed-off-by: Paolo Bonzini <pbonz...@redhat.com>
> ---
>  docs/devel/atomics.rst              | 6 +++---
>  docs/devel/build-system.rst         | 2 +-
>  docs/devel/loads-stores.rst         | 2 +-
>  docs/devel/maintainers.rst          | 4 ++--
>  docs/devel/migration/mapped-ram.rst | 4 ++--
>  docs/specs/fw_cfg.rst               | 4 ++--
>  docs/specs/rapl-msr.rst             | 4 ++--
>  7 files changed, 13 insertions(+), 13 deletions(-)
>

> diff --git a/docs/specs/fw_cfg.rst b/docs/specs/fw_cfg.rst
> index 5ad47a901c9..c353957e1d3 100644
> --- a/docs/specs/fw_cfg.rst
> +++ b/docs/specs/fw_cfg.rst
> @@ -54,11 +54,11 @@ Data Register
>  -------------
>
>  * Read/Write (writes ignored as of QEMU v2.4, but see the DMA interface)
> -* Location: platform dependent (IOport [#]_ or MMIO)
> +* Location: platform dependent (IOport [#placement]_ or MMIO)

Missing "\" ?

>  * Width: 8-bit (if IOport), 8/16/32/64-bit (if MMIO)
>  * Endianness: string-preserving
>
> -.. [#]
> +.. [#placement]
>      On platforms where the data register is exposed as an IOport, its
>      port number will always be one greater than the port number of the
>      selector register. In other words, the two ports overlap, and can not
> diff --git a/docs/specs/rapl-msr.rst b/docs/specs/rapl-msr.rst
> index 1202ee89bee..901ce83bfa8 100644
> --- a/docs/specs/rapl-msr.rst
> +++ b/docs/specs/rapl-msr.rst
> @@ -9,7 +9,7 @@ The consumption is reported via MSRs (model specific 
> registers) like
>  MSR_PKG_ENERGY_STATUS for the CPU package power domain. These MSRs are 64 
> bits
>  registers that represent the accumulated energy consumption in micro Joules.
>
> -Thanks to the MSR Filtering patch [#a]_ not all MSRs are handled by KVM. Some
> +Thanks to the MSR Filtering patch\ [#a]_ not all MSRs are handled by KVM. 
> Some
>  of them can now be handled by the userspace (QEMU). It uses a mechanism 
> called
>  "MSR filtering" where a list of MSRs is given at init time of a VM to KVM so
>  that a callback is put in place. The design of this patch uses only this
> @@ -92,7 +92,7 @@ found by the sysconf system call. A typical value of clock 
> ticks per second is
>  package has 4 cores, 400 ticks maximum can be scheduled on all the cores
>  of the package for a period of 1 second.
>
> -The /proc/[pid]/stat [#b]_ is a sysfs file that can give the executed time 
> of a
> +The /proc/[pid]/stat\ [#b]_ is a sysfs file that can give the executed time 
> of a
>  process with the [pid] as the process ID. It gives the amount of ticks the
>  process has been scheduled in userspace (utime) and kernel space (stime).

(This is another file where the footnotes are just URLs and we
should turn them into direct links I think.)

With the missing "\" fixed,
Reviewed-by: Peter Maydell <peter.mayd...@linaro.org>

thanks
-- PMM

Reply via email to