]> git.kernelconcepts.de Git - karo-tx-linux.git/commitdiff
xen/xenbus: Correct the comments for xenbus_grant_ring()
authorChen Gang <gang.chen.5i5j@gmail.com>
Fri, 26 Sep 2014 15:34:29 +0000 (23:34 +0800)
committerDavid Vrabel <david.vrabel@citrix.com>
Mon, 6 Oct 2014 09:27:56 +0000 (10:27 +0100)
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>
Signed-off-by: David Vrabel <david.vrabel@citrix.com>
drivers/xen/xenbus/xenbus_client.c

index 439c9dca9eeedea8c490a9e57174c6745cae8637..aa9b2fcdaeb28cf6845385d3364be2eb59c88d73 100644 (file)
@@ -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)
 {