todo: Refresh documentation.

[libguestfs.git] / src / guestfs.pod

diff --git a/src/guestfs.pod b/src/guestfs.pod
index a8e530f..7cb05a6 100644 (file)
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -676,8 +676,7 @@ For documentation see L<guestfs-python(3)>.
 
 =item B<Ruby>
 
 
 =item B<Ruby>
 

-Use the Guestfs module.  There is no Ruby-specific documentation, but
-you can find examples written in Ruby in the libguestfs source.
+For documentation see L<guestfs-ruby(3)>.

 
 =item B<shell scripts>
 
 
 =item B<shell scripts>
 


@@ -1856,6 +1855,14 @@ The header contains the procedure number (C<guestfs_proc>) which is
 how the receiver knows what type of args structure to expect, or none
 at all.
 
 how the receiver knows what type of args structure to expect, or none
 at all.
 

+For functions that take optional arguments, the optional arguments are
+encoded in the C<guestfs_I<foo>_args> structure in the same way as
+ordinary arguments.  A bitmask in the header indicates which optional
+arguments are meaningful.  The bitmask is also checked to see if it
+contains bits set which the daemon does not know about (eg. if more
+optional arguments were added in a later version of the library), and
+this causes the call to be rejected.
+

 The reply message for ordinary functions is:
 
  total length (header + ret,
 The reply message for ordinary functions is:
 
  total length (header + ret,


@@ -2085,6 +2092,7 @@ enough.
 L<guestfs-examples(3)>,
 L<guestfs-ocaml(3)>,
 L<guestfs-python(3)>,
 L<guestfs-examples(3)>,
 L<guestfs-ocaml(3)>,
 L<guestfs-python(3)>,

+L<guestfs-ruby(3)>,

 L<guestfish(1)>,
 L<guestmount(1)>,
 L<virt-cat(1)>,
 L<guestfish(1)>,
 L<guestmount(1)>,
 L<virt-cat(1)>,