Re: [PATCH 02/10] docs/migration: Create index page

[Cédric Le Goater]

On 1/9/24 07:46, peterx@redhat.com wrote:
> From: Peter Xu <peterx@redhat.com>
>
> Create an index page for migration module.  Move VFIO migration there too.
> A trivial touch-up on the title to use lower case there.
>
> Since then we'll have "migration" as the top title, make the main doc file
> renamed to "migration framework".
>
> Cc: Alex Williamson <alex.williamson@redhat.com>
> Cc: Cédric Le Goater <clg@redhat.com>
> Signed-off-by: Peter Xu <peterx@redhat.com>


Reviewed-by: Cédric Le Goater <clg@redhat.com>

Thanks,

C.


> ---
>   docs/devel/index-internals.rst |  3 +--
>   docs/devel/migration/index.rst | 11 +++++++++++
>   docs/devel/migration/main.rst  |  6 +++---
>   docs/devel/migration/vfio.rst  |  2 +-
>   4 files changed, 16 insertions(+), 6 deletions(-)
>   create mode 100644 docs/devel/migration/index.rst
>
> diff --git a/docs/devel/index-internals.rst b/docs/devel/index-internals.rst
> index a41d62c1eb..5636e9cf1d 100644
> --- a/docs/devel/index-internals.rst
> +++ b/docs/devel/index-internals.rst
> @@ -11,13 +11,12 @@ Details about QEMU's various subsystems including how to 
> add features to them.
>      block-coroutine-wrapper
>      clocks
>      ebpf_rss
> -   migration/main
> +   migration/index
>      multi-process
>      reset
>      s390-cpu-topology
>      s390-dasd-ipl
>      tracing
> -   vfio-migration
>      vfio-iommufd
>      writing-monitor-commands
>      virtio-backends
> diff --git a/docs/devel/migration/index.rst b/docs/devel/migration/index.rst
> new file mode 100644
> index 0000000000..02cfdcc969
> --- /dev/null
> +++ b/docs/devel/migration/index.rst
> @@ -0,0 +1,11 @@
> +Migration
> +=========
> +
> +This is the main entry for QEMU migration documentations.  It explains how
> +QEMU live migration works.
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   main
> +   vfio
> diff --git a/docs/devel/migration/main.rst b/docs/devel/migration/main.rst
> index 95351ba51f..62bf027fb4 100644
> --- a/docs/devel/migration/main.rst
> +++ b/docs/devel/migration/main.rst
> @@ -1,6 +1,6 @@
> -=========
> -Migration
> -=========
> +===================
> +Migration framework
> +===================
>   
>   QEMU has code to load/save the state of the guest that it is running.
>   These are two complementary operations.  Saving the state just does
> diff --git a/docs/devel/migration/vfio.rst b/docs/devel/migration/vfio.rst
> index 605fe60e96..c49482eab6 100644
> --- a/docs/devel/migration/vfio.rst
> +++ b/docs/devel/migration/vfio.rst
> @@ -1,5 +1,5 @@
>   =====================
> -VFIO device Migration
> +VFIO device migration
>   =====================
>   
>   Migration of virtual machine involves saving the state for each device that