Re: [PATCH v5 RFC 01/14] docs: libxc migration stream specification

[David Vrabel <david.vrabel@citrix.com>]

On 11/06/14 19:14, Andrew Cooper wrote:
> The pandoc markdown format is a superset of plain markdown, and while
> `markdown` is capable of making plausible documents from it, the results are
> not fantastic.
> 
> Differentiate the two via file extension to avoid running `markdown` on a
> pandoc document.
...
> +Image Header
> +------------
...
> +--------------------------------------------------------------------
> +Field       Description
> +----------- --------------------------------------------------------
> +marker      0xFFFFFFFFFFFFFFFF.
> +
> +id          0x58454E46 ("XENF" in ASCII).
> +
> +version     0x00000001.  The version of this specification.

Suggest version 2 here since that's what we've ended up calling it and
will reduce confusion if people mistakenly call the legacy format
"version 1".

At some point before the 4.5 release we'll want to update the version on
the title page to version 2 to match.

> +x86 PV Guest
> +------------
> +
> +An x86 PV guest image will have this order of records:
> +
> +1. Image header
> +2. Domain header
> +3. X86\_PV\_INFO record
> +4. Many PAGE\_DATA records
> +5. TSC\_INFO
> +6. X86\_PV\_P2M\_FRAMES record

This record is immediately after the X86_PV_INFO record and before the
PAGE_DATA records.

> +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

David