From patchwork Mon Jul 13 14:03:38 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 11659797 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 3EAE1618 for ; Mon, 13 Jul 2020 14:06:04 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 218B2206F0 for ; Mon, 13 Jul 2020 14:06:03 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 218B2206F0 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=suse.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1juz40-0002eS-SM; Mon, 13 Jul 2020 14:04:12 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1juz3z-0002eN-Jy for xen-devel@lists.xenproject.org; Mon, 13 Jul 2020 14:04:11 +0000 X-Inumbo-ID: b97bc844-c511-11ea-bca7-bc764e2007e4 Received: from mx2.suse.de (unknown [195.135.220.15]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id b97bc844-c511-11ea-bca7-bc764e2007e4; Mon, 13 Jul 2020 14:04:11 +0000 (UTC) X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.221.27]) by mx2.suse.de (Postfix) with ESMTP id 2FAF5ACA0; Mon, 13 Jul 2020 14:04:12 +0000 (UTC) From: Juergen Gross To: xen-devel@lists.xenproject.org Subject: [PATCH v2] docs: specify stability of hypfs path documentation Date: Mon, 13 Jul 2020 16:03:38 +0200 Message-Id: <20200713140338.16172-1-jgross@suse.com> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: Juergen Gross , Stefano Stabellini , Julien Grall , Wei Liu , paul@xen.org, Andrew Cooper , Ian Jackson , George Dunlap , Jan Beulich Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" In docs/misc/hypfs-paths.pandoc the supported paths in the hypervisor file system are specified. Make it more clear that path availability might change, e.g. due to scope widening or narrowing (e.g. being limited to a specific architecture). Signed-off-by: Juergen Gross Release-acked-by: Paul Durrant Acked-by: Jan Beulich --- V2: reworded as requested by Jan Beulich --- docs/misc/hypfs-paths.pandoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/misc/hypfs-paths.pandoc b/docs/misc/hypfs-paths.pandoc index a111c6f25c..00a7cec031 100644 --- a/docs/misc/hypfs-paths.pandoc +++ b/docs/misc/hypfs-paths.pandoc @@ -5,6 +5,9 @@ in the Xen hypervisor file system (hypfs). The hypervisor file system can be accessed via the xenhypfs tool. +The availability of the hypervisor file system depends on the hypervisor +config option CONFIG_HYPFS, which is on per default. + ## Notation The hypervisor file system is similar to the Linux kernel's sysfs. @@ -55,6 +58,11 @@ tags enclosed in square brackets. * CONFIG_* -- Path is valid only in case the hypervisor was built with the respective config option. +In case a tag for a path indicates that this path is available in some +case only, this availability might be extended or reduced in future by +modification or removal of the tag. A path once assigned meaning won't go +away altogether or change its meaning, though. + So an entry could look like this: /cpu-bugs/active-pv/xpti = ("No"|{"dom0", "domU", "PCID-on"}) [w,X86,PV]