> -----Original Message----- > From: Juergen Gross <[email protected]> > Sent: 13 July 2020 06:17 > To: [email protected] > Cc: [email protected]; Juergen Gross <[email protected]>; Andrew Cooper > <[email protected]>; George > Dunlap <[email protected]>; Ian Jackson <[email protected]>; > Jan Beulich > <[email protected]>; Julien Grall <[email protected]>; Stefano Stabellini > <[email protected]>; Wei > Liu <[email protected]> > Subject: [PATCH] docs: specify stability of hypfs path documentation > > 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 <[email protected]> > --- > This might be a candidate for 4.14, as hypfs is new in 4.14 and the > documentation should be as clear as possible.
Agreed. Since this a pure documentation change it carries no risk, so once the final wording is agreed then consider it... Release-acked-by: Paul Durrant <[email protected]> > --- > 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..7ad4b7ba95 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. > > +Path availability is subject to change, e.g. a specific path specified > +for a single architecture now might be made available for other architectures > +in future, or it could be made conditional by an additional config option > +of the hypervisor. > + > So an entry could look like this: > > /cpu-bugs/active-pv/xpti = ("No"|{"dom0", "domU", "PCID-on"}) [w,X86,PV] > -- > 2.26.2
