Message ID | 20200113215709.16107-1-julien@xen.org (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | docs/misc: pvcalls: Verbatim block should be indented with 4 spaces | expand |
On 13/01/2020 21:57, Julien Grall wrote: > At the moment, the diagram is only indented with 2 spaces. So pandoc > will try to badly interpret it and not display it correctly. > > Fix it by indenting all the block by 4 spaces (i.e an extra 2 spaces). > > Fixes: d661611d08 ("docs/markdown: Switch to using pandoc, and fix underscore escaping") > Signed-off-by: Julien Grall <julien@xen.org> Acked-by: Andrew Cooper <andrew.cooper3@citrix.com>
On Mon, 13 Jan 2020, Julien Grall wrote: > At the moment, the diagram is only indented with 2 spaces. So pandoc > will try to badly interpret it and not display it correctly. > > Fix it by indenting all the block by 4 spaces (i.e an extra 2 spaces). > > Fixes: d661611d08 ("docs/markdown: Switch to using pandoc, and fix underscore escaping") > Signed-off-by: Julien Grall <julien@xen.org> Acked-by: Stefano Stabellini <sstabellini@kernel.org> Thanks! > --- > docs/misc/pvcalls.pandoc | 36 ++++++++++++++++++------------------ > 1 file changed, 18 insertions(+), 18 deletions(-) > > diff --git a/docs/misc/pvcalls.pandoc b/docs/misc/pvcalls.pandoc > index 0c48b29842..729cf97bdf 100644 > --- a/docs/misc/pvcalls.pandoc > +++ b/docs/misc/pvcalls.pandoc > @@ -867,24 +867,24 @@ and the second half to the **out** array. They are used as circular > buffers for transferring data, and, together, they are the data ring. > > > - +---------------------------+ Indexes page > - | Command ring: | +----------------------+ > - | @0: xen_pvcalls_connect: | |@0 pvcalls_data_intf: | > - | @44: ref +-------------------------------->+@76: ring_order = 1 | > - | | |@80: ref[0]+ | > - +---------------------------+ |@84: ref[1]+ | > - | | | > - | | | > - +----------------------+ > - | > - v (data ring) > - +-------+-----------+ > - | @0->4098: in | > - | ref[0] | > - |-------------------| > - | @4099->8196: out | > - | ref[1] | > - +-------------------+ > + +---------------------------+ Indexes page > + | Command ring: | +----------------------+ > + | @0: xen_pvcalls_connect: | |@0 pvcalls_data_intf: | > + | @44: ref +-------------------------------->+@76: ring_order = 1 | > + | | |@80: ref[0]+ | > + +---------------------------+ |@84: ref[1]+ | > + | | | > + | | | > + +----------------------+ > + | > + v (data ring) > + +-------+-----------+ > + | @0->4098: in | > + | ref[0] | > + |-------------------| > + | @4099->8196: out | > + | ref[1] | > + +-------------------+ > > > #### Indexes Page Structure > -- > 2.17.1 >
diff --git a/docs/misc/pvcalls.pandoc b/docs/misc/pvcalls.pandoc index 0c48b29842..729cf97bdf 100644 --- a/docs/misc/pvcalls.pandoc +++ b/docs/misc/pvcalls.pandoc @@ -867,24 +867,24 @@ and the second half to the **out** array. They are used as circular buffers for transferring data, and, together, they are the data ring. - +---------------------------+ Indexes page - | Command ring: | +----------------------+ - | @0: xen_pvcalls_connect: | |@0 pvcalls_data_intf: | - | @44: ref +-------------------------------->+@76: ring_order = 1 | - | | |@80: ref[0]+ | - +---------------------------+ |@84: ref[1]+ | - | | | - | | | - +----------------------+ - | - v (data ring) - +-------+-----------+ - | @0->4098: in | - | ref[0] | - |-------------------| - | @4099->8196: out | - | ref[1] | - +-------------------+ + +---------------------------+ Indexes page + | Command ring: | +----------------------+ + | @0: xen_pvcalls_connect: | |@0 pvcalls_data_intf: | + | @44: ref +-------------------------------->+@76: ring_order = 1 | + | | |@80: ref[0]+ | + +---------------------------+ |@84: ref[1]+ | + | | | + | | | + +----------------------+ + | + v (data ring) + +-------+-----------+ + | @0->4098: in | + | ref[0] | + |-------------------| + | @4099->8196: out | + | ref[1] | + +-------------------+ #### Indexes Page Structure
At the moment, the diagram is only indented with 2 spaces. So pandoc will try to badly interpret it and not display it correctly. Fix it by indenting all the block by 4 spaces (i.e an extra 2 spaces). Fixes: d661611d08 ("docs/markdown: Switch to using pandoc, and fix underscore escaping") Signed-off-by: Julien Grall <julien@xen.org> --- docs/misc/pvcalls.pandoc | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-)