From nobody Mon Apr 29 07:17:07 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1599486530; cv=none; d=zohomail.com; s=zohoarc; b=ZRwdImC6ZXSnXFZ5rf91wvkN6DZpxadHiTxH7pgjwxuAZkMWAJO5I1y8OZnuPv4xHOVHwpoG5G6CtnBO6XwKilyZa88hvmh2nMVU4Tt9Q4X0rZOKZgj6jufXrwLdmFTLKSDfOMAUtUBZ6xvczj5xqLCUAQG/8gtvfkSnjMkT3Uw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1599486530; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=B+BnEeJtRu4tRH76ZVgklb7W+dJnZa2Y6ztWw2h+I/c=; b=BeR9Yfun4dQzkMDnYhb6RVXImGQj/fgOPxqDCBvuEoqVFTDs7hJAnfmA2WLgxNhnmE5CCWSk7ZUGufnA6B/Yad1gVQFhBDXkR5DKDOTP/NYWaQ+RaVi9Wh7ZzV5nXT3fczHm1lODEnJf4xlxOoY6QmgErc/CMuWk2kiRFYVZ8aE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1599486530822707.1438531184667; Mon, 7 Sep 2020 06:48:50 -0700 (PDT) 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-488-cJpmYFHbOS2zI_hIP3NoZg-1; Mon, 07 Sep 2020 09:48:47 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 3D7F7100670E; Mon, 7 Sep 2020 13:48:41 +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 DE0955C1BB; Mon, 7 Sep 2020 13:48:40 +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 960D418561B2; Mon, 7 Sep 2020 13:48:38 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 087Dmapa023550 for ; Mon, 7 Sep 2020 09:48:37 -0400 Received: by smtp.corp.redhat.com (Postfix) id F0D4C5C225; Mon, 7 Sep 2020 13:48:36 +0000 (UTC) Received: from localhost.localdomain (unknown [10.40.193.135]) by smtp.corp.redhat.com (Postfix) with ESMTP id 7151A5C1BB; Mon, 7 Sep 2020 13:48:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1599486529; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=B+BnEeJtRu4tRH76ZVgklb7W+dJnZa2Y6ztWw2h+I/c=; b=NskcxIeWPs5MDDl4uhI+ZBAHQvm9Hf9yYE1FheaUfgvw8hj8GzSAldpfBBB4x7MaVKjUse hwBJiDBTEDGZT3ZqZ1LorLyLzymDojR0DbbRq6n9AzxEzXqEkLDKUF50+vIJTY7GQekzKE AE2OH6hGQbFNXO4paC2N9bnpt8eTBhY= X-MC-Unique: cJpmYFHbOS2zI_hIP3NoZg-1 From: Michal Privoznik To: libvir-list@redhat.com Subject: [PATCH] docs: Discourage users from using fwcfg Date: Mon, 7 Sep 2020 15:48:16 +0200 Message-Id: <4b8abba831f4ba316668d261d631c86dd27c0346.1599486496.git.mprivozn@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Cc: lersek@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.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0.001 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Even though this was brought up in upstream discussion [1] it missed my patches: users should prefer over fwcfg. The reason is that fwcfg is considered somewhat internal to QEMU and it has limited number of slots and neither of these applies to . While I'm at it, I'm fixing the example too (because it contains incorrect element name) and clarifying sysfs/ exposure. 1: https://www.redhat.com/archives/libvir-list/2020-May/msg00957.html Reported-by: Laszlo Ersek Signed-off-by: Michal Privoznik Reviewed-by: Laszlo Ersek --- docs/formatdomain.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 1979dfb8d3..821ffe8d60 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -509,18 +509,22 @@ layout of sub-elements, with supported values of: Some hypervisors provide unified way to tweak how firmware configures i= tself, or may contain tables to be installed for the guest OS, for instance bo= ot order, ACPI, SMBIOS, etc. It even allows users to define their own conf= ig - blobs. In case of QEMU, these then appear under domain's sysfs, under + blobs. In case of QEMU, these then appear under domain's sysfs (if the = guest + kernel has FW_CFG_SYSFS config option enabled), under ``/sys/firmware/qemu_fw_cfg``. Note, that these values apply regardless= the mode under . :since:`Since 6.5.0` =20 + **Please note that because of limited number of data slots use of fwcfg= is + strongly discouraged and should be used instead**. + :: =20 - + example value - - + + =20 - The ``smbios`` element can have multiple ``entry`` child elements. Each + The ``sysinfo`` element can have multiple ``entry`` child elements. Each element then has mandatory ``name`` attribute, which defines the name o= f the blob and must begin with ``"opt/"`` and to avoid clashing with other na= mes is advised to be in form ``"opt/$RFQDN/$name"`` where ``$RFQDN`` is a reve= rse --=20 2.26.2