[PATCH 1/2] docs: fix typo in isa-debugcon example

Laszlo Ersek posted 2 patches 1 year, 3 months ago
[PATCH 1/2] docs: fix typo in isa-debugcon example
Posted by Laszlo Ersek 1 year, 3 months ago
The <serial> opening tag is paired with the </console> closing tag; that's
a mismatch. The question is then whether to modify the former to
<console>, or the latter to </serial>.

Per section "Relationship between serial ports and consoles", <serial> is
used for emulated (not paravirt) consoles, and it's the type that's
suitable for early debug output (such as from firmware). Thus, change
</console> to </serial>.

Cc: "Daniel P. Berrangé" <berrange@redhat.com>
Cc: Andrea Bolognani <abologna@redhat.com>
Fixes: 654968381df0256c047d2ecd4542ccc90dc57ad0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
 docs/formatdomain.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 1f52f58d37e1..6b8b60804e62 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6634,7 +6634,7 @@ Serial port
      <serial type='pty'>
        <target type='isa-debug'/>
        <address type='isa' iobase='0x402'/>
-     </console>
+     </serial>
 
    </devices>
    ...

Re: [PATCH 1/2] docs: fix typo in isa-debugcon example
Posted by Andrea Bolognani 1 year, 3 months ago
On Thu, May 18, 2023 at 02:59:38PM +0200, Laszlo Ersek wrote:
> The <serial> opening tag is paired with the </console> closing tag; that's
> a mismatch. The question is then whether to modify the former to
> <console>, or the latter to </serial>.
>
> Per section "Relationship between serial ports and consoles", <serial> is
> used for emulated (not paravirt) consoles, and it's the type that's
> suitable for early debug output (such as from firmware). Thus, change
> </console> to </serial>.
>
> Cc: "Daniel P. Berrangé" <berrange@redhat.com>
> Cc: Andrea Bolognani <abologna@redhat.com>
> Fixes: 654968381df0256c047d2ecd4542ccc90dc57ad0
> Signed-off-by: Laszlo Ersek <lersek@redhat.com>
> ---
>  docs/formatdomain.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Oops O:-)

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

-- 
Andrea Bolognani / Red Hat / Virtualization