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

[Andrew Cooper <andrew.cooper3@citrix.com>]

On 26/05/17 13:56, Juergen Gross wrote:
> Today only a few sysfs nodes under /sys/hypervisor/ are documented
> for Xen in Documentation/ABI/testing/sysfs-hypervisor-pmu.
>
> Add the remaining Xen sysfs nodes under /sys/hypervisor/ in a new
> file Documentation/ABI/stable/sysfs-hypervisor-xen and add the Xen
> specific sysfs docs to the MAINTAINERS file.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
> ---
> V2:
>   - rename file to Documentation/ABI/stable/sysfs-hypervisor-xen in
>     order to reflect Xen dependency
>   - leave pmu entries in old file under testing (Boris Ostrovsky)
> ---
>  Documentation/ABI/stable/sysfs-hypervisor-xen | 107 ++++++++++++++++++++++++++
>  MAINTAINERS                                   |   2 +
>  2 files changed, 109 insertions(+)
>  create mode 100644 Documentation/ABI/stable/sysfs-hypervisor-xen
>
> diff --git a/Documentation/ABI/stable/sysfs-hypervisor-xen b/Documentation/ABI/stable/sysfs-hypervisor-xen
> new file mode 100644
> index 000000000000..97e4171508c4
> --- /dev/null
> +++ b/Documentation/ABI/stable/sysfs-hypervisor-xen
> @@ -0,0 +1,107 @@
> +What:		/sys/hypervisor/compilation/compile_date
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@lists.xenproject.org
> +Description:	If running under Xen:
> +		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@lists.xenproject.org
> +Description:	If running under Xen:
> +		Contains information who built the Xen hypervisor
> +
> +What:		/sys/hypervisor/compilation/compiler
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@lists.xenproject.org
> +Description:	If running under Xen:
> +		Compiler which was used to build the Xen hypervisor
> +
> +What:		/sys/hypervisor/properties/capabilities
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@lists.xenproject.org
> +Description:	If running under Xen:
> +		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@lists.xenproject.org
> +Description:	If running under Xen:
> +		Changeset of the hypervisor (git commit)
> +
> +What:		/sys/hypervisor/properties/features
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@lists.xenproject.org
> +Description:	If running under Xen:
> +		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@lists.xenproject.org
> +Description:	If running under Xen:
> +		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@lists.xenproject.org
> +Description:	If running under Xen:
> +		Virtual address of the hypervisor as a hex value.

All properties above here, as well as "extra" below, may be deliberately
elided by Xen.  Is it perhaps worth having a general note to this effect
at the top of the file?

~Andrew