From: peterx@redhat.com
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Cc: peterx@redhat.com, "Fabiano Rosas" <farosas@suse.de>,
"Alex Williamson" <alex.williamson@redhat.com>,
"Cédric Le Goater" <clg@redhat.com>
Subject: [PULL 11/20] docs/migration: Create index page
Date: Tue, 16 Jan 2024 11:19:38 +0800 [thread overview]
Message-ID: <20240116031947.69017-12-peterx@redhat.com> (raw)
In-Reply-To: <20240116031947.69017-1-peterx@redhat.com>
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>
Reviewed-by: Cédric Le Goater <clg@redhat.com>
Link: https://lore.kernel.org/r/20240109064628.595453-3-peterx@redhat.com
Signed-off-by: Peter Xu <peterx@redhat.com>
---
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
--
2.43.0
next prev parent reply other threads:[~2024-01-16 3:22 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-16 3:19 [PULL 00/20] Migration 20240116 patches peterx
2024-01-16 3:19 ` [PULL 01/20] migration: Simplify initial conditionals in migration for better readability peterx
2024-01-16 3:19 ` [PULL 02/20] migration/multifd: Remove MultiFDPages_t::packet_num peterx
2024-01-16 3:19 ` [PULL 03/20] migration/multifd: Remove QEMUFile from where it is not needed peterx
2024-01-16 3:19 ` [PULL 04/20] migration/multifd: Change multifd_pages_init argument peterx
2024-01-16 3:19 ` [PULL 05/20] migration: Report error in incoming migration peterx
2024-01-16 3:19 ` [PULL 06/20] tests/qtest/migration: Print migration incoming errors peterx
2024-01-16 3:19 ` [PULL 07/20] tests/qtest/migration: Add a wrapper to print test names peterx
2024-01-16 3:19 ` [PULL 08/20] tests/qtest/migration: Use the new migration_test_add peterx
2024-01-16 3:19 ` [PULL 09/20] tests/qtest: Re-enable multifd cancel test peterx
2024-01-16 3:19 ` [PULL 10/20] docs/migration: Create migration/ directory peterx
2024-01-16 3:19 ` peterx [this message]
2024-01-16 3:19 ` [PULL 12/20] docs/migration: Convert virtio.txt into rST peterx
2024-01-16 3:19 ` [PULL 13/20] docs/migration: Split "Backwards compatibility" separately peterx
2024-01-16 3:19 ` [PULL 14/20] docs/migration: Split "Debugging" and "Firmware" peterx
2024-01-16 3:19 ` [PULL 15/20] docs/migration: Split "Postcopy" peterx
2024-01-16 3:19 ` [PULL 16/20] docs/migration: Split "dirty limit" peterx
2024-01-16 3:19 ` [PULL 17/20] docs/migration: Organize "Postcopy" page peterx
2024-01-16 3:19 ` [PULL 18/20] docs/migration: Further move vfio to be feature of migration peterx
2024-01-16 3:19 ` [PULL 19/20] docs/migration: Further move virtio " peterx
2024-01-16 3:19 ` [PULL 20/20] migration/rdma: define htonll/ntohll only if not predefined peterx
2024-01-16 16:33 ` [PULL 00/20] Migration 20240116 patches Peter Maydell
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=20240116031947.69017-12-peterx@redhat.com \
--to=peterx@redhat.com \
--cc=alex.williamson@redhat.com \
--cc=clg@redhat.com \
--cc=farosas@suse.de \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).