From 74444f8eeda44d894a814db6db837c239189c7d1 Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Sun, 26 Dec 2021 00:56:18 +0200 Subject: [PATCH] [docs] Minor semantic spit and polish Co-authored-by: Guanzhong Chen Co-authored-by: Netboy3 <1472804+netboy3@users.noreply.github.com> --- doc/install.rst | 8 ++++---- doc/module.rst | 12 ++++++------ doc/obs.rst | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 745d82a5..728053e8 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -367,9 +367,9 @@ EGL Filters tab The EGL Filters tab contains options for toggling, configuring, and ordering post-processing filters. Each filter can be expanded to open its settings. Filters can also be re-ordered by dragging them up or down. Filters are applied -from top to bottom, keep this in mind when ordering them. (applying CAS before -FSR might have different results than the reverse). Users are encouraged to -experiment with the order and parameters to achieve optimal results. The +from top to bottom, keep this in mind when ordering them, e.g applying CAS +before FSR might have different results than the reverse. Users are encouraged +to experiment with the order and parameters to achieve optimal results. The currently available filters include: - Downscaler: Filter for downscaling the host resolution. Can be used to undo @@ -377,7 +377,7 @@ currently available filters include: has a pixel-size setting that is used to set the effective downscaling ratio, and a configurable interpolation algorithm. -- AMD FidelityFX Super Resolution (FSR): A spatial upscaling filter that works +- AMD FidelityFX Super Resolution (FSR): Spatial upscaling filter that works on low resolution frames from the guest VM and intelligently upscales to a higher resolution. The filter sharpness is tunable, and displays the equivalent AMD quality mode based on the resolution difference. diff --git a/doc/module.rst b/doc/module.rst index 4ab4b549..6391b9a6 100644 --- a/doc/module.rst +++ b/doc/module.rst @@ -181,10 +181,6 @@ should use this XML block to configure their VM for kvmfr: .. note:: - - Using an incorrect syntax for your host configuration may cause QEMU to - abort with the following error message: - "``error: internal error: ... PCI: slot 1 function 0 not available for pcie-root-port, in use by ivshmem-plain``" - - The ``"size"`` tag represents the size of the shared memory device in bytes. Once you determine the proper size of the device as per :ref:`Determining Memory `, use the figure you @@ -206,8 +202,12 @@ legacy syntax for IVSHMEM setup: .. note:: - Remember to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` - to the ```` tag. + - Using the legacy syntax on QEMU 6.2/libvirt 7.9 may cause QEMU to + abort with the following error message: + "``error: internal error: ... PCI: slot 1 function 0 not available for pcie-root-port, in use by ivshmem-plain``" + + - Remember to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` + to the ```` tag. Running libvirt this way violates AppArmor and cgroups policies, which will block the VM from running. These policies must be amended to allow the VM diff --git a/doc/obs.rst b/doc/obs.rst index 44c4eb18..745e9f77 100644 --- a/doc/obs.rst +++ b/doc/obs.rst @@ -47,7 +47,7 @@ These instructions are similar to building the cmake -DUSER_INSTALL=1 ../ make -Alternatively, if you would like to install the plugin for all users. +Alternatively, if you would like to install the plugin for all users: .. code:: bash