xen-devel.lists.xenproject.org archive mirror
 help / color / mirror / Atom feed
From: Andrew Cooper <andrew.cooper3@citrix.com>
To: Xen-devel <xen-devel@lists.xen.org>
Cc: Juergen Gross <JGross@suse.com>,
	Lars Kurth <lars.kurth@citrix.com>, Wei Liu <wei.liu2@citrix.com>,
	Ian Campbell <Ian.Campbell@citrix.com>,
	Andrew Cooper <andrew.cooper3@citrix.com>,
	Ian Jackson <Ian.Jackson@eu.citrix.com>, Tim Deegan <tim@xen.org>,
	Jim Fehlig <jfehlig@suse.com>, Jan Beulich <JBeulich@suse.com>
Subject: [RFC v2 for-4.6 0/2] In-tree feature documentation
Date: Tue, 25 Aug 2015 11:40:26 +0100	[thread overview]
Message-ID: <1440499228-961-1-git-send-email-andrew.cooper3@citrix.com> (raw)

An issue which Xen has is an uncertain support statement for features.
Given the success seen with docs/misc/xen-command-line.markdown, and in
particular keeping it up to date, introduce a similar system for
features.

Patch 1 introduces a proposed template (and a makefile tweak to include
the new docs/features subdirectory), while patch 2 is a feature document
covering the topic of migration.

v2 Adds %Revision and #History table, following feedback from v1.

This is tagged RFC as I expect people to have different views as to what
is useful to include.  I would particilarly appreciate feedback on the
template before it starts getting used widely.

Lars: Does this look like a reasonable counterpart to your formal
support statement document?

Jim: Per your request at the summit for new information, is patch 2
suitable?

Andrew Cooper (2):
  docs: Template for feature documents
  docs: Migration feature document

 docs/Makefile                  |    2 +-
 docs/features/migration.pandoc |  100 ++++++++++++++++++++++++++++++++++++++++
 docs/features/template.pandoc  |   67 +++++++++++++++++++++++++++
 3 files changed, 168 insertions(+), 1 deletion(-)
 create mode 100644 docs/features/migration.pandoc
 create mode 100644 docs/features/template.pandoc

-- 
1.7.10.4

             reply	other threads:[~2015-08-25 10:40 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-25 10:40 Andrew Cooper [this message]
2015-08-25 10:40 ` [PATCH v2 for-4.6 1/2] docs: Template for feature documents Andrew Cooper
2015-09-01 13:41   ` Ian Campbell
2015-09-01 13:45     ` Andrew Cooper
2015-08-25 10:40 ` [PATCH v2 for-4.6 2/2] docs: Migration feature document Andrew Cooper
2015-08-27  2:15   ` Jim Fehlig
2015-08-27 10:35     ` Andrew Cooper
2015-08-27  2:44 ` [RFC v2 for-4.6 0/2] In-tree feature documentation Jim Fehlig
2015-08-27 10:46   ` Andrew Cooper
2015-08-27 14:52 ` Ian Jackson
2015-08-27 15:39   ` Andrew Cooper
2015-08-27 17:58     ` Ian Jackson
2015-08-27 18:16       ` Andrew Cooper
2015-08-28 17:16   ` Lars Kurth
2015-08-28 17:40     ` Andrew Cooper
2015-08-28 17:48       ` Andrew Cooper
2015-08-28 17:51       ` Lars Kurth
2015-08-28 18:18         ` Andrew Cooper
2015-08-28 18:52           ` Lars Kurth
2015-08-28 19:06             ` Andrew Cooper

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=1440499228-961-1-git-send-email-andrew.cooper3@citrix.com \
    --to=andrew.cooper3@citrix.com \
    --cc=Ian.Campbell@citrix.com \
    --cc=Ian.Jackson@eu.citrix.com \
    --cc=JBeulich@suse.com \
    --cc=JGross@suse.com \
    --cc=jfehlig@suse.com \
    --cc=lars.kurth@citrix.com \
    --cc=tim@xen.org \
    --cc=wei.liu2@citrix.com \
    --cc=xen-devel@lists.xen.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).