Skip to contentSkip to conversation

xen/xenbus: Correct the comments for xenbus_grant_ring()

PATCH Applied Chen Gang 2 participants 3 messages Sep 26, 2014 Xen hypervisor interface

lore
Share & tools
lore

Chen Gang

author
#0 lore raw

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

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

---
 drivers/xen/xenbus/xenbus_client.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/xen/xenbus/xenbus_client.c +2 -2
index 439c9dc..aa9b2fc 100644
@@ -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)
 {
Signature · 1 line
1.9.3
Applied
#1 lore raw
Quoted 2 lines · Chen Gang

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

Applied
#2 lore raw
In reply to Chen Gang
Quoted 2 lines · Chen Gang

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