[PATCH v3] xen/xenbus: Correct the comments for xenbus_grant_ring()

[PATCH v3] xen/xenbus: Correct the comments for xenbus_grant_ring()

[Chen Gang]

A grant reference (which is a positive number) can indicate success, so
the original comments need be improved.

Signed-off-by: Chen Gang <gang.chen.5i5j@gmail.com>
---
 drivers/xen/xenbus/xenbus_client.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/xen/xenbus/xenbus_client.c b/drivers/xen/xenbus/xenbus_client.c
index 439c9dc..aa9b2fc 100644
--- a/drivers/xen/xenbus/xenbus_client.c
+++ b/drivers/xen/xenbus/xenbus_client.c
@@ -361,8 +361,8 @@ static void xenbus_switch_fatal(struct xenbus_device *dev, int depth, int err,
  * @ring_mfn: mfn of ring to grant
 
  * Grant access to the given @ring_mfn to the peer of the given device.  Return
- * 0 on success, or -errno on error.  On error, the device will switch to
- * XenbusStateClosing, and the error will be saved in the store.
+ * a grant reference on success, or -errno on error. On error, the device will
+ * switch to XenbusStateClosing, and the error will be saved in the store.
  */
 int xenbus_grant_ring(struct xenbus_device *dev, unsigned long ring_mfn)
 {
-- 
1.9.3

Re: [PATCH v3] xen/xenbus: Correct the comments for xenbus_grant_ring()

[David Vrabel]

On 26/09/14 16:34, Chen Gang wrote:
> A grant reference (which is a positive number) can indicate success, so
> the original comments need be improved.

Applied to devel/for-linus-3.18.

Thanks.

David