Re: [PATCH v9 14/15] docs: Add protvirt docs

[Peter Maydell]

On Wed, 11 Mar 2020 at 13:31, Janosch Frank <address@hidden> wrote:
>
> Lets add some documentation for the Protected VM functionality.
>
> Signed-off-by: Janosch Frank <address@hidden>
> ---
>  docs/system/index.rst    |  1 +
>  docs/system/protvirt.rst | 56 ++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 57 insertions(+)
>  create mode 100644 docs/system/protvirt.rst
>
> diff --git a/docs/system/index.rst b/docs/system/index.rst
> index 6e5f20fa1333ce23..74afbd7cc3fc0296 100644
> --- a/docs/system/index.rst
> +++ b/docs/system/index.rst
> @@ -34,3 +34,4 @@ Contents:
>     deprecated
>     build-platforms
>     license
> +   protvirt

The order of this list in index.rst determines the order
of the table of contents in the manual. Could you put
your new document at a reasonable place in the manual,
not just at the bottom of the list, please?

For something that is s390 specific, the ideal would
be to create a new docs/system/target-s390x.rst
which is then the place where all s390 docs can
hang off of. This is how we're handling various
other guest architecture docs. It doesn't all
have to go in a single page -- eg target-arm.rst
is an example of putting some sub-documents into
docs/system/arm/ and referring to them from
target-arm.rst.

thanks
-- PMM