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>
Cc: Pawel Wieczorkiewicz <wipawel@amazon.de>
---
 docs/misc/livepatch.pandoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/misc/livepatch.pandoc b/docs/misc/livepatch.pandoc
index 2f3f95ed37..9473ad5991 100644
--- a/docs/misc/livepatch.pandoc
+++ b/docs/misc/livepatch.pandoc
@@ -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).
-- 
2.17.1


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

On 1/13/20 10:12 PM, Julien Grall wrote:
> 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>
> Cc: Pawel Wieczorkiewicz <wipawel@amazon.de>
> ---
>  docs/misc/livepatch.pandoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/misc/livepatch.pandoc b/docs/misc/livepatch.pandoc
> index 2f3f95ed37..9473ad5991 100644
> --- a/docs/misc/livepatch.pandoc
> +++ b/docs/misc/livepatch.pandoc
> @@ -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).
> 

Reviewed-by: Ross Lagerwall <ross.lagerwall@citrix.com>

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel