docs: improve isa-debugcon example

[PATCH 2/2] docs: make isa-debugcon example more useful / directly applicable

Posted by Laszlo Ersek 4 months, 1 week ago

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>
---

Notes:
    context:-U6

 docs/formatdomain.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 6b8b60804e62..b46eefb0f675 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6628,15 +6628,16 @@ Serial port
      <!-- Serial port -->
      <serial type='pty'>
        <source path='/dev/pts/3'/>
        <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>
    ...
 
 ::

Re: [PATCH 2/2] docs: make isa-debugcon example more useful / directly applicable

Posted by Andrea Bolognani 4 months, 1 week ago

On Thu, May 18, 2023 at 02:59:39PM +0200, Laszlo Ersek wrote:
> 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>
> ---
>
> Notes:
>     context:-U6
>
>  docs/formatdomain.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

I see you've already pushed the patches but, just for completeness'
sake:

Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization

Re: [PATCH 2/2] docs: make isa-debugcon example more useful / directly applicable

Posted by Laszlo Ersek 4 months, 1 week ago

On 5/18/23 16:34, Andrea Bolognani wrote:
> On Thu, May 18, 2023 at 02:59:39PM +0200, Laszlo Ersek wrote:
>> 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>
>> ---
>>
>> Notes:
>>     context:-U6
>>
>>  docs/formatdomain.rst | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> I see you've already pushed the patches

I for sure have not, I don't have the right (that I know of)!

Hm... we have Jano to blame ^W^W to thank to, for the push :)

> but, just for completeness' sake:
> 
> Reviewed-by: Andrea Bolognani <abologna@redhat.com>

Thank you both!
Laszlo