docs/misc: livepatch: Espace backslash
diff mbox series

Message ID 20200113221227.20857-1-julien@xen.org
State New
Headers show
Series
  • docs/misc: livepatch: Espace backslash
Related show

Commit Message

Julien Grall Jan. 13, 2020, 10:12 p.m. UTC
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(-)

Comments

Wieczorkiewicz, Pawel Jan. 14, 2020, 8:40 a.m. UTC | #1
> On 13. Jan 2020, at 23:12, Julien Grall <julien@xen.org> 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).
> -- 
> 2.17.1
> 


Sorry for yet another problem...

Reviewed-by: Pawel Wieczorkiewicz <wipawel@amazon.de>







Amazon Development Center Germany GmbH
Krausenstr. 38
10117 Berlin
Geschaeftsfuehrung: Christian Schlaeger, Jonathan Weiss
Eingetragen am Amtsgericht Charlottenburg unter HRB 149173 B
Sitz: Berlin
Ust-ID: DE 289 237 879
Ross Lagerwall Jan. 14, 2020, 9:23 a.m. UTC | #2
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>
Durrant, Paul Jan. 14, 2020, 9:53 a.m. UTC | #3
> -----Original Message-----
> From: Xen-devel <xen-devel-bounces@lists.xenproject.org> On Behalf Of
> Julien Grall
> Sent: 13 January 2020 23:12
> To: xen-devel@lists.xenproject.org
> Cc: Ross Lagerwall <ross.lagerwall@citrix.com>; Wieczorkiewicz, Pawel
> <wipawel@amazon.de>; Julien Grall <julien@xen.org>; Konrad Rzeszutek
Wilk
> <konrad.wilk@oracle.com>
> Subject: [Xen-devel] [PATCH] docs/misc: livepatch: Espace backslash
>

s/Espace/Escape, I assume

  Paul
Julien Grall Jan. 14, 2020, 1:29 p.m. UTC | #4
Hi Paul,

On 14/01/2020 09:53, Durrant, Paul wrote:
>> -----Original Message-----
>> From: Xen-devel <xen-devel-bounces@lists.xenproject.org> On Behalf Of
>> Julien Grall
>> Sent: 13 January 2020 23:12
>> To: xen-devel@lists.xenproject.org
>> Cc: Ross Lagerwall <ross.lagerwall@citrix.com>; Wieczorkiewicz, Pawel
>> <wipawel@amazon.de>; Julien Grall <julien@xen.org>; Konrad Rzeszutek
> Wilk
>> <konrad.wilk@oracle.com>
>> Subject: [Xen-devel] [PATCH] docs/misc: livepatch: Espace backslash
>>
> 
> s/Espace/Escape, I assume

Hmm, yes. Thank you for spotting it!

Cheers,

Patch
diff mbox series

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).