]> xenbits.xensource.com Git - xen.git/commitdiff
docs/misc: livepatch: Escape backslash
authorJulien Grall <julien@xen.org>
Mon, 13 Jan 2020 22:05:31 +0000 (22:05 +0000)
committerJulien Grall <julien@xen.org>
Tue, 14 Jan 2020 13:34:50 +0000 (13:34 +0000)
pandoc is currently failing to generate the pdf with the following
error:
! Undefined control sequence.
l.1048   metadata string format is: key=value\0

In this case, we want to print \0 so we need to backslash-escape the
first character.

Interestingly pandoc will not complain when creating html and will just
ignore \0 completely.

Fixes: 5083e0ff93 ("livepatch: Add metadata runtime retrieval mechanism")
Signed-off-by: Julien Grall <julien@xen.org>
Reviewed-by: Ross Lagerwall <ross.lagerwall@citrix.com>
Reviewed-by: Pawel Wieczorkiewicz <wipawel@amazon.de>
docs/misc/livepatch.pandoc

index 2f3f95ed3785c058fc7eb25defc8412b8cc25b8e..9473ad59917d6b404dc34cc7b6a07582a171c066 100644 (file)
@@ -739,7 +739,7 @@ The caller provides:
    Caller *MUST* allocate enough space to be able to store all received data
    (i.e. total allocated space *MUST* match the `metadata_total_size` value
    provided by the hypervisor). Individual payload metadata string can be of
-   arbitrary length. The metadata string format is: key=value\0...key=value\0.
+   arbitrary length. The metadata string format is: key=value\\0...key=value\\0.
  * `metadata_len` - Virtual address of where to write the length of each metadata
    string of the payload. Caller *MUST* allocate up to `nr` of them. Each *MUST*
    be of sizeof(uint32_t) (4 bytes).