docs/migration: Remove numbering for typical records
diff mbox series

Message ID 20191220172523.1359-1-andrew.cooper3@citrix.com
State New
Headers show
Series
  • docs/migration: Remove numbering for typical records
Related show

Commit Message

Andrew Cooper Dec. 20, 2019, 5:25 p.m. UTC
The numbers aren't referenced directly, and explicit numbering makes an
unnecesserily large diff when inserting something new in the middle.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@eu.citrix.com>
CC: Ian Jackson <ian.jackson@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Wei Liu <wl@xen.org>
CC: Julien Grall <julien@xen.org>
---
 docs/specs/libxc-migration-stream.pandoc | 46 ++++++++++++++++----------------
 1 file changed, 23 insertions(+), 23 deletions(-)

Comments

Ian Jackson Dec. 20, 2019, 6:22 p.m. UTC | #1
Andrew Cooper writes ("[PATCH] docs/migration: Remove numbering for typical records"):
> The numbers aren't referenced directly, and explicit numbering makes an
> unnecesserily large diff when inserting something new in the middle.

Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>

Patch
diff mbox series

diff --git a/docs/specs/libxc-migration-stream.pandoc b/docs/specs/libxc-migration-stream.pandoc
index 97dacb6e30..a365dba0c8 100644
--- a/docs/specs/libxc-migration-stream.pandoc
+++ b/docs/specs/libxc-migration-stream.pandoc
@@ -641,40 +641,40 @@  x86 PV Guest
 
 A typical save record for an x86 PV guest image would look like:
 
-1. Image header
-2. Domain header
-3. X86_PV_INFO record
-4. X86_PV_P2M_FRAMES record
-5. Many PAGE_DATA records
-6. TSC_INFO
-7. SHARED_INFO record
-8. VCPU context records for each online VCPU
-    a. X86_PV_VCPU_BASIC record
-    b. X86_PV_VCPU_EXTENDED record
-    c. X86_PV_VCPU_XSAVE record
-    d. X86_PV_VCPU_MSRS record
-9. END record
+* Image header
+* Domain header
+* X86_PV_INFO record
+* X86_PV_P2M_FRAMES record
+* Many PAGE_DATA records
+* TSC_INFO
+* SHARED_INFO record
+* VCPU context records for each online VCPU
+    * X86_PV_VCPU_BASIC record
+    * X86_PV_VCPU_EXTENDED record
+    * X86_PV_VCPU_XSAVE record
+    * X86_PV_VCPU_MSRS record
+* END record
 
 There are some strict ordering requirements.  The following records must
 be present in the following order as each of them depends on information
 present in the preceding ones.
 
-1. X86_PV_INFO record
-2. X86_PV_P2M_FRAMES record
-3. PAGE_DATA records
-4. VCPU records
+* X86_PV_INFO record
+* X86_PV_P2M_FRAMES record
+* PAGE_DATA records
+* VCPU records
 
 x86 HVM Guest
 -------------
 
 A typical save record for an x86 HVM guest image would look like:
 
-1. Image header
-2. Domain header
-3. Many PAGE_DATA records
-4. TSC_INFO
-5. HVM_PARAMS
-6. HVM_CONTEXT
+* Image header
+* Domain header
+* Many PAGE_DATA records
+* TSC_INFO
+* HVM_PARAMS
+* HVM_CONTEXT
 
 HVM_PARAMS must precede HVM_CONTEXT, as certain parameters can affect
 the validity of architectural state in the context.