All of lore.kernel.org
 help / color / mirror / Atom feed
From: George Dunlap <george.dunlap@citrix.com>
To: Juergen Gross <jgross@suse.com>, xen-devel@lists.xenproject.org
Cc: sstabellini@kernel.org, wei.liu2@citrix.com,
	George.Dunlap@eu.citrix.com, andrew.cooper3@citrix.com,
	ian.jackson@eu.citrix.com, tim@xen.org,
	ross.lagerwall@citrix.com, jbeulich@suse.com
Subject: Re: [PATCH v3 0/2] fix several issues in documentation
Date: Tue, 8 May 2018 10:25:58 +0100	[thread overview]
Message-ID: <6cb4dd5d-3284-4f26-3ae5-5e8a8e06f227@citrix.com> (raw)
In-Reply-To: <20180508064731.12391-1-jgross@suse.com>

On 05/08/2018 07:47 AM, Juergen Gross wrote:
> Some documents contain invalid pandoc syntax leading to failures when
> creating PDFs from them, e.g. when calling "make all" in the docs
> directory.
> 
> Correct those by using proper lists, code blocks and special character
> escaping.

It's probably worth discussing at some point exactly which dialect(s) of
Markdown we'll support, and what we should call the resulting files.

I'd be in favor of standardizing on pandoc markdown, and naming all the
files '.md'.  Then we could, for instance, use `~~~` to indicate longer
code blocks, rather than four-space indentations (which are slightly
annoying if you're copy-and-pasting from other code).

But maybe that's a discussion to have when we open the 4.12 development
window.

 -George

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

  parent reply	other threads:[~2018-05-08  9:26 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-08  6:47 [PATCH v3 0/2] fix several issues in documentation Juergen Gross
2018-05-08  6:47 ` [PATCH v3 1/2] doc: correct livepatch.markdown syntax Juergen Gross
2018-05-08  9:55   ` [PATCH v3.5 " Andrew Cooper
2018-05-18 17:35     ` [PATCH for-4.11 " Andrew Cooper
2018-05-21  8:56       ` Wei Liu
2018-05-08 10:51   ` [PATCH v3 " George Dunlap
2018-05-11 17:56     ` Konrad Rzeszutek Wilk
2018-05-11 17:58       ` Andrew Cooper
2018-05-08  6:47 ` [PATCH v3 2/2] doc: correct intel_psr_cat_cdp.pandoc syntax Juergen Gross
2018-05-08 12:56   ` George Dunlap
2018-05-08 13:06     ` Juergen Gross
2018-07-10 13:24       ` Juergen Gross
2018-07-10 14:09         ` Wei Liu
2018-05-08  9:25 ` George Dunlap [this message]
2018-05-08  9:32   ` [PATCH v3 0/2] fix several issues in documentation Juergen Gross
2018-05-08 13:08     ` Ian Jackson
2018-05-08 13:10       ` George Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6cb4dd5d-3284-4f26-3ae5-5e8a8e06f227@citrix.com \
    --to=george.dunlap@citrix.com \
    --cc=George.Dunlap@eu.citrix.com \
    --cc=andrew.cooper3@citrix.com \
    --cc=ian.jackson@eu.citrix.com \
    --cc=jbeulich@suse.com \
    --cc=jgross@suse.com \
    --cc=ross.lagerwall@citrix.com \
    --cc=sstabellini@kernel.org \
    --cc=tim@xen.org \
    --cc=wei.liu2@citrix.com \
    --cc=xen-devel@lists.xenproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.