From nobody Wed Dec 17 08:55:55 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1744032394; cv=none; d=zohomail.com; s=zohoarc; b=TMUX6cd4SaSpDMww6uCDKXoHIDi1oP5gRcwxxRdcNQRhprUWYgdEU0qYH807/xaG/ghBfGsPkR41slBTr+oRlSreKuWFFMFnMBfFaCqxIbgGWz1ze1WlD2ynzkVXbu0Y8hC7R0ODEHI9v4UXPOYa7Q/3C3byNPerC5Xc/YV+GcY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1744032394; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id; bh=NTeN/dCwfinUFqodfOxsO7cSX9GLpWms7mblISitoRk=; b=G0T/1U39WhTCsK4EkIA5+h611XcR6N1+PUM92veErtMEXDk31ZY2IrtTFcKUjJknZ+Sou6WeYh4lwUrKC6twyT4nDvX15fCybo8W/EuYzhAhLsJ33byBoCf6vN2+24dtDEJWP3eMm7owfoVB8ZmaIe3C3+9i6RwYI5P3aYmUPR0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1744032394481745.0776670443261; Mon, 7 Apr 2025 06:26:34 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id CD84F163A; Mon, 7 Apr 2025 09:26:33 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 5DC1716ED; Mon, 7 Apr 2025 09:25:21 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 0EBD6160E; Mon, 7 Apr 2025 09:25:16 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 19FE6161E for ; Mon, 7 Apr 2025 09:25:02 -0400 (EDT) Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-553-Xc9PK9o5OSCQI40KDW1i3g-1; Mon, 07 Apr 2025 09:24:29 -0400 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 780D41955DC6 for ; Mon, 7 Apr 2025 13:24:28 +0000 (UTC) Received: from speedmetal.lan (unknown [10.44.22.8]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 6F4B21955BC0; Mon, 7 Apr 2025 13:24:27 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H5, RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1744032301; h=from:from: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: in-reply-to:in-reply-to:references:references; bh=GmWKxahapmaRPu9rbvXHxNkBbDCplDmkqquFee/pRkI=; b=c3zIrHy6e8jCNdYh45My+yAFfXf3/qWb2Tjol8/8xHjikWt5ZOYVpqstzSbTt90w0BXyEy lDJDRd/FGKNMunmX814OA2rv6fFg1BO5EdCB7h4Ea/TiO5AzX9vux4iw24LfB6/7Pmvk5K NBuQDeoEK+xLeoraQJ5w+Xol36Emovs= X-MC-Unique: Xc9PK9o5OSCQI40KDW1i3g-1 X-Mimecast-MFC-AGG-ID: Xc9PK9o5OSCQI40KDW1i3g_1744032268 To: devel@lists.libvirt.org Subject: [PATCH 5/5] manpages: virsh: Use disclaimer from 'virNodeGetInfo()' for 'virsh nodeinfo' Date: Mon, 7 Apr 2025 15:24:17 +0200 Message-ID: <8e9ad20974797f33dd4f76f652e3f6106ff9624b.1744032236.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: HIK-V52GZi8xC9WS0ZIKu0oL5GI_drzuQDr2wZcRrtg_1744032268 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: HJ3T6RGB4XR233VNFYDC35JDNR25Q4SB X-Message-ID-Hash: HJ3T6RGB4XR233VNFYDC35JDNR25Q4SB X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header CC: Peter Krempa X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1744032395564019000 Content-Type: text/plain; charset="utf-8" From: Peter Krempa Adapt the disclarimer about the data not being accurate in many cases from the API docs to the virsh command using the aforementioned API. Signed-off-by: Peter Krempa --- docs/manpages/virsh.rst | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index b609b9647f..cef9959f16 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -427,10 +427,25 @@ nodeinfo nodeinfo Returns basic information about the node, like number and type of CPU, -and size of the physical memory. The output corresponds to virNodeInfo -structure. Specifically, the "CPU socket(s)" field means number of CPU -sockets per NUMA cell. The information libvirt displays is dependent -upon what each architecture may provide. +and size of the physical memory. + +Use of this command is strongly discouraged as the information provided +is not guaranteed to be accurate on all hardware platforms. + +The *CPU frequency* value merely reflects the speed that the first CPU in = the +machine is currently running at. This speed may vary across CPUs and chang= es +continually as the host OS throttles. + +The data structure used to fetch the data is not extensible thus only supp= orts +global nodes/sockets/cores/threads (sockets/cores/threads is per NUMA node) +topology information. If the host CPU has any further groupings (e.g. +dies, clusters, etc) or the NUMA topology is non-symmetrical the data stru= cture +can't faithfully represent the system. In such cases a fake topology +(nodes =3D 1, sockets =3D 1, cores =3D number of host cpus, threads =3D 1)= which +only correctly represents the total host CPU count is reported. + +Recommended replacement is to use the *capabilities* command which reports +the data (except frequency) under ``/capabilities/host/topology`` XPath. nodecpumap --=20 2.49.0