Re: [Xen-devel] [PATCH v3 1/2] doc: correct livepatch.markdown syntax

[Konrad Rzeszutek Wilk <konrad.wilk@xxxxxxxxxx>]

On Tue, May 08, 2018 at 11:51:47AM +0100, George Dunlap wrote:
> On 05/08/2018 07:47 AM, Juergen Gross wrote:
> > "make -C docs all" fails due to incorrect markdown syntax in
> > livepatch.markdown. Correct it.
> > 
> > Signed-off-by: Juergen Gross <jgross@xxxxxxxx>
> > Reviewed-by: Konrad Rzeszutek Wilk <konrad.wilk@xxxxxxxxxx>
> 
> Git complains of trailing whitespace:
> 
> Importing patch "doc-correct-livepatch-markdown" ... <stdin>:69:
> trailing whitespace.
> 
> <stdin>:72: trailing whitespace.
> 
> <stdin>:98: trailing whitespace.
> 
> <stdin>:232: trailing whitespace.
> 
> <stdin>:238: trailing whitespace.

That is on purpose. That is you need those two spaces at the end to force
it to stay in 'code' mode.

> 
> Checking patch docs/misc/livepatch.markdown...
> Applied patch docs/misc/livepatch.markdown cleanly.
> warning: squelched 13 whitespace errors
> warning: 18 lines add whitespace errors.
> 
> 
> > ---
> >  docs/misc/livepatch.markdown | 590 
> > ++++++++++++++++++++-----------------------
> >  1 file changed, 273 insertions(+), 317 deletions(-)
> > 
> > diff --git a/docs/misc/livepatch.markdown b/docs/misc/livepatch.markdown
> > index 54a6b850cb..a4de44472a 100644
> > --- a/docs/misc/livepatch.markdown
> > +++ b/docs/misc/livepatch.markdown
> > @@ -89,33 +89,27 @@ As example we will assume the hypervisor does not have 
> > XSA-132 (see
> >  4ff3449f0e9d175ceb9551d3f2aecb59273f639d) and we would like to binary patch
> >  the hypervisor with it. The original code looks as so:
> >  
> > -<pre>
> > -   48 89 e0                  mov    %rsp,%rax  
> > -   48 25 00 80 ff ff         and    $0xffffffffffff8000,%rax  
> > -</pre>
> > +       48 89 e0                  mov    %rsp,%rax
> > +       48 25 00 80 ff ff         and    $0xffffffffffff8000,%rax
> >  
> >  while the new patched hypervisor would be:
> >  
> > -<pre>
> > -   48 c7 45 b8 00 00 00 00   movq   $0x0,-0x48(%rbp)  
> > -   48 c7 45 c0 00 00 00 00   movq   $0x0,-0x40(%rbp)  
> > -   48 c7 45 c8 00 00 00 00   movq   $0x0,-0x38(%rbp)  
> > -   48 89 e0                  mov    %rsp,%rax  
> > -   48 25 00 80 ff ff         and    $0xffffffffffff8000,%rax  
> > -</pre>
> > +       48 c7 45 b8 00 00 00 00   movq   $0x0,-0x48(%rbp)
> > +       48 c7 45 c0 00 00 00 00   movq   $0x0,-0x40(%rbp)
> > +       48 c7 45 c8 00 00 00 00   movq   $0x0,-0x38(%rbp)
> > +       48 89 e0                  mov    %rsp,%rax
> > +       48 25 00 80 ff ff         and    $0xffffffffffff8000,%rax
> >  
> > -This is inside the arch_do_domctl. This new change adds 21 extra
> > +This is inside the arch\_do\_domctl. This new change adds 21 extra
> 
> It seems like nearly all of these would be better served by making them
> code blocks ( `arch_do_domctl`). It is:
> * easier to read in text format (one of the  main points of markdown),
> * fewer characters to type,
> * looks better rendered into html or pdf, and
> * doesn't require &lt; &gt; tags for < and >.
> 
>  -George

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel