Consistent use of 'void *opaque' to refer to opaque pointer in C API.
authorRichard Jones <rjones@redhat.com>
Wed, 1 Sep 2010 12:19:05 +0000 (13:19 +0100)
committerRichard Jones <rjones@redhat.com>
Wed, 8 Sep 2010 13:24:46 +0000 (14:24 +0100)
We inconsistently used 'void *data' or 'void *opaque' all over to
refer to the same thing.  Use 'void *opaque' in all places in the
published API and documentation.

Cherry picked from commit 867319ec5f9030d3c14c32e3302606f2bf11ac27.

src/guestfs.h
src/guestfs.pod

index 3cff484..a33ff4b 100644 (file)
@@ -43,20 +43,20 @@ extern void guestfs_close (guestfs_h *g);
 /*--- Error handling ---*/
 extern const char *guestfs_last_error (guestfs_h *g);
 
-typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
+typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *opaque, const char *msg);
 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
 
-extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data);
-extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn);
+extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *opaque);
+extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **opaque_rtn);
 
 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
 
 /*--- Events ---*/
-typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len);
-typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data);
-typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data);
-typedef void (*guestfs_close_cb) (guestfs_h *g, void *data);
+typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, char *buf, int len);
+typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);
+typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);
+typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);
 
 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
index e876016..3024348 100644 (file)
@@ -739,11 +739,11 @@ largest number of results.
 =head2 guestfs_set_error_handler
 
  typedef void (*guestfs_error_handler_cb) (guestfs_h *g,
-                                           void *data,
+                                           void *opaque,
                                            const char *msg);
  void guestfs_set_error_handler (guestfs_h *g,
                                  guestfs_error_handler_cb cb,
-                                 void *data);
+                                 void *opaque);
 
 The callback C<cb> will be called if there is an error.  The
 parameters passed to the callback are an opaque data pointer and the
@@ -760,7 +760,7 @@ If you set C<cb> to C<NULL> then I<no> handler is called.
 =head2 guestfs_get_error_handler
 
  guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,
-                                                     void **data_rtn);
+                                                     void **opaque_rtn);
 
 Returns the current error handler callback.