Don't stash strings in the handle.

[libguestfs.git] / java / com / redhat / et / libguestfs / GuestFS.java

diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java
index 26f1aaa..c816baa 100644 (file)
--- a/java/com/redhat/et/libguestfs/GuestFS.java
+++ b/java/com/redhat/et/libguestfs/GuestFS.java
@@ -229,10 +229,6 @@ public class GuestFS {
    * You can also override this by setting the
    * "LIBGUESTFS_QEMU" environment variable.
    * 
-   * The string "qemu" is stashed in the libguestfs handle,
-   * so the caller must make sure it remains valid for the
-   * lifetime of the handle.
-   * 
    * Setting "qemu" to "NULL" restores the default qemu
    * binary.
    * 
@@ -277,10 +273,6 @@ public class GuestFS {
    * The default is "$libdir/guestfs" unless overridden by
    * setting "LIBGUESTFS_PATH" environment variable.
    * 
-   * The string "path" is stashed in the libguestfs handle,
-   * so the caller must make sure it remains valid for the
-   * lifetime of the handle.
-   * 
    * Setting "path" to "NULL" restores the default path.
    * 
    * @throws LibGuestFSException
@@ -316,6 +308,50 @@ public class GuestFS {
     throws LibGuestFSException;
 
   /**
+   * add options to kernel command line
+   *
+   * This function is used to add additional options to the
+   * guest kernel command line.
+   * 
+   * The default is "NULL" unless overridden by setting
+   * "LIBGUESTFS_APPEND" environment variable.
+   * 
+   * Setting "append" to "NULL" means *no* additional options
+   * are passed (libguestfs always adds a few of its own).
+   * 
+   * @throws LibGuestFSException
+   */
+  public void set_append (String append)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("set_append: handle is closed");
+    _set_append (g, append);
+  }
+  private native void _set_append (long g, String append)
+    throws LibGuestFSException;
+
+  /**
+   * get the additional kernel options
+   *
+   * Return the additional kernel options which are added to
+   * the guest kernel command line.
+   * 
+   * If "NULL" then no options are added.
+   * 
+   * @throws LibGuestFSException
+   */
+  public String get_append ()
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("get_append: handle is closed");
+    return _get_append (g);
+  }
+  private native String _get_append (long g)
+    throws LibGuestFSException;
+
+  /**
    * set autosync mode
    *
    * If "autosync" is true, this enables autosync. Libguestfs
@@ -1646,6 +1682,13 @@ public class GuestFS {
    * Subsequent elements are parameters. The list must be
    * non-empty (ie. must contain a program name).
    * 
+   * The return value is anything printed to *stdout* by the
+   * command.
+   * 
+   * If the command returns a non-zero exit status, then this
+   * function returns an error message. The error message
+   * string is the content of *stderr* from the command.
+   * 
    * The $PATH environment variable will contain at least
    * "/usr/bin" and "/bin". If you require a program from
    * another location, you should provide the full path in
@@ -1657,6 +1700,10 @@ public class GuestFS {
    * ensure all filesystems that are needed are mounted at
    * the right locations.
    * 
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * 
    * @throws LibGuestFSException
    */
   public String command (String[] arguments)
@@ -1675,6 +1722,10 @@ public class GuestFS {
    * This is the same as "g.command", but splits the result
    * into a list of lines.
    * 
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * 
    * @throws LibGuestFSException
    */
   public String[] command_lines (String[] arguments)