[PATCH 2/7] docs: move notes inside the body of the document

Paolo Bonzini posted 7 patches 4 years, 4 months ago
[PATCH 2/7] docs: move notes inside the body of the document
Posted by Paolo Bonzini 4 years, 4 months ago
Make all documents start with a heading.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/devel/multi-process.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/docs/devel/multi-process.rst b/docs/devel/multi-process.rst
index 69699329d6..e5758a79ab 100644
--- a/docs/devel/multi-process.rst
+++ b/docs/devel/multi-process.rst
@@ -1,15 +1,17 @@
-This is the design document for multi-process QEMU. It does not
-necessarily reflect the status of the current implementation, which
-may lack features or be considerably different from what is described
-in this document. This document is still useful as a description of
-the goals and general direction of this feature.
-
-Please refer to the following wiki for latest details:
-https://wiki.qemu.org/Features/MultiProcessQEMU
-
 Multi-process QEMU
 ===================
 
+.. note::
+
+  This is the design document for multi-process QEMU. It does not
+  necessarily reflect the status of the current implementation, which
+  may lack features or be considerably different from what is described
+  in this document. This document is still useful as a description of
+  the goals and general direction of this feature.
+
+  Please refer to the following wiki for latest details:
+  https://wiki.qemu.org/Features/MultiProcessQEMU
+
 QEMU is often used as the hypervisor for virtual machines running in the
 Oracle cloud. Since one of the advantages of cloud computing is the
 ability to run many VMs from different tenants in the same cloud
-- 
2.31.1



Re: [PATCH 2/7] docs: move notes inside the body of the document
Posted by Peter Maydell 4 years, 4 months ago
On Thu, 30 Sept 2021 at 14:33, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Make all documents start with a heading.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  docs/devel/multi-process.rst | 20 +++++++++++---------
>  1 file changed, 11 insertions(+), 9 deletions(-)
>
> diff --git a/docs/devel/multi-process.rst b/docs/devel/multi-process.rst
> index 69699329d6..e5758a79ab 100644
> --- a/docs/devel/multi-process.rst
> +++ b/docs/devel/multi-process.rst
> @@ -1,15 +1,17 @@
> -This is the design document for multi-process QEMU. It does not
> -necessarily reflect the status of the current implementation, which
> -may lack features or be considerably different from what is described
> -in this document. This document is still useful as a description of
> -the goals and general direction of this feature.
> -
> -Please refer to the following wiki for latest details:
> -https://wiki.qemu.org/Features/MultiProcessQEMU
> -
>  Multi-process QEMU
>  ===================
>
> +.. note::
> +
> +  This is the design document for multi-process QEMU. It does not
> +  necessarily reflect the status of the current implementation, which
> +  may lack features or be considerably different from what is described
> +  in this document. This document is still useful as a description of
> +  the goals and general direction of this feature.
> +
> +  Please refer to the following wiki for latest details:
> +  https://wiki.qemu.org/Features/MultiProcessQEMU
> +
>  QEMU is often used as the hypervisor for virtual machines running in the
>  Oracle cloud. Since one of the advantages of cloud computing is the
>  ability to run many VMs from different tenants in the same cloud

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

(side note, the wiki page was last updated in August 2020, which
suggests maybe it's not that useful to refer people to it.)

thanks
-- PMM