Re: [PATCH v3 1/4] doc,xen: document hypervisor sysfs nodes for xen

[Boris Ostrovsky]

+ Stefano for ARM.

On 06/12/2017 10:21 AM, 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@xxxxxxxx>
> ---
> V3:
>   - added hint for hidden values where appropriate (Andrew Cooper)
>
> 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 | 119 ++++++++++++++++++++++++++
>  MAINTAINERS                                   |   2 +
>  2 files changed, 121 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..e413154128b8
> --- /dev/null
> +++ b/Documentation/ABI/stable/sysfs-hypervisor-xen
> @@ -0,0 +1,119 @@
> +What:		/sys/hypervisor/compilation/compile_date
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		Contains the build time stamp of the Xen hypervisor
> +		Might return "<denied>" in case of special security settings
> +		in the hypervisor.
> +
> +What:		/sys/hypervisor/compilation/compiled_by
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		Contains information who built the Xen hypervisor
> +		Might return "<denied>" in case of special security settings
> +		in the hypervisor.
> +
> +What:		/sys/hypervisor/compilation/compiler
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		Compiler which was used to build the Xen hypervisor
> +		Might return "<denied>" in case of special security settings
> +		in the hypervisor.
> +
> +What:		/sys/hypervisor/properties/capabilities
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +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

s/full/fully/

Other than that

Reviewed-by: Boris Ostrovsky <boris.ostrovsky@xxxxxxxxxx>

-boris

> +			<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:	If running under Xen:
> +		Changeset of the hypervisor (git commit)
> +		Might return "<denied>" in case of special security settings
> +		in the hypervisor.
> +
> +What:		/sys/hypervisor/properties/features
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +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@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		Default page size of the hypervisor printed as a hex value.
> +		Might return "0" in case of special security settings
> +		in the hypervisor.
> +
> +What:		/sys/hypervisor/properties/virtual_start
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		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:	If running under Xen:
> +		Type of hypervisor:
> +		"xen": Xen hypervisor
> +
> +What:		/sys/hypervisor/uuid
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		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:	If running under Xen:
> +		The Xen version is in the format <major>.<minor><extra>
> +		This is the <extra> part of it.
> +		Might return "<denied>" in case of special security settings
> +		in the hypervisor.
> +
> +What:		/sys/hypervisor/version/major
> +Date:		March 2009
> +KernelVersion:	2.6.30
> +Contact:	xen-devel@xxxxxxxxxxxxxxxxxxxx
> +Description:	If running under Xen:
> +		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:	If running under Xen:
> +		The Xen version is in the format <major>.<minor><extra>
> +		This is the <minor> part of it.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 09b5ab6a8a5c..68c31aebb79c 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -13982,6 +13982,8 @@ F:	drivers/xen/
>  F:	arch/x86/include/asm/xen/
>  F:	include/xen/
>  F:	include/uapi/xen/
> +F:	Documentation/ABI/stable/sysfs-hypervisor-xen
> +F:	Documentation/ABI/testing/sysfs-hypervisor-pmu
>  
>  XEN HYPERVISOR ARM
>  M:	Stefano Stabellini <sstabellini@xxxxxxxxxx>