[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-changelog] [xen master] docs: workaround markdown parser error in xen-command-line.markdown



commit ae325e94d2076f3953824e069c062908221f7325
Author:     Ian Campbell <ian.campbell@xxxxxxxxxx>
AuthorDate: Wed Nov 19 10:42:18 2014 +0000
Commit:     Ian Campbell <ian.campbell@xxxxxxxxxx>
CommitDate: Thu Nov 20 15:36:54 2014 +0000

    docs: workaround markdown parser error in xen-command-line.markdown
    
    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@xxxxxxxxxx>
    Reviewed-by: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
---
 docs/misc/xen-command-line.markdown |   21 ++++++++-------------
 1 files changed, 8 insertions(+), 13 deletions(-)

diff --git a/docs/misc/xen-command-line.markdown 
b/docs/misc/xen-command-line.markdown
index 0830e5f..b7eaeea 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -247,19 +247,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
--
generated by git-patchbot for /home/xen/git/xen.git#master

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog


 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.