* [PATCH for-4.5] docs/commandline: Fix formatting issues
@ 2014-11-19 11:17 Andrew Cooper
2014-11-19 11:22 ` Ian Campbell
0 siblings, 1 reply; 3+ messages in thread
From: Andrew Cooper @ 2014-11-19 11:17 UTC (permalink / raw)
To: Xen-devel; +Cc: Andrew Cooper, Ian Jackson, Ian Campbell, Wei Liu
In both of these cases, markdown was interpreting the text as regular text,
and reflowing it as a regular paragraph, leading to a single line as output.
Reformat them as code blocks inside blockquote blocks, which causes them to
take their precise whitespace layout.
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
CC: Ian Campbell <Ian.Campbell@citrix.com>
CC: Ian Jackson <Ian.Jackson@eu.citrix.com>
CC: Wei Liu <wei.liu2@citrix.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
---
Konrad: this is a documentation fix, so requesting a 4.5 ack please.
---
docs/misc/xen-command-line.markdown | 38 +++++++++++++++++------------------
1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index f054d4b..e3a5a15 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -475,13 +475,13 @@ defaults of 1 and unlimited respectively are used instead.
For example, with `dom0_max_vcpus=4-8`:
- Number of
- PCPUs | Dom0 VCPUs
- 2 | 4
- 4 | 4
- 6 | 6
- 8 | 8
- 10 | 8
+> Number of
+> PCPUs | Dom0 VCPUs
+> 2 | 4
+> 4 | 4
+> 6 | 6
+> 8 | 8
+> 10 | 8
### dom0\_mem
> `= List of ( min:<size> | max:<size> | <size> )`
@@ -684,18 +684,18 @@ supported only when compiled with XSM\_ENABLE=y on x86.
The specified value is a bit mask with the individual bits having the
following meaning:
-Bit 0 - debug level 0 (unused at present)
-Bit 1 - debug level 1 (Control Register logging)
-Bit 2 - debug level 2 (VMX logging of MSR restores when context switching)
-Bit 3 - debug level 3 (unused at present)
-Bit 4 - I/O operation logging
-Bit 5 - vMMU logging
-Bit 6 - vLAPIC general logging
-Bit 7 - vLAPIC timer logging
-Bit 8 - vLAPIC interrupt logging
-Bit 9 - vIOAPIC logging
-Bit 10 - hypercall logging
-Bit 11 - MSR operation logging
+> Bit 0 - debug level 0 (unused at present)
+> Bit 1 - debug level 1 (Control Register logging)
+> Bit 2 - debug level 2 (VMX logging of MSR restores when context switching)
+> Bit 3 - debug level 3 (unused at present)
+> Bit 4 - I/O operation logging
+> Bit 5 - vMMU logging
+> Bit 6 - vLAPIC general logging
+> Bit 7 - vLAPIC timer logging
+> Bit 8 - vLAPIC interrupt logging
+> Bit 9 - vIOAPIC logging
+> Bit 10 - hypercall logging
+> Bit 11 - MSR operation logging
Recognized in debug builds of the hypervisor only.
--
1.7.10.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH for-4.5] docs/commandline: Fix formatting issues
2014-11-19 11:17 [PATCH for-4.5] docs/commandline: Fix formatting issues Andrew Cooper
@ 2014-11-19 11:22 ` Ian Campbell
2014-11-19 21:21 ` Konrad Rzeszutek Wilk
0 siblings, 1 reply; 3+ messages in thread
From: Ian Campbell @ 2014-11-19 11:22 UTC (permalink / raw)
To: Andrew Cooper; +Cc: Wei Liu, Ian Jackson, Xen-devel
On Wed, 2014-11-19 at 11:17 +0000, Andrew Cooper wrote:
> In both of these cases, markdown was interpreting the text as regular text,
> and reflowing it as a regular paragraph, leading to a single line as output.
> Reformat them as code blocks inside blockquote blocks, which causes them to
> take their precise whitespace layout.
>
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Ian Campbell <Ian.Campbell@citrix.com>
> CC: Ian Jackson <Ian.Jackson@eu.citrix.com>
> CC: Wei Liu <wei.liu2@citrix.com>
> CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
>
> ---
>
> Konrad: this is a documentation fix, so requesting a 4.5 ack please.
FWIW IMHO documentation fixes in general should have a very low bar to
cross until very late in the release cycle...
> ---
> docs/misc/xen-command-line.markdown | 38 +++++++++++++++++------------------
> 1 file changed, 19 insertions(+), 19 deletions(-)
>
> diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
> index f054d4b..e3a5a15 100644
> --- a/docs/misc/xen-command-line.markdown
> +++ b/docs/misc/xen-command-line.markdown
> @@ -475,13 +475,13 @@ defaults of 1 and unlimited respectively are used instead.
>
> For example, with `dom0_max_vcpus=4-8`:
>
> - Number of
> - PCPUs | Dom0 VCPUs
> - 2 | 4
> - 4 | 4
> - 6 | 6
> - 8 | 8
> - 10 | 8
> +> Number of
> +> PCPUs | Dom0 VCPUs
> +> 2 | 4
> +> 4 | 4
> +> 6 | 6
> +> 8 | 8
> +> 10 | 8
>
> ### dom0\_mem
> > `= List of ( min:<size> | max:<size> | <size> )`
> @@ -684,18 +684,18 @@ supported only when compiled with XSM\_ENABLE=y on x86.
> The specified value is a bit mask with the individual bits having the
> following meaning:
>
> -Bit 0 - debug level 0 (unused at present)
> -Bit 1 - debug level 1 (Control Register logging)
> -Bit 2 - debug level 2 (VMX logging of MSR restores when context switching)
> -Bit 3 - debug level 3 (unused at present)
> -Bit 4 - I/O operation logging
> -Bit 5 - vMMU logging
> -Bit 6 - vLAPIC general logging
> -Bit 7 - vLAPIC timer logging
> -Bit 8 - vLAPIC interrupt logging
> -Bit 9 - vIOAPIC logging
> -Bit 10 - hypercall logging
> -Bit 11 - MSR operation logging
> +> Bit 0 - debug level 0 (unused at present)
> +> Bit 1 - debug level 1 (Control Register logging)
> +> Bit 2 - debug level 2 (VMX logging of MSR restores when context switching)
> +> Bit 3 - debug level 3 (unused at present)
> +> Bit 4 - I/O operation logging
> +> Bit 5 - vMMU logging
> +> Bit 6 - vLAPIC general logging
> +> Bit 7 - vLAPIC timer logging
> +> Bit 8 - vLAPIC interrupt logging
> +> Bit 9 - vIOAPIC logging
> +> Bit 10 - hypercall logging
> +> Bit 11 - MSR operation logging
>
> Recognized in debug builds of the hypervisor only.
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH for-4.5] docs/commandline: Fix formatting issues
2014-11-19 11:22 ` Ian Campbell
@ 2014-11-19 21:21 ` Konrad Rzeszutek Wilk
0 siblings, 0 replies; 3+ messages in thread
From: Konrad Rzeszutek Wilk @ 2014-11-19 21:21 UTC (permalink / raw)
To: Ian Campbell; +Cc: Andrew Cooper, Ian Jackson, Wei Liu, Xen-devel
On Wed, Nov 19, 2014 at 11:22:18AM +0000, Ian Campbell wrote:
> On Wed, 2014-11-19 at 11:17 +0000, Andrew Cooper wrote:
> > In both of these cases, markdown was interpreting the text as regular text,
> > and reflowing it as a regular paragraph, leading to a single line as output.
> > Reformat them as code blocks inside blockquote blocks, which causes them to
> > take their precise whitespace layout.
> >
> > Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
> Acked-by: Ian Campbell <Ian.Campbell@citrix.com>
>
> > CC: Ian Jackson <Ian.Jackson@eu.citrix.com>
> > CC: Wei Liu <wei.liu2@citrix.com>
> > CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
> >
> > ---
> >
> > Konrad: this is a documentation fix, so requesting a 4.5 ack please.
>
> FWIW IMHO documentation fixes in general should have a very low bar to
> cross until very late in the release cycle...
I concur, I updated the release criteria doc so that it will be expediated
in the future.
>
> > ---
> > docs/misc/xen-command-line.markdown | 38 +++++++++++++++++------------------
> > 1 file changed, 19 insertions(+), 19 deletions(-)
> >
> > diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
> > index f054d4b..e3a5a15 100644
> > --- a/docs/misc/xen-command-line.markdown
> > +++ b/docs/misc/xen-command-line.markdown
> > @@ -475,13 +475,13 @@ defaults of 1 and unlimited respectively are used instead.
> >
> > For example, with `dom0_max_vcpus=4-8`:
> >
> > - Number of
> > - PCPUs | Dom0 VCPUs
> > - 2 | 4
> > - 4 | 4
> > - 6 | 6
> > - 8 | 8
> > - 10 | 8
> > +> Number of
> > +> PCPUs | Dom0 VCPUs
> > +> 2 | 4
> > +> 4 | 4
> > +> 6 | 6
> > +> 8 | 8
> > +> 10 | 8
> >
> > ### dom0\_mem
> > > `= List of ( min:<size> | max:<size> | <size> )`
> > @@ -684,18 +684,18 @@ supported only when compiled with XSM\_ENABLE=y on x86.
> > The specified value is a bit mask with the individual bits having the
> > following meaning:
> >
> > -Bit 0 - debug level 0 (unused at present)
> > -Bit 1 - debug level 1 (Control Register logging)
> > -Bit 2 - debug level 2 (VMX logging of MSR restores when context switching)
> > -Bit 3 - debug level 3 (unused at present)
> > -Bit 4 - I/O operation logging
> > -Bit 5 - vMMU logging
> > -Bit 6 - vLAPIC general logging
> > -Bit 7 - vLAPIC timer logging
> > -Bit 8 - vLAPIC interrupt logging
> > -Bit 9 - vIOAPIC logging
> > -Bit 10 - hypercall logging
> > -Bit 11 - MSR operation logging
> > +> Bit 0 - debug level 0 (unused at present)
> > +> Bit 1 - debug level 1 (Control Register logging)
> > +> Bit 2 - debug level 2 (VMX logging of MSR restores when context switching)
> > +> Bit 3 - debug level 3 (unused at present)
> > +> Bit 4 - I/O operation logging
> > +> Bit 5 - vMMU logging
> > +> Bit 6 - vLAPIC general logging
> > +> Bit 7 - vLAPIC timer logging
> > +> Bit 8 - vLAPIC interrupt logging
> > +> Bit 9 - vIOAPIC logging
> > +> Bit 10 - hypercall logging
> > +> Bit 11 - MSR operation logging
> >
> > Recognized in debug builds of the hypervisor only.
> >
>
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-11-19 21:21 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-11-19 11:17 [PATCH for-4.5] docs/commandline: Fix formatting issues Andrew Cooper
2014-11-19 11:22 ` Ian Campbell
2014-11-19 21:21 ` Konrad Rzeszutek Wilk
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.