[Xen-devel] [PATCH XEN v5 18/23] tools/libs/gnttab: Review and update doc comments.

[Ian Campbell <ian.campbell@xxxxxxxxxx>]

Remove some stray xc references.

While I'm not convinced by javadoc/doxygen cause the existing comments
which appear to use that syntax to have the appropriate /** marker.

Also fix a typo in a code comment.

Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx>
Acked-by: Wei Liu <wei.liu2@xxxxxxxxxx>
---
 tools/libs/gnttab/include/xengnttab.h | 21 +++++++++++----------
 tools/libs/gnttab/linux.c             |  2 +-
 2 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/tools/libs/gnttab/include/xengnttab.h 
b/tools/libs/gnttab/include/xengnttab.h
index c810c07..e091fa6 100644
--- a/tools/libs/gnttab/include/xengnttab.h
+++ b/tools/libs/gnttab/include/xengnttab.h
@@ -38,9 +38,9 @@ typedef struct xengntdev_handle xengnttab_handle;
 
 /*
  * Note:
- * After fork a child process must not use any opened xc gnttab
+ * After fork a child process must not use any opened gnttab
  * handle inherited from their parent. They must open a new handle if
- * they want to interact with xc.
+ * they want to interact with gnttab.
  *
  * Return an fd onto the grant table driver.  Logs errors.
  */
@@ -52,7 +52,7 @@ xengnttab_handle *xengnttab_open(xentoollog_logger *logger, 
unsigned open_flags)
  */
 int xengnttab_close(xengnttab_handle *xgt);
 
-/*
+/**
  * Memory maps a grant reference from one domain to a local address range.
  * Mappings should be unmapped with xengnttab_munmap.  Logs errors.
  *
@@ -124,7 +124,7 @@ void *xengnttab_map_grant_ref_notify(xengnttab_handle *xgt,
                                      uint32_t notify_offset,
                                      evtchn_port_t notify_port);
 
-/*
+/**
  * Unmaps the @count pages starting at @start_address, which were mapped by a
  * call to xengnttab_map_grant_ref or xengnttab_map_grant_refs. Never logs.
  */
@@ -132,7 +132,7 @@ int xengnttab_munmap(xengnttab_handle *xgt,
                      void *start_address,
                      uint32_t count);
 
-/*
+/**
  * Sets the maximum number of grants that may be mapped by the given instance
  * to @count.  Never logs.
  *
@@ -156,9 +156,9 @@ typedef struct xengntdev_handle xengntshr_handle;
  * Return an fd onto the grant sharing driver.  Logs errors.
  *
  * Note:
- * After fork a child process must not use any opened xc gntshr
+ * After fork a child process must not use any opened gntshr
  * handle inherited from their parent. They must open a new handle if
- * they want to interact with xc.
+ * they want to interact with gntshr.
  *
  */
 xengntshr_handle *xengntshr_open(xentoollog_logger *logger,
@@ -170,7 +170,7 @@ xengntshr_handle *xengntshr_open(xentoollog_logger *logger,
  */
 int xengntshr_close(xengntshr_handle *xgs);
 
-/*
+/**
  * Creates and shares pages with another domain.
  *
  * @parm xgs a handle to an open grant sharing instance
@@ -183,7 +183,7 @@ int xengntshr_close(xengntshr_handle *xgs);
 void *xengntshr_share_pages(xengntshr_handle *xgs, uint32_t domid,
                             int count, uint32_t *refs, int writable);
 
-/*
+/**
  * Creates and shares a page with another domain, with unmap notification.
  *
  * @parm xgs a handle to an open grant sharing instance
@@ -199,7 +199,8 @@ void *xengntshr_share_page_notify(xengntshr_handle *xgs, 
uint32_t domid,
                                   uint32_t *ref, int writable,
                                   uint32_t notify_offset,
                                   evtchn_port_t notify_port);
-/*
+
+/**
  * Unmaps the @count pages starting at @start_address, which were mapped by a
  * call to xengntshr_share_*. Never logs.
  */
diff --git a/tools/libs/gnttab/linux.c b/tools/libs/gnttab/linux.c
index a76f17f..bdf2a42 100644
--- a/tools/libs/gnttab/linux.c
+++ b/tools/libs/gnttab/linux.c
@@ -136,7 +136,7 @@ void *osdep_gnttab_grant_map(xengnttab_handle *xgt,
          * swapped out. Since the paging daemon may be in the same domain, the
          * hypercall cannot block without causing a deadlock.
          *
-         * Because there are no notificaitons when the page is swapped in, wait
+         * Because there are no notifications when the page is swapped in, wait
          * a bit before retrying, and hope that the page will arrive 
eventually.
          */
         usleep(1000);
-- 
2.1.4


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