[Qemu-devel] [PATCH v6 03/19] migration: Add comments to channel functions

Juan Quintela posted 19 patches 8 years, 6 months ago
There is a newer version of this series
[Qemu-devel] [PATCH v6 03/19] migration: Add comments to channel functions
Posted by Juan Quintela 8 years, 6 months ago
Signed-off-by: Juan Quintela <quintela@redhat.com>
---
 migration/channel.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/migration/channel.c b/migration/channel.c
index edceebd..79b0f8b 100644
--- a/migration/channel.c
+++ b/migration/channel.c
@@ -19,6 +19,14 @@
 #include "qapi/error.h"
 #include "io/channel-tls.h"
 
+/**
+ * @migration_channel_process_incoming - Create new incoming migration channel
+ *
+ * Notice that TLS is special.  For it we listen in a listener socket,
+ * and then create a new client socket from the TLS library.
+ *
+ * @ioc: Channel to wich we are connecting
+ */
 void migration_channel_process_incoming(QIOChannel *ioc)
 {
     MigrationState *s = migrate_get_current();
@@ -41,6 +49,13 @@ void migration_channel_process_incoming(QIOChannel *ioc)
 }
 
 
+/**
+ * @migration_channel_connect - Create new outgoing migration channel
+ *
+ * @s: Current migration state
+ * @ioc: Channel to wich we are connecting
+ * @hostname: Where we want to connect
+ */
 void migration_channel_connect(MigrationState *s,
                                QIOChannel *ioc,
                                const char *hostname)
-- 
2.9.4


Re: [Qemu-devel] [PATCH v6 03/19] migration: Add comments to channel functions
Posted by Daniel P. Berrange 8 years, 6 months ago
On Tue, Aug 08, 2017 at 06:26:13PM +0200, Juan Quintela wrote:
> Signed-off-by: Juan Quintela <quintela@redhat.com>
> ---
>  migration/channel.c | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/migration/channel.c b/migration/channel.c
> index edceebd..79b0f8b 100644
> --- a/migration/channel.c
> +++ b/migration/channel.c
> @@ -19,6 +19,14 @@
>  #include "qapi/error.h"
>  #include "io/channel-tls.h"
>  
> +/**
> + * @migration_channel_process_incoming - Create new incoming migration channel
> + *
> + * Notice that TLS is special.  For it we listen in a listener socket,
> + * and then create a new client socket from the TLS library.
> + *
> + * @ioc: Channel to wich we are connecting
> + */

s/wich/which/

>  void migration_channel_process_incoming(QIOChannel *ioc)
>  {
>      MigrationState *s = migrate_get_current();
> @@ -41,6 +49,13 @@ void migration_channel_process_incoming(QIOChannel *ioc)
>  }
>  
>  
> +/**
> + * @migration_channel_connect - Create new outgoing migration channel
> + *
> + * @s: Current migration state
> + * @ioc: Channel to wich we are connecting

s/wich/which/

> + * @hostname: Where we want to connect
> + */
>  void migration_channel_connect(MigrationState *s,
>                                 QIOChannel *ioc,
>                                 const char *hostname)
> -- 
> 2.9.4

With those typos fixed, you can add

Reviewed-by: Daniel P. Berrange <berrange@redhat.com>

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|