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

Re: [libvirt] [PATCH 4/7] docs: process code blocks similar to markdown

At Tue, 29 Jan 2013 11:23:24 -0700,
Eric Blake wrote:
> On 01/22/2013 07:31 AM, Claudio Bley wrote:
> > Wrap pre-formatted example code in <code> elements. This works
> > similar to markdown code blocks.
> > 
> > Every line indented with at least 2 spaces is considered a code
> > block and gets wrapped in <pre> and <code> tags.
> > 
> > Signed-off-by: Claudio Bley <cbley av-test de>
> > ---
> >  docs/newapi.xsl |   89 +++++++++++++++++++++++++++++++++++++++++--------------
> >  1 file changed, 67 insertions(+), 22 deletions(-)
> I tried to see a page where this would make a difference; but
> http://libvirt.org/html/libvirt-libvirt.html#virDomainGetMemoryParameters didn't
> pick up any new formatting in my local version.

Sorry for not providing this before, but for me #virStreamRecv works,
as does #virStreamRecvAll.

> For these patches, calling out an anchor where the differences can
> be visually inspected will make review much easier.  Or is this a
> case where we also need to touch up src/libvirt.c to actually
> provide the indentation that this xsl patch is looking for?

Yes, the code in virDomainGetMemoryParameters isn't indented, ie. it
is not recognized as a code block.

And there's a glitch in virStreamRecv's code block too, the label on
the third from last line is not indented and hence got its first two
characters cut off.

> At any rate, I don't feel comfortable acking until I can see the
> improvement (since I am not fluent in xsl); but if the idea works,
> it makes total sense (as the current code chunks on the web page
> render quite horribly).

Yes, I totally agree.

AV-Test GmbH, Henricistra├če 20, 04155 Leipzig, Germany
Phone: +49 341 265 310 19

Eingetragen am / Registered at: Amtsgericht Stendal (HRB 114076)
Geschaeftsfuehrer (CEO): Andreas Marx, Guido Habicht, Maik Morgenstern

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