From: Paul Durrant <xadimgnik@gmail.com>
To: "'Juergen Gross'" <jgross@suse.com>, <xen-devel@lists.xenproject.org>
Cc: 'Stefano Stabellini' <sstabellini@kernel.org>,
'Julien Grall' <julien@xen.org>, 'Wei Liu' <wl@xen.org>,
'Andrew Cooper' <andrew.cooper3@citrix.com>,
'Ian Jackson' <ian.jackson@eu.citrix.com>,
'George Dunlap' <george.dunlap@citrix.com>,
'Jan Beulich' <jbeulich@suse.com>
Subject: RE: [PATCH] docs: specify stability of hypfs path documentation
Date: Mon, 13 Jul 2020 09:13:37 +0100 [thread overview]
Message-ID: <003b01d658ed$831ae680$8950b380$@xen.org> (raw)
In-Reply-To: <20200713051639.26948-1-jgross@suse.com>
> -----Original Message-----
> From: Juergen Gross <jgross@suse.com>
> Sent: 13 July 2020 06:17
> To: xen-devel@lists.xenproject.org
> Cc: paul@xen.org; Juergen Gross <jgross@suse.com>; Andrew Cooper <andrew.cooper3@citrix.com>; George
> Dunlap <george.dunlap@citrix.com>; Ian Jackson <ian.jackson@eu.citrix.com>; Jan Beulich
> <jbeulich@suse.com>; Julien Grall <julien@xen.org>; Stefano Stabellini <sstabellini@kernel.org>; Wei
> Liu <wl@xen.org>
> 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 <jgross@suse.com>
> ---
> 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 <paul@xen.org>
> ---
> 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
next prev parent reply other threads:[~2020-07-13 8:13 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-13 5:16 [PATCH] docs: specify stability of hypfs path documentation Juergen Gross
2020-07-13 7:56 ` Jan Beulich
2020-07-13 8:04 ` Jürgen Groß
2020-07-13 8:07 ` Jan Beulich
2020-07-13 8:14 ` Jürgen Groß
2020-07-13 8:13 ` Paul Durrant [this message]
2020-07-13 8:15 ` Jürgen Groß
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='003b01d658ed$831ae680$8950b380$@xen.org' \
--to=xadimgnik@gmail.com \
--cc=andrew.cooper3@citrix.com \
--cc=george.dunlap@citrix.com \
--cc=ian.jackson@eu.citrix.com \
--cc=jbeulich@suse.com \
--cc=jgross@suse.com \
--cc=julien@xen.org \
--cc=paul@xen.org \
--cc=sstabellini@kernel.org \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.