[PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[Wei Liu]

State that only attaching PV interface is supported.

Signed-off-by: Wei Liu <wei.liu2@citrix.com>
---
It's probably safe to claim the same for other device types, but I will just
stick with the ones I tested at this stage of the release.

Cc: Ian Jackson <ian.jackson@eu.citrix.com>
---
 docs/man/xl.pod.1 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 9887f1b..290d8ed 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -1284,7 +1284,8 @@ effect to the guest OS is much the same as any hotplug event.
 =item B<block-attach> I<domain-id> I<disc-spec-component(s)> ...
 
 Create a new virtual block device.  This will trigger a hotplug event
-for the guest.
+for the guest. Note that only attaching PV block device is supported,
+the B<vdev> field is ignored.
 
 B<OPTIONS>
 
@@ -1367,7 +1368,8 @@ Creates a new network device in the domain specified by I<domain-id>.
 I<network-device> describes the device to attach, using the same format as the
 B<vif> string in the domain config file. See L<xl.cfg> and
 L<http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html>
-for more informations.
+for more informations. Note that only attaching PV network interface is
+supported.
 
 =item B<network-detach> I<domain-id> I<devid|mac>
 
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: [PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[Ian Jackson]

Wei Liu writes ("[PATCH for-4.7] docs: update xl manpage about {block,network}-attach command"):
> State that only attaching PV interface is supported.
...
>  Create a new virtual block device.  This will trigger a hotplug event
> -for the guest.
> +for the guest. Note that only attaching PV block device is supported,
> +the B<vdev> field is ignored.

But the vdev field specifies more than just the device type.  So I
think this is wrong.

Ian.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: [PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[Wei Liu]

On Wed, May 25, 2016 at 03:15:23PM +0100, Ian Jackson wrote:
> Wei Liu writes ("[PATCH for-4.7] docs: update xl manpage about {block,network}-attach command"):
> > State that only attaching PV interface is supported.
> ...
> >  Create a new virtual block device.  This will trigger a hotplug event
> > -for the guest.
> > +for the guest. Note that only attaching PV block device is supported,
> > +the B<vdev> field is ignored.
> 
> But the vdev field specifies more than just the device type.  So I
> think this is wrong.

I guess to make things simpler I can just delete the "<vdev>" part?

"Note that only attaching PV block device is supported"

> 
> Ian.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: [PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[Ian Jackson]

Wei Liu writes ("Re: [PATCH for-4.7] docs: update xl manpage about {block,network}-attach command"):
> On Wed, May 25, 2016 at 03:15:23PM +0100, Ian Jackson wrote:
...
> > But the vdev field specifies more than just the device type.  So I
> > think this is wrong.
> 
> I guess to make things simpler I can just delete the "<vdev>" part?
> 
> "Note that only attaching PV block device is supported"

How about

  Note that only PV block devices are supported by block-attach.
  Requests to attach emulated devices (eg, vdev=hdc) will result in
  only the PV view being available to the guest.

Ian.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: [PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[Wei Liu]

On Wed, May 25, 2016 at 03:28:50PM +0100, Ian Jackson wrote:
> Wei Liu writes ("Re: [PATCH for-4.7] docs: update xl manpage about {block,network}-attach command"):
> > On Wed, May 25, 2016 at 03:15:23PM +0100, Ian Jackson wrote:
> ...
> > > But the vdev field specifies more than just the device type.  So I
> > > think this is wrong.
> > 
> > I guess to make things simpler I can just delete the "<vdev>" part?
> > 
> > "Note that only attaching PV block device is supported"
> 
> How about
> 
>   Note that only PV block devices are supported by block-attach.
>   Requests to attach emulated devices (eg, vdev=hdc) will result in
>   only the PV view being available to the guest.
> 

LGTM. I will update the patch.

Wei.

> Ian.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: [PATCH for-4.7] docs: update xl manpage about {block, network}-attach command

[Wei Liu]

On Wed, May 25, 2016 at 03:31:19PM +0100, Wei Liu wrote:
> On Wed, May 25, 2016 at 03:28:50PM +0100, Ian Jackson wrote:
> > Wei Liu writes ("Re: [PATCH for-4.7] docs: update xl manpage about {block,network}-attach command"):
> > > On Wed, May 25, 2016 at 03:15:23PM +0100, Ian Jackson wrote:
> > ...
> > > > But the vdev field specifies more than just the device type.  So I
> > > > think this is wrong.
> > > 
> > > I guess to make things simpler I can just delete the "<vdev>" part?
> > > 
> > > "Note that only attaching PV block device is supported"
> > 
> > How about
> > 
> >   Note that only PV block devices are supported by block-attach.
> >   Requests to attach emulated devices (eg, vdev=hdc) will result in
> >   only the PV view being available to the guest.
> > 
> 
> LGTM. I will update the patch.
> 

This is the updated patch.

I will commit it soon.

---8<--
From 1bca93e2326e5a644f00de80a72bcab181587489 Mon Sep 17 00:00:00 2001
From: Wei Liu <wei.liu2@citrix.com>
Date: Mon, 23 May 2016 12:07:20 +0100
Subject: [PATCH for-4.7 v2] docs: update xl manpage about {block,network}-attach command

State that only attaching PV interface is supported.

Signed-off-by: Wei Liu <wei.liu2@citrix.com>
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
Use Ian's wording about block-attach and add his S-o-B.
---
 docs/man/xl.pod.1 | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 9887f1b..f4dc32c 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -1286,6 +1286,10 @@ effect to the guest OS is much the same as any hotplug event.
 Create a new virtual block device.  This will trigger a hotplug event
 for the guest.
 
+Note that only PV block devices are supported by block-attach.
+Requests to attach emulated devices (eg, vdev=hdc) will result in only
+the PV view being available to the guest.
+
 B<OPTIONS>
 
 =over 4
@@ -1369,6 +1373,8 @@ B<vif> string in the domain config file. See L<xl.cfg> and
 L<http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html>
 for more informations.
 
+Note that only attaching PV network interface is supported.
+
 =item B<network-detach> I<domain-id> I<devid|mac>
 
 Removes the network device from the domain specified by I<domain-id>.
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel