From: "Jan Beulich" <JBeulich@suse.com>
To: Andrew Cooper <andrew.cooper3@citrix.com>
Cc: Juergen Gross <jgross@suse.com>,
Stefano Stabellini <sstabellini@kernel.org>,
Wei Liu <wei.liu2@citrix.com>,
Xen-devel <xen-devel@lists.xen.org>,
Julien Grall <julien.grall@arm.com>,
Roger Pau Monne <roger.pau@citrix.com>
Subject: Re: [PATCH v3 1/7] docs: Improve documentation for dom0= and dom0-iommu=
Date: Wed, 16 Jan 2019 04:52:29 -0700 [thread overview]
Message-ID: <5C3F1AFD020000780020E417@prv1-mh.provo.novell.com> (raw)
In-Reply-To: <1547629250-1405-2-git-send-email-andrew.cooper3@citrix.com>
>>> On 16.01.19 at 10:00, <andrew.cooper3@citrix.com> wrote:
> --- a/docs/misc/xen-command-line.pandoc
> +++ b/docs/misc/xen-command-line.pandoc
> @@ -636,61 +636,83 @@ trace feature is only enabled in debugging builds of Xen.
>
> Specify the bit width of the DMA heap.
>
> -### dom0 (x86)
> -> `= List of [ pvh | shadow | verbose ]`
> +### dom0
> + = List of [ pvh=<bool>, shadow=<bool>, verbose=<bool> ]
>
> -> Sub-options:
> + Applicability: x86
>
> -> `pvh`
> +Controls for how dom0 is constructed on x86 systems.
>
> -> Default: `false`
> +* The `pvh` boolean controls whether dom0 is constructed as a PV or a PVH
> + guest. The default is PV. In addition, the following requirements must
> + be met:
>
> -Flag that makes a dom0 boot in PVHv2 mode.
> + * The dom0 kernel selected by the boot loader must be capable of the
> + selected mode.
> + * For a PV dom0, Xen must have been compiled with `CONFIG_PV` enabled.
> + * For a PVH dom0, Xen must have been compiled with `CONFIG_HVM` enabled,
> + and the hardware must have VT-x/SVM extensions available.
>
> -> `shadow`
> +* The `shadow` boolean is only applicable when dom0 is constructed as a PVH
> + guest, and controls whether dom0 uses hardware assisted paging, or shadow
> + paging. The default is HAP when available, and shadow otherwise.
>
> -> Default: `false`
> + This option is unavailable when `CONFIG_SHADOW_PAGING` is compiled out. A
> + PVH dom0 cannot be used if `CONFIG_SHADOW_PAGING` is compiled out, and the
> + hardware is not HAP-capable.
As mentioned elsewhere, I object to adding CONFIG_* into this doc,
which is intended to be meaningful to non-developers. But not to the
degree of NAK-ing the whole thing, if everyone else disagrees with me.
Jan
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
next prev parent reply other threads:[~2019-01-16 11:52 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-16 9:00 [PATCH v3 for-4.12 0/7] Docs improvements, and dom0 construction fixes Andrew Cooper
2019-01-16 9:00 ` [PATCH v3 1/7] docs: Improve documentation for dom0= and dom0-iommu= Andrew Cooper
2019-01-16 10:53 ` Roger Pau Monné
2019-01-16 19:54 ` Andrew Cooper
2019-01-16 11:52 ` Jan Beulich [this message]
2019-01-16 19:51 ` Andrew Cooper
2019-01-17 8:43 ` Roger Pau Monné
2019-01-17 9:08 ` Andrew Cooper
2019-01-17 9:14 ` Juergen Gross
2019-01-17 11:59 ` Jan Beulich
2019-01-17 12:11 ` Andrew Cooper
2019-01-17 11:20 ` Jan Beulich
2019-01-17 12:15 ` Andrew Cooper
2019-01-17 12:26 ` Jan Beulich
2019-01-21 17:24 ` Andrew Cooper
2019-01-16 9:00 ` [PATCH v3 2/7] docs: Improve documentation and parsing for iommu= Andrew Cooper
2019-01-16 11:06 ` Roger Pau Monné
2019-01-21 17:30 ` Andrew Cooper
2019-01-16 13:47 ` Jan Beulich
2019-01-16 9:00 ` [PATCH v3 3/7] docs: Improve documentation and parsing for pci= Andrew Cooper
2019-01-16 11:08 ` Roger Pau Monné
2019-01-16 13:52 ` Jan Beulich
2019-01-16 9:00 ` [PATCH v3 4/7] docs: Improve documentation and parsing for efi= Andrew Cooper
2019-01-16 14:00 ` Jan Beulich
2019-01-16 9:00 ` [PATCH v3 5/7] x86/dom0: Improve dom0= useability Andrew Cooper
2019-01-16 11:13 ` Roger Pau Monné
2019-01-16 14:08 ` Jan Beulich
2019-01-16 19:58 ` Andrew Cooper
2019-01-17 11:21 ` Jan Beulich
2019-01-16 9:00 ` [PATCH v3 6/7] xen/dom0: Drop iommu_hwdom_inclusive entirely Andrew Cooper
2019-01-16 11:24 ` Roger Pau Monné
2019-01-17 13:32 ` Jan Beulich
2019-01-17 14:51 ` Roger Pau Monné
2019-01-16 9:00 ` [PATCH v3 7/7] xen/dom0: Add a dom0-iommu=none option Andrew Cooper
2019-01-16 11:32 ` Roger Pau Monné
2019-01-17 10:55 ` Wei Liu
2019-01-17 13:35 ` Jan Beulich
2019-01-21 18:08 ` Andrew Cooper
2019-01-22 8:06 ` Jan Beulich
2019-01-22 13:42 ` Andrew Cooper
2019-01-16 11:38 ` [PATCH v3 for-4.12 0/7] Docs improvements, and dom0 construction fixes Juergen Gross
2019-01-17 12:08 [PATCH v3 1/7] docs: Improve documentation for dom0= and dom0-iommu= Juergen Gross
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=5C3F1AFD020000780020E417@prv1-mh.provo.novell.com \
--to=jbeulich@suse.com \
--cc=andrew.cooper3@citrix.com \
--cc=jgross@suse.com \
--cc=julien.grall@arm.com \
--cc=roger.pau@citrix.com \
--cc=sstabellini@kernel.org \
--cc=wei.liu2@citrix.com \
--cc=xen-devel@lists.xen.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.