From nobody Fri Apr 26 03:07:51 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) client-ip=207.211.31.81; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) by mx.zohomail.com with SMTPS id 1581432305649999.3615912225022; Tue, 11 Feb 2020 06:45:05 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-385-usmki_VHPpeRfNmdsxGj1g-1; Tue, 11 Feb 2020 09:44:58 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id A58251005512; Tue, 11 Feb 2020 14:44:52 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 04BB689E94; Tue, 11 Feb 2020 14:44:51 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 66AAA18089CD; Tue, 11 Feb 2020 14:44:47 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 01BEijCJ002010 for ; Tue, 11 Feb 2020 09:44:45 -0500 Received: by smtp.corp.redhat.com (Postfix) id A8D905DA7B; Tue, 11 Feb 2020 14:44:45 +0000 (UTC) Received: from kinshicho.usersys.redhat.com (unknown [10.43.2.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2F4F85D9E2 for ; Tue, 11 Feb 2020 14:44:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1581432300; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=YOva3WQ9FFp6MFfPBCPFSrZ6GoGSWhnG0bUUtbT7ecg=; b=Y4NDh0kUTjEt1kWuKeu6PbDV3gLdvrCEvBx6URFFoT21jYu4/AqGLYDsrpU48u5LbqojcO oomFp/dQVXVaENdXgKYTM7x/VVeYucELDkd2kTAQePT7k+NK1+wuCiq2iajMloOrVqd7ex u4Ec2QgEyMefPRNJW/ZAJO5rM9ZXtL4= From: Andrea Bolognani To: libvir-list@redhat.com Subject: [libvirt PATCH] docs: Improve documentation for and Date: Tue, 11 Feb 2020 15:44:40 +0100 Message-Id: <20200211144440.186600-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-MC-Unique: usmki_VHPpeRfNmdsxGj1g-1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Users expect to be able to configure the element and see that configuration reflected into the element or at least sticking, however due to our crazy back-compat code that doesn't always happen. There's really not much we can do to make this kind of corner cases work as the user would expect, especially not without introducing additional complexity in a part of libvirt that already has more than a fair share of it; we can, however, improve the documentation so that it will nudge said users in the right direction. https://bugzilla.redhat.com/show_bug.cgi?id=3D1770725 Signed-off-by: Andrea Bolognani Reviewed-by: J=C3=A1n Tomko --- docs/formatdomain.html.in | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 44e2062d01..5ccf39abd1 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -7510,7 +7510,10 @@ qemu-kvm -net nic,model=3D? /dev/null since 4.7.0, 16550a (usable with the system-serial target type); sclpconsole and sclplmconsole (usable with - the sclp-serial target type). + the sclp-serial target type). Providing a target model = is + usually unnecessary: libvirt will automatically pick one that's suit= able + for the chosen target type, and overriding that value is generally n= ot + recommended.

=20

@@ -7656,7 +7659,8 @@ qemu-kvm -net nic,model=3D? /dev/null for early boot logging / interactive / recovery use, and one paravirtualized serial console to be used eg. as a side channel. Most people will be fine with having just the first console - element in their configuration. + element in their configuration, but if a specific configuration is + desired then both elements should be specified.

=20

--=20 2.24.1