From 90404c53682f464b4a26efd618887dc336d9da80 Mon Sep 17 00:00:00 2001
From: Laszlo Ersek <lersek@redhat.com>
Date: Thu, 18 May 2023 14:59:39 +0200
Subject: [PATCH] docs: make isa-debugcon example more useful / directly
 applicable
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The type='pty' attribute in the <serial> element causes a Pseudo TTY to be
allocated on the host side via "/dev/ptmx", which is meant to be
interacted with via "virsh console" or similar.

That's not how a firmware log is typically viewed or saved. Replace
type='pty' with type='file', and also provide an example <source> element
(with the pathname of the logfile), similarly to how the <serial> example
just above provides a <source> element too.

Cc: "Daniel P. Berrangé" <berrange@redhat.com>
Cc: Andrea Bolognani <abologna@redhat.com>
Updates: 654968381df0256c047d2ecd4542ccc90dc57ad0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---
 docs/formatdomain.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 6b8b60804e..b46eefb0f6 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6631,9 +6631,10 @@ Serial port
        <target port='0'/>
      </serial>
      <!-- Debug port for SeaBIOS / EDK II -->
-     <serial type='pty'>
+     <serial type='file'>
        <target type='isa-debug'/>
        <address type='isa' iobase='0x402'/>
+       <source path='/tmp/DOMAIN-ovmf.log'/>
      </serial>
 
    </devices>