[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH] Fix documentation and comment typos



Fix a few mispellings :-) of "successfully" and regenerate
docs/libvirt-*.xml.  The regeneration also includes the changes
in 47c8709.

* src/libvirt.c: Fix typos.
* src/secret/secret_driver.c: Fix typos.
* docs/libvirt-api.xml: Regenerate.
* docs/libvirt-refs.xml: Regenerate.
---
 docs/libvirt-api.xml       |    6 +++---
 docs/libvirt-refs.xml      |   10 +++-------
 src/libvirt.c              |    4 ++--
 src/secret/secret_driver.c |    4 ++--
 4 files changed, 10 insertions(+), 14 deletions(-)

diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index 795701c..88dc246 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -2847,7 +2847,7 @@ API looks like
      ...report an error...
   virStreamFree(st);
   close(fd);]]></info>
-      <return type='int' info='0 if all the data was succesfully received. The caller should invoke virStreamFinish(st) to flush the stream upon success and then virStreamFree  Returns -1 upon any error, with virStreamAbort() already having been called,  so the caller need only call virStreamFree()'/>
+      <return type='int' info='0 if all the data was successfully received. The caller should invoke virStreamFinish(st) to flush the stream upon success and then virStreamFree  Returns -1 upon any error, with virStreamAbort() already having been called,  so the caller need only call virStreamFree()'/>
       <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
       <arg name='handler' type='virStreamSinkFunc' info='sink callback for writing data to application'/>
       <arg name='opaque' type='void *' info='application defined data'/>
@@ -2864,7 +2864,7 @@ the caller no longer needs the reference to this object.]]></info>
       <info><![CDATA[Write a series of bytes to the stream. This method may
 block the calling application for an arbitrary amount
 of time. Once an application has finished sending data
-it should call virStreamFinish to wait for succesful
+it should call virStreamFinish to wait for successful
 confirmation from the driver, or detect any error
 
 This method may not be used if a stream source has been
@@ -2939,7 +2939,7 @@ API looks like
      ...report an error...
   virStreamFree(st);
   close(fd);]]></info>
-      <return type='int' info='0 if all the data was succesfully sent. The caller should invoke virStreamFinish(st) to flush the stream upon success and then virStreamFree  Returns -1 upon any error, with virStreamAbort() already having been called,  so the caller need only call virStreamFree()'/>
+      <return type='int' info='0 if all the data was successfully sent. The caller should invoke virStreamFinish(st) to flush the stream upon success and then virStreamFree  Returns -1 upon any error, with virStreamAbort() already having been called,  so the caller need only call virStreamFree()'/>
       <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
       <arg name='handler' type='virStreamSourceFunc' info='source callback for reading data from application'/>
       <arg name='opaque' type='void *' info='application defined data'/>
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index 428f847..08034e4 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -7176,21 +7176,17 @@
           <ref name='virNetworkCreate'/>
           <ref name='virStreamEventUpdateCallback'/>
         </word>
-        <word name='succesful'>
-          <ref name='virStreamSend'/>
-        </word>
-        <word name='succesfully'>
-          <ref name='virStreamRecvAll'/>
-          <ref name='virStreamSendAll'/>
-        </word>
         <word name='successful'>
           <ref name='virDomainMigrate'/>
           <ref name='virDomainSave'/>
           <ref name='virNodeDeviceCreateXML'/>
+          <ref name='virStreamSend'/>
         </word>
         <word name='successfully'>
           <ref name='virConnectOpen'/>
           <ref name='virStreamFinish'/>
+          <ref name='virStreamRecvAll'/>
+          <ref name='virStreamSendAll'/>
         </word>
         <word name='such'>
           <ref name='virConnCopyLastError'/>
diff --git a/src/libvirt.c b/src/libvirt.c
index 4cc19ec..dacf8c4 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -9638,7 +9638,7 @@ error:
  *   virStreamFree(st);
  *   close(fd);
  *
- * Returns 0 if all the data was succesfully sent. The caller
+ * Returns 0 if all the data was successfully sent. The caller
  * should invoke virStreamFinish(st) to flush the stream upon
  * success and then virStreamFree
  *
@@ -9735,7 +9735,7 @@ cleanup:
  *   virStreamFree(st);
  *   close(fd);
  *
- * Returns 0 if all the data was succesfully received. The caller
+ * Returns 0 if all the data was successfully received. The caller
  * should invoke virStreamFinish(st) to flush the stream upon
  * success and then virStreamFree
  *
diff --git a/src/secret/secret_driver.c b/src/secret/secret_driver.c
index 9c4102e..d61c24a 100644
--- a/src/secret/secret_driver.c
+++ b/src/secret/secret_driver.c
@@ -751,7 +751,7 @@ secretDefineXML(virConnectPtr conn, const char *xml,
         if (secretDeleteSaved(conn, driver, secret) < 0)
             goto restore_backup;
     }
-    /* Saved succesfully - drop old values */
+    /* Saved successfully - drop old values */
     new_attrs = NULL;
     virSecretDefFree(backup);
 
@@ -843,7 +843,7 @@ secretSetValue(virSecretPtr obj, const unsigned char *value,
         if (secretSaveValue(obj->conn, driver, secret) < 0)
             goto restore_backup;
     }
-    /* Saved succesfully - drop old value */
+    /* Saved successfully - drop old value */
     if (old_value != NULL) {
         memset(old_value, 0, old_value_size);
         VIR_FREE(old_value);
-- 
1.6.2.5


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]