]> xenbits.xensource.com Git - xen.git/commitdiff
docs: workaround markdown parser error in xen-command-line.markdown
authorIan Campbell <ian.campbell@citrix.com>
Wed, 19 Nov 2014 10:42:18 +0000 (10:42 +0000)
committerIan Jackson <Ian.Jackson@eu.citrix.com>
Wed, 12 Aug 2015 10:47:38 +0000 (11:47 +0100)
Some versions of markdown (specifically the one in Debian Wheezy, currently
used to generate
http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html) seem to be
confused by nested lists in the middle of multi-paragraph parent list entries
as seen in the com1,com2 entry.

The effect is that the "Default" section of all following entries are replace
by some sort of hash or checksum (at least, a string of 32 random seeming hex
digits).

Workaround this issue by making the decriptions of the DPS options a nested
list, moving the existing nested list describing the options for S into a third
level list. This seems to avoid the issue, and is arguably better formatting in
its own right (at least its not a regression IMHO)

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>
(cherry picked from commit ae325e94d2076f3953824e069c062908221f7325)
(cherry picked from commit 3e9054c523ed089d04cf10b7f5b417240be85760)
(cherry picked from commit f558eb43bf6f381853ef010d2d7ba9327481d2de)

docs/misc/xen-command-line.markdown

index 7c46f91f6b4fa8862626b1091cf1a3d8fb5a4813..7a37dd8e8611ac4908f9d0526bff9652860a7cf4 100644 (file)
@@ -208,19 +208,14 @@ Both option `com1` and `com2` follow the same format.
 * Optionally, a clock speed measured in hz can be specified.
 * `DPS` represents the number of data bits, the parity, and the number
   of stop bits.
-
-  `D` is an integer between 5 and 8 for the number of data bits.
-
-  `P` is a single character representing the type of parity:
-
-   * `n` No
-   * `o` Odd
-   * `e` Even
-   * `m` Mark
-   * `s` Space
-
-  `S` is an integer 1 or 2 for the number of stop bits.
-
+  * `D` is an integer between 5 and 8 for the number of data bits.
+  * `P` is a single character representing the type of parity:
+      * `n` No
+      * `o` Odd
+      * `e` Even
+      * `m` Mark
+      * `s` Space
+  * `S` is an integer 1 or 2 for the number of stop bits.
 * `<io-base>` is an integer which specifies the IO base port for UART
   registers.
 * `<irq>` is the IRQ number to use, or `0` to use the UART in poll