* Strangeness in generated xen-command-line.html
@ 2014-11-19 10:12 Ian Campbell
2014-11-19 10:21 ` Ian Campbell
2014-11-19 10:24 ` Andrew Cooper
0 siblings, 2 replies; 12+ messages in thread
From: Ian Campbell @ 2014-11-19 10:12 UTC (permalink / raw)
To: xen-devel; +Cc: Andrew Cooper
http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html has a
bunch of random sha id's in it, where the 4.4-testing version does not.
They seem to have replaced the various
`= <boolean>`
Default: `true`
Bits.
Andy, Any thoughts or should I investigate?
I don't see anything since 4.4 touching the html generation itself (we
added pandoc for pdf but didn't touch HTML afaict).
Ian.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:12 Strangeness in generated xen-command-line.html Ian Campbell
@ 2014-11-19 10:21 ` Ian Campbell
2014-11-19 10:24 ` Andrew Cooper
1 sibling, 0 replies; 12+ messages in thread
From: Ian Campbell @ 2014-11-19 10:21 UTC (permalink / raw)
To: xen-devel; +Cc: Andrew Cooper
On Wed, 2014-11-19 at 10:12 +0000, Ian Campbell wrote:
> http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html has a
> bunch of random sha id's in it, where the 4.4-testing version does not.
>
> They seem to have replaced the various
> `= <boolean>`
>
> Default: `true`
>
> Bits.
>
> Andy, Any thoughts or should I investigate?
>
> I don't see anything since 4.4 touching the html generation itself (we
> added pandoc for pdf but didn't touch HTML afaict).
FWIW it seems to happen from the conring_size entry onwards, The
"com1,com2" and earlier are OK. I can't see anything about thecom1,com2
entry which would be causing this...
>
> Ian.
>
>
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xen.org
> http://lists.xen.org/xen-devel
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:12 Strangeness in generated xen-command-line.html Ian Campbell
2014-11-19 10:21 ` Ian Campbell
@ 2014-11-19 10:24 ` Andrew Cooper
2014-11-19 10:30 ` Ian Campbell
1 sibling, 1 reply; 12+ messages in thread
From: Andrew Cooper @ 2014-11-19 10:24 UTC (permalink / raw)
To: Ian Campbell, xen-devel
On 19/11/14 10:12, Ian Campbell wrote:
> http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html has a
> bunch of random sha id's in it, where the 4.4-testing version does not.
>
> They seem to have replaced the various
> `= <boolean>`
>
> Default: `true`
>
> Bits.
>
> Andy, Any thoughts or should I investigate?
>
> I don't see anything since 4.4 touching the html generation itself (we
> added pandoc for pdf but didn't touch HTML afaict).
>
> Ian.
>
I have looked into it before but didn't get very far. I suspect it
might be a bug in wheezy's markdown. It doesn't reproduce when building
using other versions of markdown.
I had planned (given some non-existent free time) to see about
converting it from markdown to pandoc which has leads to a far more
nicely formatted document.
~Andrew
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:24 ` Andrew Cooper
@ 2014-11-19 10:30 ` Ian Campbell
2014-11-19 10:37 ` Andrew Cooper
0 siblings, 1 reply; 12+ messages in thread
From: Ian Campbell @ 2014-11-19 10:30 UTC (permalink / raw)
To: Andrew Cooper; +Cc: xen-devel
On Wed, 2014-11-19 at 10:24 +0000, Andrew Cooper wrote:
> On 19/11/14 10:12, Ian Campbell wrote:
> > http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html has a
> > bunch of random sha id's in it, where the 4.4-testing version does not.
> >
> > They seem to have replaced the various
> > `= <boolean>`
> >
> > Default: `true`
> >
> > Bits.
> >
> > Andy, Any thoughts or should I investigate?
> >
> > I don't see anything since 4.4 touching the html generation itself (we
> > added pandoc for pdf but didn't touch HTML afaict).
> >
> > Ian.
> >
>
> I have looked into it before but didn't get very far. I suspect it
> might be a bug in wheezy's markdown. It doesn't reproduce when building
> using other versions of markdown.
Right.
It seems to be triggered by the line:
`S` is an integer 1 or 2 for the number of stop bits.
just removing that makes the issue go away. It's not the `s since
removing just those retains the issue. WTAF!
Ian.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:30 ` Ian Campbell
@ 2014-11-19 10:37 ` Andrew Cooper
2014-11-19 10:38 ` Ian Campbell
0 siblings, 1 reply; 12+ messages in thread
From: Andrew Cooper @ 2014-11-19 10:37 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel
On 19/11/14 10:30, Ian Campbell wrote:
> On Wed, 2014-11-19 at 10:24 +0000, Andrew Cooper wrote:
>> On 19/11/14 10:12, Ian Campbell wrote:
>>> http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html has a
>>> bunch of random sha id's in it, where the 4.4-testing version does not.
>>>
>>> They seem to have replaced the various
>>> `= <boolean>`
>>>
>>> Default: `true`
>>>
>>> Bits.
>>>
>>> Andy, Any thoughts or should I investigate?
>>>
>>> I don't see anything since 4.4 touching the html generation itself (we
>>> added pandoc for pdf but didn't touch HTML afaict).
>>>
>>> Ian.
>>>
>> I have looked into it before but didn't get very far. I suspect it
>> might be a bug in wheezy's markdown. It doesn't reproduce when building
>> using other versions of markdown.
> Right.
>
> It seems to be triggered by the line:
> `S` is an integer 1 or 2 for the number of stop bits.
> just removing that makes the issue go away. It's not the `s since
> removing just those retains the issue. WTAF!
>
> Ian.
>
So it does. As best as I can tell, that is all legal mardown for a
nested block.
~Andrew
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:37 ` Andrew Cooper
@ 2014-11-19 10:38 ` Ian Campbell
2014-11-19 10:46 ` Ian Campbell
0 siblings, 1 reply; 12+ messages in thread
From: Ian Campbell @ 2014-11-19 10:38 UTC (permalink / raw)
To: Andrew Cooper; +Cc: xen-devel
On Wed, 2014-11-19 at 10:37 +0000, Andrew Cooper wrote:
> On 19/11/14 10:30, Ian Campbell wrote:
> > On Wed, 2014-11-19 at 10:24 +0000, Andrew Cooper wrote:
> >> On 19/11/14 10:12, Ian Campbell wrote:
> >>> http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html has a
> >>> bunch of random sha id's in it, where the 4.4-testing version does not.
> >>>
> >>> They seem to have replaced the various
> >>> `= <boolean>`
> >>>
> >>> Default: `true`
> >>>
> >>> Bits.
> >>>
> >>> Andy, Any thoughts or should I investigate?
> >>>
> >>> I don't see anything since 4.4 touching the html generation itself (we
> >>> added pandoc for pdf but didn't touch HTML afaict).
> >>>
> >>> Ian.
> >>>
> >> I have looked into it before but didn't get very far. I suspect it
> >> might be a bug in wheezy's markdown. It doesn't reproduce when building
> >> using other versions of markdown.
> > Right.
> >
> > It seems to be triggered by the line:
> > `S` is an integer 1 or 2 for the number of stop bits.
> > just removing that makes the issue go away. It's not the `s since
> > removing just those retains the issue. WTAF!
> >
> > Ian.
> >
>
> So it does. As best as I can tell, that is all legal mardown for a
> nested block.
Removing the preceeding nested list also "fixes" it, so I suspect some
sort of error in handling nested lists with surrounding text in the
parent entry, or something. I've not been able to find a workaround...
>
> ~Andrew
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:38 ` Ian Campbell
@ 2014-11-19 10:46 ` Ian Campbell
2014-11-19 10:52 ` Andrew Cooper
0 siblings, 1 reply; 12+ messages in thread
From: Ian Campbell @ 2014-11-19 10:46 UTC (permalink / raw)
To: Andrew Cooper, Ian Jackson; +Cc: xen-devel
On Wed, 2014-11-19 at 10:38 +0000, Ian Campbell wrote:
> I've not been able to find a workaround...
This works for me...
8<---------------
>From 3483179d333c47deacfc8c2eb195bf7dc4a555ff Mon Sep 17 00:00:00 2001
From: Ian Campbell <ian.campbell@citrix.com>
Date: Wed, 19 Nov 2014 10:42:18 +0000
Subject: [PATCH] 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@citrix.com>
---
docs/misc/xen-command-line.markdown | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 0830e5f..c40f89b 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -248,17 +248,17 @@ Both option `com1` and `com2` follow the same format.
* `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.
+ * `D` is an integer between 5 and 8 for the number of data bits.
- `P` is a single character representing the type of parity:
+ * `P` is a single character representing the type of parity:
- * `n` No
- * `o` Odd
- * `e` Even
- * `m` Mark
- * `s` Space
+ * `n` No
+ * `o` Odd
+ * `e` Even
+ * `m` Mark
+ * `s` Space
- `S` is an integer 1 or 2 for the number of stop bits.
+ * `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.
--
1.7.10.4
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:46 ` Ian Campbell
@ 2014-11-19 10:52 ` Andrew Cooper
2014-11-19 11:04 ` Ian Campbell
0 siblings, 1 reply; 12+ messages in thread
From: Andrew Cooper @ 2014-11-19 10:52 UTC (permalink / raw)
To: Ian Campbell, Ian Jackson; +Cc: xen-devel
On 19/11/14 10:46, Ian Campbell wrote:
> On Wed, 2014-11-19 at 10:38 +0000, Ian Campbell wrote:
>> I've not been able to find a workaround...
> This works for me...
>
> 8<---------------
>
> From 3483179d333c47deacfc8c2eb195bf7dc4a555ff Mon Sep 17 00:00:00 2001
> From: Ian Campbell <ian.campbell@citrix.com>
> Date: Wed, 19 Nov 2014 10:42:18 +0000
> Subject: [PATCH] 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@citrix.com>
I had just identified a different way, but this way is slightly better.
If you take out all the blank lines visible in the context below, the
resulting HTML will be correctly formatted and rather neater (i.e.
without sporadic blank lines).
~Andrew
> ---
> docs/misc/xen-command-line.markdown | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
> index 0830e5f..c40f89b 100644
> --- a/docs/misc/xen-command-line.markdown
> +++ b/docs/misc/xen-command-line.markdown
> @@ -248,17 +248,17 @@ Both option `com1` and `com2` follow the same format.
> * `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.
> + * `D` is an integer between 5 and 8 for the number of data bits.
>
> - `P` is a single character representing the type of parity:
> + * `P` is a single character representing the type of parity:
>
> - * `n` No
> - * `o` Odd
> - * `e` Even
> - * `m` Mark
> - * `s` Space
> + * `n` No
> + * `o` Odd
> + * `e` Even
> + * `m` Mark
> + * `s` Space
>
> - `S` is an integer 1 or 2 for the number of stop bits.
> + * `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.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 10:52 ` Andrew Cooper
@ 2014-11-19 11:04 ` Ian Campbell
2014-11-19 11:05 ` Andrew Cooper
0 siblings, 1 reply; 12+ messages in thread
From: Ian Campbell @ 2014-11-19 11:04 UTC (permalink / raw)
To: Andrew Cooper; +Cc: Ian Jackson, xen-devel
On Wed, 2014-11-19 at 10:52 +0000, Andrew Cooper wrote:
> On 19/11/14 10:46, Ian Campbell wrote:
> > On Wed, 2014-11-19 at 10:38 +0000, Ian Campbell wrote:
> >> I've not been able to find a workaround...
> > This works for me...
> >
> > 8<---------------
> >
> > From 3483179d333c47deacfc8c2eb195bf7dc4a555ff Mon Sep 17 00:00:00 2001
> > From: Ian Campbell <ian.campbell@citrix.com>
> > Date: Wed, 19 Nov 2014 10:42:18 +0000
> > Subject: [PATCH] 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@citrix.com>
>
> I had just identified a different way, but this way is slightly better.
>
> If you take out all the blank lines visible in the context below, the
> resulting HTML will be correctly formatted and rather neater (i.e.
> without sporadic blank lines).
Agreed.
8<------
>From 53398a9729d391f1fb7b6f753a0032b1f3604d4d Mon Sep 17 00:00:00 2001
From: Ian Campbell <ian.campbell@citrix.com>
Date: Wed, 19 Nov 2014 10:42:18 +0000
Subject: [PATCH] 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@citrix.com>
---
v2: Less blank lines == nicer output.
---
docs/misc/xen-command-line.markdown | 21 ++++++++-------------
1 file 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
--
1.7.10.4
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 11:04 ` Ian Campbell
@ 2014-11-19 11:05 ` Andrew Cooper
2014-11-19 11:11 ` Konrad Rzeszutek Wilk
0 siblings, 1 reply; 12+ messages in thread
From: Andrew Cooper @ 2014-11-19 11:05 UTC (permalink / raw)
To: Ian Campbell; +Cc: Ian Jackson, xen-devel
On 19/11/14 11:04, Ian Campbell wrote:
> On Wed, 2014-11-19 at 10:52 +0000, Andrew Cooper wrote:
>> On 19/11/14 10:46, Ian Campbell wrote:
>>> On Wed, 2014-11-19 at 10:38 +0000, Ian Campbell wrote:
>>>> I've not been able to find a workaround...
>>> This works for me...
>>>
>>> 8<---------------
>>>
>>> From 3483179d333c47deacfc8c2eb195bf7dc4a555ff Mon Sep 17 00:00:00 2001
>>> From: Ian Campbell <ian.campbell@citrix.com>
>>> Date: Wed, 19 Nov 2014 10:42:18 +0000
>>> Subject: [PATCH] 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@citrix.com>
>> I had just identified a different way, but this way is slightly better.
>>
>> If you take out all the blank lines visible in the context below, the
>> resulting HTML will be correctly formatted and rather neater (i.e.
>> without sporadic blank lines).
> Agreed.
>
> 8<------
>
> From 53398a9729d391f1fb7b6f753a0032b1f3604d4d Mon Sep 17 00:00:00 2001
> From: Ian Campbell <ian.campbell@citrix.com>
> Date: Wed, 19 Nov 2014 10:42:18 +0000
> Subject: [PATCH] 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@citrix.com>
Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>
> ---
> v2: Less blank lines == nicer output.
> ---
> docs/misc/xen-command-line.markdown | 21 ++++++++-------------
> 1 file 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
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 11:05 ` Andrew Cooper
@ 2014-11-19 11:11 ` Konrad Rzeszutek Wilk
2014-11-20 15:58 ` Ian Campbell
0 siblings, 1 reply; 12+ messages in thread
From: Konrad Rzeszutek Wilk @ 2014-11-19 11:11 UTC (permalink / raw)
To: Andrew Cooper, Ian Campbell; +Cc: Ian Jackson, xen-devel
On November 19, 2014 6:05:33 AM EST, Andrew Cooper <andrew.cooper3@citrix.com> wrote:
>On 19/11/14 11:04, Ian Campbell wrote:
>> On Wed, 2014-11-19 at 10:52 +0000, Andrew Cooper wrote:
>>> On 19/11/14 10:46, Ian Campbell wrote:
>>>> On Wed, 2014-11-19 at 10:38 +0000, Ian Campbell wrote:
>>>>> I've not been able to find a workaround...
>>>> This works for me...
>>>>
>>>> 8<---------------
>>>>
>>>> From 3483179d333c47deacfc8c2eb195bf7dc4a555ff Mon Sep 17 00:00:00
>2001
>>>> From: Ian Campbell <ian.campbell@citrix.com>
>>>> Date: Wed, 19 Nov 2014 10:42:18 +0000
>>>> Subject: [PATCH] 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@citrix.com>
>>> I had just identified a different way, but this way is slightly
>better.
>>>
>>> If you take out all the blank lines visible in the context below,
>the
>>> resulting HTML will be correctly formatted and rather neater (i.e.
>>> without sporadic blank lines).
>> Agreed.
>>
>> 8<------
>>
>> From 53398a9729d391f1fb7b6f753a0032b1f3604d4d Mon Sep 17 00:00:00
>2001
>> From: Ian Campbell <ian.campbell@citrix.com>
>> Date: Wed, 19 Nov 2014 10:42:18 +0000
>> Subject: [PATCH] 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@citrix.com>
>
>Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>
Release-Acked-by: Konrad Rzeszutek Wilk (Konrad.wilk@oracle.com)
In case you were thinking of putting in 4.5
>
>> ---
>> v2: Less blank lines == nicer output.
>> ---
>> docs/misc/xen-command-line.markdown | 21 ++++++++-------------
>> 1 file 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
>
>
>_______________________________________________
>Xen-devel mailing list
>Xen-devel@lists.xen.org
>http://lists.xen.org/xen-devel
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: Strangeness in generated xen-command-line.html
2014-11-19 11:11 ` Konrad Rzeszutek Wilk
@ 2014-11-20 15:58 ` Ian Campbell
0 siblings, 0 replies; 12+ messages in thread
From: Ian Campbell @ 2014-11-20 15:58 UTC (permalink / raw)
To: Konrad Rzeszutek Wilk; +Cc: Andrew Cooper, Ian Jackson, xen-devel
On Wed, 2014-11-19 at 06:11 -0500, Konrad Rzeszutek Wilk wrote:
> On November 19, 2014 6:05:33 AM EST, Andrew Cooper <andrew.cooper3@citrix.com> wrote:
> >On 19/11/14 11:04, Ian Campbell wrote:
> >> Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
> >
> >Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>
>
> Release-Acked-by: Konrad Rzeszutek Wilk (Konrad.wilk@oracle.com)
>
> In case you were thinking of putting in 4.5
I was, and now I have, thanks.
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2014-11-20 15:58 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-11-19 10:12 Strangeness in generated xen-command-line.html Ian Campbell
2014-11-19 10:21 ` Ian Campbell
2014-11-19 10:24 ` Andrew Cooper
2014-11-19 10:30 ` Ian Campbell
2014-11-19 10:37 ` Andrew Cooper
2014-11-19 10:38 ` Ian Campbell
2014-11-19 10:46 ` Ian Campbell
2014-11-19 10:52 ` Andrew Cooper
2014-11-19 11:04 ` Ian Campbell
2014-11-19 11:05 ` Andrew Cooper
2014-11-19 11:11 ` Konrad Rzeszutek Wilk
2014-11-20 15:58 ` Ian Campbell
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.