[PULL,01/25] docs/devel/migration.rst: Document the file transport

Commit Message

Peter Xu Feb. 28, 2024, 5:12 a.m. UTC

From: Fabiano Rosas <[e-mail]>

When adding the support for file migration with the file: transport,
we missed adding documentation for it.

Signed-off-by: Fabiano Rosas <[e-mail]>
Reviewed-by: Peter Xu <[e-mail]>
Link: https://lore.kernel.org/r/[e-mail]
Signed-off-by: Peter Xu <[e-mail]>
---
 docs/devel/migration/main.rst | 4 ++++
 1 file changed, 4 insertions(+)

Patch

diff --git a/docs/devel/migration/main.rst b/docs/devel/migration/main.rst
index 331252a92c..8024275d6d 100644
--- a/docs/devel/migration/main.rst
+++ b/docs/devel/migration/main.rst
@@ -41,6 +41,10 @@  over any transport.
 - exec migration: do the migration using the stdin/stdout through a process.
 - fd migration: do the migration using a file descriptor that is
   passed to QEMU.  QEMU doesn't care how this file descriptor is opened.
+- file migration: do the migration using a file that is passed to QEMU
+  by path. A file offset option is supported to allow a management
+  application to add its own metadata to the start of the file without
+  QEMU interference.
 
 In addition, support is included for migration using RDMA, which
 transports the page data using ``RDMA``, where the hardware takes care of