diff mbox

[8/9] update -g command line switch documentation

Message ID 1487715299-21102-9-git-send-email-kraxel@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

Gerd Hoffmann Feb. 21, 2017, 10:14 p.m. UTC
Bring documentation in line with the recent changes.
Text suggested by László Érsek.

Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
---
 qemu-options.hx | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

Comments

Laszlo Ersek Feb. 22, 2017, 12:37 a.m. UTC | #1
On 02/21/17 23:14, Gerd Hoffmann wrote:
> Bring documentation in line with the recent changes.
> Text suggested by László Érsek.
> 
> Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
> ---
>  qemu-options.hx | 13 ++++++++++++-
>  1 file changed, 12 insertions(+), 1 deletion(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 4e89610..ae62e0d 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1241,7 +1241,18 @@ DEF("g", 1, QEMU_OPTION_g ,
>  STEXI
>  @item -g @var{width}x@var{height}[x@var{depth}]
>  @findex -g
> -Set the initial graphical resolution and depth (PPC, SPARC only).
> +Set the initial graphical resolution and depth.
> +
> +This setting may be masked by guest firmware temporarily.
> +
> +On PPC and SPARC, the guest firmware will configure the display from
> +this setting, and the guest OS will inherit the display resolution
> +and depth.
> +
> +On x86 and ARM, if the guest firmware is an edk2 (UEFI) platform,
> +the firmware may initially configure the display according to its own,
> +persistent, independent settings. The guest OS drivers, once loaded,
> +should adhere to "-g" however, for virtio and qxl adapters.

I think I made a small mistake here in my earlier suggestion; I think I
should have restricted qxl to x86 only, something like:

  ... should adhere to "-g" however, for virtio (x86, ARM) and qxl
  (x86 only) adapters

Lest we appear to suggest that QXL will ever be available in aarch64
guests :)

>  ETEXI
>  
>  DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
> 

Looks good to me (and thank you for considering my response earlier).
With the above tweak:

Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Furthermore, once patch #9 becomes a real patch, this documentation
should be updated again, adding "VGA (x86 only)" as well.

Thanks!
Laszlo
diff mbox

Patch

diff --git a/qemu-options.hx b/qemu-options.hx
index 4e89610..ae62e0d 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1241,7 +1241,18 @@  DEF("g", 1, QEMU_OPTION_g ,
 STEXI
 @item -g @var{width}x@var{height}[x@var{depth}]
 @findex -g
-Set the initial graphical resolution and depth (PPC, SPARC only).
+Set the initial graphical resolution and depth.
+
+This setting may be masked by guest firmware temporarily.
+
+On PPC and SPARC, the guest firmware will configure the display from
+this setting, and the guest OS will inherit the display resolution
+and depth.
+
+On x86 and ARM, if the guest firmware is an edk2 (UEFI) platform,
+the firmware may initially configure the display according to its own,
+persistent, independent settings. The guest OS drivers, once loaded,
+should adhere to "-g" however, for virtio and qxl adapters.
 ETEXI
 
 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,