[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/20] docs/migration: Create index page
|
From: |
peterx |
|
Subject: |
[PULL 11/20] docs/migration: Create index page |
|
Date: |
Tue, 16 Jan 2024 11:19:38 +0800 |
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: 20240109064628.595453-3-peterx@redhat.com">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
- [PULL 00/20] Migration 20240116 patches, peterx, 2024/01/15
- [PULL 01/20] migration: Simplify initial conditionals in migration for better readability, peterx, 2024/01/15
- [PULL 02/20] migration/multifd: Remove MultiFDPages_t::packet_num, peterx, 2024/01/15
- [PULL 04/20] migration/multifd: Change multifd_pages_init argument, peterx, 2024/01/15
- [PULL 09/20] tests/qtest: Re-enable multifd cancel test, peterx, 2024/01/15
- [PULL 03/20] migration/multifd: Remove QEMUFile from where it is not needed, peterx, 2024/01/15
- [PULL 06/20] tests/qtest/migration: Print migration incoming errors, peterx, 2024/01/15
- [PULL 07/20] tests/qtest/migration: Add a wrapper to print test names, peterx, 2024/01/15
- [PULL 08/20] tests/qtest/migration: Use the new migration_test_add, peterx, 2024/01/15
- [PULL 10/20] docs/migration: Create migration/ directory, peterx, 2024/01/15
- [PULL 11/20] docs/migration: Create index page,
peterx <=
- [PULL 12/20] docs/migration: Convert virtio.txt into rST, peterx, 2024/01/15
- [PULL 14/20] docs/migration: Split "Debugging" and "Firmware", peterx, 2024/01/15
- [PULL 13/20] docs/migration: Split "Backwards compatibility" separately, peterx, 2024/01/15
- [PULL 15/20] docs/migration: Split "Postcopy", peterx, 2024/01/15
- [PULL 17/20] docs/migration: Organize "Postcopy" page, peterx, 2024/01/15
- [PULL 16/20] docs/migration: Split "dirty limit", peterx, 2024/01/15
- [PULL 19/20] docs/migration: Further move virtio to be feature of migration, peterx, 2024/01/15
- [PULL 18/20] docs/migration: Further move vfio to be feature of migration, peterx, 2024/01/15
- [PULL 20/20] migration/rdma: define htonll/ntohll only if not predefined, peterx, 2024/01/15
- [PULL 05/20] migration: Report error in incoming migration, peterx, 2024/01/15