[PATCH] blkif.h: document physical-device node

[PATCH] blkif.h: document physical-device node

[Wei Liu]

This node is used by toolstack (libxl, hotplug script) and blkback.

Signed-off-by: Wei Liu <wei.liu2@citrix.com>
---
Cc: Ian Campbell <ian.campbell@citrix.com>
Cc: Ian Jackson <ian.jackson@eu.citrix.com>
Cc: Roger Pau Monne <roger.pau@citrix.com>
Cc: David Vrabel <david.vrabel@citrix.com>
Cc: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Cc: George Dunlap <george.dunlap@eu.citrix.com>

I notice this when I was looking at George's patch series to fix hotplug
scripts. If anyone has better idea how we can document this feel free to
provide alternative.
---
 xen/include/public/io/blkif.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/xen/include/public/io/blkif.h b/xen/include/public/io/blkif.h
index 6baf7fb..8f0f9a6 100644
--- a/xen/include/public/io/blkif.h
+++ b/xen/include/public/io/blkif.h
@@ -92,6 +92,12 @@
  *      backend driver to open the backing device.  (e.g. the path to the
  *      file or block device representing the backing store.)
  *
+ * physical-device
+ *      Values:         "MAJOR:MINOR"
+ *
+ *      MAJOR and MINOR are the major number and minor number of the
+ *      backing device respectively.
+ *
  * type
  *      Values:         "file", "phy", "tap"
  *
-- 
1.9.1

Re: [PATCH] blkif.h: document physical-device node

[Ian Campbell]

On Tue, 2015-07-07 at 16:48 +0100, Wei Liu wrote:
> This node is used by toolstack (libxl, hotplug script) and blkback.
> 
> Signed-off-by: Wei Liu <wei.liu2@citrix.com>
> ---
> Cc: Ian Campbell <ian.campbell@citrix.com>
> Cc: Ian Jackson <ian.jackson@eu.citrix.com>
> Cc: Roger Pau Monne <roger.pau@citrix.com>
> Cc: David Vrabel <david.vrabel@citrix.com>
> Cc: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
> Cc: George Dunlap <george.dunlap@eu.citrix.com>
> 
> I notice this when I was looking at George's patch series to fix hotplug
> scripts. If anyone has better idea how we can document this feel free to
> provide alternative.

It looks perfectly fine to me, maybe you might want to insert a "block"
before the device, but in any case:

Acked-by: Ian Campbell <ian.campbell@citrix.com>

> ---
>  xen/include/public/io/blkif.h | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/xen/include/public/io/blkif.h b/xen/include/public/io/blkif.h
> index 6baf7fb..8f0f9a6 100644
> --- a/xen/include/public/io/blkif.h
> +++ b/xen/include/public/io/blkif.h
> @@ -92,6 +92,12 @@
>   *      backend driver to open the backing device.  (e.g. the path to the
>   *      file or block device representing the backing store.)
>   *
> + * physical-device
> + *      Values:         "MAJOR:MINOR"
> + *
> + *      MAJOR and MINOR are the major number and minor number of the
> + *      backing device respectively.
> + *
>   * type
>   *      Values:         "file", "phy", "tap"
>   *

Re: [PATCH] blkif.h: document physical-device node

[Roger Pau Monné]

El 07/07/15 a les 17.48, Wei Liu ha escrit:
> This node is used by toolstack (libxl, hotplug script) and blkback.
> 
> Signed-off-by: Wei Liu <wei.liu2@citrix.com>
> ---
> Cc: Ian Campbell <ian.campbell@citrix.com>
> Cc: Ian Jackson <ian.jackson@eu.citrix.com>
> Cc: Roger Pau Monne <roger.pau@citrix.com>
> Cc: David Vrabel <david.vrabel@citrix.com>
> Cc: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
> Cc: George Dunlap <george.dunlap@eu.citrix.com>
> 
> I notice this when I was looking at George's patch series to fix hotplug
> scripts. If anyone has better idea how we can document this feel free to
> provide alternative.
> ---
>  xen/include/public/io/blkif.h | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/xen/include/public/io/blkif.h b/xen/include/public/io/blkif.h
> index 6baf7fb..8f0f9a6 100644
> --- a/xen/include/public/io/blkif.h
> +++ b/xen/include/public/io/blkif.h
> @@ -92,6 +92,12 @@
>   *      backend driver to open the backing device.  (e.g. the path to the
>   *      file or block device representing the backing store.)
>   *
> + * physical-device
> + *      Values:         "MAJOR:MINOR"
> + *
> + *      MAJOR and MINOR are the major number and minor number of the
> + *      backing device respectively.
> + *

Acked-by: Roger Pau Monné <roger.pau@citrix.com>

Although I plan to expand this field so it's also used by FreeBSD
blkback with a different format.

Roger.

Re: [PATCH] blkif.h: document physical-device node

[Ian Campbell]

On Mon, 2015-07-20 at 13:04 +0200, Roger Pau Monné wrote:
> 
> Acked-by: Roger Pau Monné <roger.pau@citrix.com>

Applied. Since I don't think it conflicts with...

> Although I plan to expand this field so it's also used by FreeBSD
> blkback with a different format.

...this.

Ian.

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