From f1cf75c2d18fcfc96744ef0380a757e8f91705a6 Mon Sep 17 00:00:00 2001 From: Julien Grall Date: Mon, 13 Jan 2020 22:05:31 +0000 Subject: [PATCH] docs/misc: livepatch: Escape backslash 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 Reviewed-by: Ross Lagerwall Reviewed-by: Pawel Wieczorkiewicz --- 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.39.5