motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-11 03:24:58 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: avoid footnotes consisting of just URLs

Browse source 
Replace the footnotes with inline links whenever the footnote text
consists of nothing but the URL.  While at it, make the link texts
consistent in the surrounding areas, for example avoiding usage of
"here" for the link's text.

In the case of acpi-bits.rst this fixes a build failure with Sphinx
8.1.0, because the FOSDEM link was duplicated in the paragraph and the
new version is a lot stricter about unreferenced footnotes.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Paolo Bonzini 2024-10-11 11:27:21 +02:00
parent effb0f7724
commit 232c3a848e
2 changed files with 25 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/devel/testing/acpi-bits.rst
View file

@ -30,15 +30,20 @@ OS modules are generally written using low level languages such as C and
low level assembly machine language. Writing test routines in a low level low level assembly machine language. Writing test routines in a low level
language makes things more cumbersome. These and other reasons makes using language makes things more cumbersome. These and other reasons makes using
bios-bits very attractive for testing bioses. More details on the inspiration bios-bits very attractive for testing bioses. More details on the inspiration
for developing biosbits and its real life uses can be found in [#a]_ and [#b]_. for developing biosbits and its real life uses were presented `at Plumbers
in 2011 <Plumbers_>`__ and `at Linux.conf.au in 2012 <Linux.conf.au_>`__.
For QEMU, we maintain a fork of bios bits in gitlab along with all the For QEMU, we maintain a fork of bios bits in `gitlab`_, along with all
dependent submodules `here <https://gitlab.com/qemu-project/biosbits-bits>`__. the dependent submodules. This fork contains numerous fixes, a newer
This fork contains numerous fixes, a newer acpica and changes specific to acpica and changes specific to running these functional QEMU tests using
running these functional QEMU tests using bits. The author of this document bits. The author of this document is the current maintainer of the QEMU
is the sole maintainer of the QEMU fork of bios bits repository. For more fork of bios bits repository. For more information, please see `the
information, please see author's `FOSDEM talk on this bios-bits based test author's FOSDEM presentation <FOSDEM_>`__ on this bios-bits based test framework.
framework <https://fosdem.org/2024/schedule/event/fosdem-2024-2262-exercising-qemu-generated-acpi-smbios-tables-using-biosbits-from-within-a-guest-vm-/>`__.
.. _Plumbers: https://blog.linuxplumbersconf.org/2011/ocw/system/presentations/867/original/bits.pdf
.. _Linux.conf.au: https://www.youtube.com/watch?v=36QIepyUuhg
.. _gitlab: https://gitlab.com/qemu-project/biosbits-bits
.. _FOSDEM: https://fosdem.org/2024/schedule/event/fosdem-2024-2262-exercising-qemu-generated-acpi-smbios-tables-using-biosbits-from-within-a-guest-vm-/
********************************* *********************************
Description of the test framework Description of the test framework
@ -148,8 +153,3 @@ Under ``tests/functional/`` as the root we have:
Author: Ani Sinha <anisinha@redhat.com> Author: Ani Sinha <anisinha@redhat.com>
References:
-----------
.. [#a] https://blog.linuxplumbersconf.org/2011/ocw/system/presentations/867/original/bits.pdf
.. [#b] https://www.youtube.com/watch?v=36QIepyUuhg
.. [#c] https://fosdem.org/2024/schedule/event/fosdem-2024-2262-exercising-qemu-generated-acpi-smbios-tables-using-biosbits-from-within-a-guest-vm-/

25
docs/specs/rapl-msr.rst
View file

@ -9,11 +9,12 @@ 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 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. 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 KVM's `MSR filtering <msr-filter-patch_>`__ functionality,
of them can now be handled by the userspace (QEMU). It uses a mechanism called not all MSRs are handled by KVM. Some of them can now be handled by the
"MSR filtering" where a list of MSRs is given at init time of a VM to KVM so userspace (QEMU); a list of MSRs is given at VM creation time to KVM, and
that a callback is put in place. The design of this patch uses only this a userspace exit occurs when they are accessed.
mechanism for handling the MSRs between guest/host.
.. _msr-filter-patch: https://patchwork.kernel.org/project/kvm/patch/20200916202951.23760-7-graf@amazon.com/
At the moment the following MSRs are involved: At the moment the following MSRs are involved:
@ -92,9 +93,12 @@ 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 package has 4 cores, 400 ticks maximum can be scheduled on all the cores
of the package for a period of 1 second. 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 `/proc/[pid]/stat <stat_>`__ is a procfs file that can give the executed
process with the [pid] as the process ID. It gives the amount of ticks the time of a process with the [pid] as the process ID. It gives the amount
process has been scheduled in userspace (utime) and kernel space (stime). of ticks the process has been scheduled in userspace (utime) and kernel
space (stime).
.. _stat: https://man7.org/linux/man-pages/man5/proc.5.html
By reading those metrics for a thread, one can calculate the ratio of time the By reading those metrics for a thread, one can calculate the ratio of time the
package has spent executing the thread. package has spent executing the thread.
@ -148,8 +152,3 @@ Current Limitations
- Only the Package Power-Plane (MSR_PKG_ENERGY_STATUS) is reported at the - Only the Package Power-Plane (MSR_PKG_ENERGY_STATUS) is reported at the
moment. moment.
References
----------
.. [#a] https://patchwork.kernel.org/project/kvm/patch/20200916202951.23760-7-graf@amazon.com/
.. [#b] https://man7.org/linux/man-pages/man5/proc.5.html