From: Wei Liu <wei.liu2@citrix.com>
To: Xen-devel <xen-devel@lists.xenproject.org>
Cc: Wei Liu <wei.liu2@citrix.com>,
Changlong Xie <xiecl.fnst@cn.fujitsu.com>,
Ian Jackson <Ian.Jackson@eu.citrix.com>,
Wen Congyang <wency@cn.fujitsu.com>
Subject: [PATCH 1/2] docs: fix xl manpage compilation broken by COLO
Date: Fri, 1 Apr 2016 15:45:05 +0100 [thread overview]
Message-ID: <1459521906-21810-2-git-send-email-wei.liu2@citrix.com> (raw)
In-Reply-To: <1459521906-21810-1-git-send-email-wei.liu2@citrix.com>
Rearrange the section to conform with pod syntax. Fix some typos along
the way.
Signed-off-by: Wei Liu <wei.liu2@citrix.com>
---
docs/man/xl.pod.1 | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index c711203..fed0d74 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -457,16 +457,18 @@ B<NOTES>
Remus support in xl is still in experimental (proof-of-concept) phase.
Disk replication support is limited to DRBD disks.
-COLO support in xl is still in experimental (proof-of-concept) phase.
+COLO support in xl is still in experimental (proof-of-concept)
+phase. All options are subject to change in the future.
=back
-B<EXAMPLE>
+COLO disk configuration looks like:
-=over 4
+ disk = ['...,colo,colo-host=xxx,colo-port=xxx,colo-export=xxx,active-disk=xxx,hidden-disk=xxx...']
-(a) An example for COLO replication's configuration: disk =['...,colo,colo-host
-=xxx,colo-port=xxx,colo-export=xxx,active-disk=xxx,hidden-disk=xxx...']
+The supported options are:
+
+=over 4
=item B<colo-host> :Secondary host's ip address.
@@ -481,13 +483,19 @@ and it's used by secondary.
=item B<hidden-disk> :Primary's modified contents will be buffered in this
disk, and it's used by secondary.
-(b) An example for COLO network configuration: vif =[ '...,forwarddev=xxx,...']
+=back
+
+COLO network configuration looks like:
+
+ vif = [ '...,forwarddev=xxx,...']
+
+The supported options are:
+
+=over 4
-=item B<forwarddev> :Forward devices for primary and secondary, there are
+=item B<forwarddev> :Forward devices for primary and secondary, they are
directly connected.
-Note that the COLO configuration settings should be considered unstable. They
-may change incompatibly in future versions of Xen.
=back
--
2.1.4
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel
next prev parent reply other threads:[~2016-04-01 14:44 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-04-01 14:45 [PATCH 0/2] Fix two small issues in COLO Wei Liu
2016-04-01 14:45 ` Wei Liu [this message]
2016-04-01 14:45 ` [PATCH 2/2] libxc: use PRIx64 to print out pfn Wei Liu
2016-04-01 14:54 ` Ian Jackson
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=1459521906-21810-2-git-send-email-wei.liu2@citrix.com \
--to=wei.liu2@citrix.com \
--cc=Ian.Jackson@eu.citrix.com \
--cc=wency@cn.fujitsu.com \
--cc=xen-devel@lists.xenproject.org \
--cc=xiecl.fnst@cn.fujitsu.com \
/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).