]> xenbits.xensource.com Git - xen.git/commitdiff
docs/xsplice: Fix syntax when compiling to pdf with pandoc
authorAndrew Cooper <andrew.cooper3@citrix.com>
Sun, 15 May 2016 13:09:30 +0000 (14:09 +0100)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 23 May 2016 10:22:45 +0000 (11:22 +0100)
Pandoc (version 1.12.4.2 from Debian Jessie) complains at the embedded \n in
the signature checking paragraph.

  /usr/bin/pandoc --number-sections --toc --standalone misc/xsplice.markdown
    --output pdf/misc/xsplice.pdf
  ! Undefined control sequence.
  l.1085 appended\textasciitilde{}\n

Surround the string in backticks to make it verbatim text.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Reviewed-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Release-acked-by: Wei Liu <wei.liu2@citrix.com>
docs/misc/xsplice.markdown

index 4a98be18032d3c417537e96f97f9ed4726edd308..05c1a55feb5b8cbe094e1a55190e02e67aa92fd9 100644 (file)
@@ -1007,7 +1007,7 @@ expecting such that it can properly do signature verification.
 
 The signature is based on the all of the payloads continuously laid out
 in memory. The signature is to be appended at the end of the ELF payload
-prefixed with the string '~Module signature appended~\n', followed by
+prefixed with the string `'~Module signature appended~\n'`, followed by
 an signature header then followed by the signature, key identifier, and signers
 name.