[Xen-devel] [PATCH 1/2] doc, xen: document hypervisor sysfs nodes for xen

[Juergen Gross <jgross@xxxxxxxx>]

Today only a few sysfs nodes under /sys/hypervisor/ are documented
for Xen in Documentation/ABI/testing/sysfs-hypervisor-pmu. Rename
this file to Documentation/ABI/testing/sysfs-hypervisor and add
descriptions of the other nodes.

Signed-off-by: Juergen Gross <jgross@xxxxxxxx>
---
 Documentation/ABI/testing/sysfs-hypervisor     | 131 +++++++++++++++++++++++++
 Documentation/ABI/testing/sysfs-hypervisor-pmu |  23 -----
 MAINTAINERS                                    |   1 +
 3 files changed, 132 insertions(+), 23 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-hypervisor
 delete mode 100644 Documentation/ABI/testing/sysfs-hypervisor-pmu

diff --git a/Documentation/ABI/testing/sysfs-hypervisor 
b/Documentation/ABI/testing/sysfs-hypervisor
new file mode 100644
index 000000000000..443196f0aa1c
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-hypervisor
@@ -0,0 +1,131 @@
+What:          /sys/hypervisor/compilation/compile_date
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Contains the build time stamp of the Xen hypervisor
+
+What:          /sys/hypervisor/compilation/compiled_by
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Contains information who built the Xen hypervisor
+
+What:          /sys/hypervisor/compilation/compiler
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Compiler which was used to build the Xen hypervisor
+
+What:          /sys/hypervisor/pmu/pmu_mode
+Date:          August 2015
+KernelVersion: 4.3
+Contact:       Boris Ostrovsky <boris.ostrovsky@xxxxxxxxxx>
+Description:
+               Describes mode that Xen's performance-monitoring unit (PMU)
+               uses. Accepted values are
+                       "off"  -- PMU is disabled
+                       "self" -- The guest can profile itself
+                       "hv"   -- The guest can profile itself and, if it is
+                                 privileged (e.g. dom0), the hypervisor
+                       "all" --  The guest can profile itself, the hypervisor
+                                 and all other guests. Only available to
+                                 privileged guests.
+
+What:           /sys/hypervisor/pmu/pmu_features
+Date:           August 2015
+KernelVersion:  4.3
+Contact:        Boris Ostrovsky <boris.ostrovsky@xxxxxxxxxx>
+Description:
+               Describes Xen PMU features (as an integer). A set bit indicates
+               that the corresponding feature is enabled. See
+               include/xen/interface/xenpmu.h for available features
+
+What:          /sys/hypervisor/properties/capabilities
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Space separated list of supported guest system types. Each type
+               is in the format: <class>-<major>.<minor>-<arch>
+               With:
+                       <class>: "xen" -- x86: paravirtualized, arm: standard
+                                "hvm" -- x86 only: full virtualized
+                       <major>: major guest interface version
+                       <minor>: minor guest interface version
+                       <arch>:  architecture, e.g.:
+                                "x86_32": 32 bit x86 guest without PAE
+                                "x86_32p": 32 bit x86 guest with PAE
+                                "x86_64": 64 bit x86 guest
+                                "armv7l": 32 bit arm guest
+                                "aarch64": 64 bit arm guest
+
+What:          /sys/hypervisor/properties/changeset
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Changeset of the hypervisor (git commit)
+
+What:          /sys/hypervisor/properties/features
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Features the Xen hypervisor supports for the guest as defined
+               in include/xen/interface/features.h printed as a hex value.
+
+What:          /sys/hypervisor/properties/pagesize
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Default page size of the hypervisor printed as a hex value.
+
+What:          /sys/hypervisor/properties/virtual_start
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Virtual address of the hypervisor as a hex value.
+
+What:          /sys/hypervisor/type
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               Type of hypervisor:
+               "xen": Xen hypervisor
+
+What:          /sys/hypervisor/uuid
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               UUID of the guest as known to the Xen hypervisor.
+
+What:          /sys/hypervisor/version/extra
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               The Xen version is in the format <major>.<minor><extra>
+               This is the <extra> part of it.
+
+What:          /sys/hypervisor/version/major
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               The Xen version is in the format <major>.<minor><extra>
+               This is the <major> part of it.
+
+What:          /sys/hypervisor/version/minor
+Date:          March 2009
+KernelVersion: 2.6.30
+Contact:       xen-devel@xxxxxxxxxxxxxxxxxxxx
+Description:
+               The Xen version is in the format <major>.<minor><extra>
+               This is the <minor> part of it.
diff --git a/Documentation/ABI/testing/sysfs-hypervisor-pmu 
b/Documentation/ABI/testing/sysfs-hypervisor-pmu
deleted file mode 100644
index 224faa105e18..000000000000
--- a/Documentation/ABI/testing/sysfs-hypervisor-pmu
+++ /dev/null
@@ -1,23 +0,0 @@
-What:          /sys/hypervisor/pmu/pmu_mode
-Date:          August 2015
-KernelVersion: 4.3
-Contact:       Boris Ostrovsky <boris.ostrovsky@xxxxxxxxxx>
-Description:
-               Describes mode that Xen's performance-monitoring unit (PMU)
-               uses. Accepted values are
-                       "off"  -- PMU is disabled
-                       "self" -- The guest can profile itself
-                       "hv"   -- The guest can profile itself and, if it is
-                                 privileged (e.g. dom0), the hypervisor
-                       "all" --  The guest can profile itself, the hypervisor
-                                 and all other guests. Only available to
-                                 privileged guests.
-
-What:           /sys/hypervisor/pmu/pmu_features
-Date:           August 2015
-KernelVersion:  4.3
-Contact:        Boris Ostrovsky <boris.ostrovsky@xxxxxxxxxx>
-Description:
-               Describes Xen PMU features (as an integer). A set bit indicates
-               that the corresponding feature is enabled. See
-               include/xen/interface/xenpmu.h for available features
diff --git a/MAINTAINERS b/MAINTAINERS
index 503bcf4e3e8f..a5d2af148798 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -13976,6 +13976,7 @@ F:      drivers/xen/
 F:     arch/x86/include/asm/xen/
 F:     include/xen/
 F:     include/uapi/xen/
+F:     Documentation/ABI/testing/sysfs-hypervisor
 
 XEN HYPERVISOR ARM
 M:     Stefano Stabellini <sstabellini@xxxxxxxxxx>
-- 
2.12.0


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
https://lists.xen.org/xen-devel