From 1b2c0e34b15a8f41f5036d127d60efed687b6c97 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Wed, 27 May 2009 12:46:04 +0100 Subject: [PATCH] Improve javadoc (RHBZ#501883). --- java/com/redhat/et/libguestfs/GuestFS.java | 858 ++++++++++++++--------------- src/generator.ml | 7 +- 2 files changed, 435 insertions(+), 430 deletions(-) diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java index 6e2304e..c7fcc11 100644 --- a/java/com/redhat/et/libguestfs/GuestFS.java +++ b/java/com/redhat/et/libguestfs/GuestFS.java @@ -83,13 +83,13 @@ public class GuestFS { /** * launch the qemu subprocess - * + *

* Internally libguestfs is implemented by running a * virtual machine using qemu(1). - * + *

* You should call this after configuring the handle (eg. * adding drives) but before performing any actions. - * + *

* @throws LibGuestFSException */ public void launch () @@ -104,13 +104,13 @@ public class GuestFS { /** * wait until the qemu subprocess launches - * + *

* Internally libguestfs is implemented by running a * virtual machine using qemu(1). - * + *

* You should call this after "g.launch" to wait for the * launch to complete. - * + *

* @throws LibGuestFSException */ public void wait_ready () @@ -125,10 +125,10 @@ public class GuestFS { /** * kill the qemu subprocess - * + *

* This kills the qemu subprocess. You should never need to * call this. - * + *

* @throws LibGuestFSException */ public void kill_subprocess () @@ -143,22 +143,22 @@ public class GuestFS { /** * add an image to examine or modify - * + *

* This function adds a virtual machine disk image * "filename" to the guest. The first time you call this * function, the disk appears as IDE disk 0 ("/dev/sda") in * the guest, the second time as "/dev/sdb", and so on. - * + *

* You don't necessarily need to be root when using * libguestfs. However you obviously do need sufficient * permissions to access the filename for whatever * operations you want to perform (ie. read access if you * just want to read the image or write access if you want * to modify the image). - * + *

* This is equivalent to the qemu parameter "-drive * file=filename". - * + *

* @throws LibGuestFSException */ public void add_drive (String filename) @@ -173,13 +173,13 @@ public class GuestFS { /** * add a CD-ROM disk image to examine - * + *

* This function adds a virtual CD-ROM disk image to the * guest. - * + *

* This is equivalent to the qemu parameter "-cdrom * filename". - * + *

* @throws LibGuestFSException */ public void add_cdrom (String filename) @@ -194,18 +194,18 @@ public class GuestFS { /** * add qemu parameters - * + *

* This can be used to add arbitrary qemu command line * parameters of the form "-param value". Actually it's not * quite arbitrary - we prevent you from setting some * parameters which would interfere with parameters that we * use. - * + *

* The first character of "param" string must be a "-" * (dash). - * + *

* "value" can be NULL. - * + *

* @throws LibGuestFSException */ public void config (String qemuparam, String qemuvalue) @@ -220,18 +220,18 @@ public class GuestFS { /** * set the qemu binary - * + *

* Set the qemu binary that we will use. - * + *

* The default is chosen when the library was compiled by * the configure script. - * + *

* You can also override this by setting the * "LIBGUESTFS_QEMU" environment variable. - * + *

* Setting "qemu" to "NULL" restores the default qemu * binary. - * + *

* @throws LibGuestFSException */ public void set_qemu (String qemu) @@ -246,12 +246,12 @@ public class GuestFS { /** * get the qemu binary - * + *

* Return the current qemu binary. - * + *

* This is always non-NULL. If it wasn't set already, then * this will return the default qemu binary name. - * + *

* @throws LibGuestFSException */ public String get_qemu () @@ -266,15 +266,15 @@ public class GuestFS { /** * set the search path - * + *

* Set the path that libguestfs searches for kernel and * initrd.img. - * + *

* The default is "$libdir/guestfs" unless overridden by * setting "LIBGUESTFS_PATH" environment variable. - * + *

* Setting "path" to "NULL" restores the default path. - * + *

* @throws LibGuestFSException */ public void set_path (String path) @@ -289,12 +289,12 @@ public class GuestFS { /** * get the search path - * + *

* Return the current search path. - * + *

* This is always non-NULL. If it wasn't set already, then * this will return the default path. - * + *

* @throws LibGuestFSException */ public String get_path () @@ -309,16 +309,16 @@ public class GuestFS { /** * 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) @@ -333,12 +333,12 @@ public class GuestFS { /** * 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 () @@ -353,15 +353,15 @@ public class GuestFS { /** * set autosync mode - * + *

* If "autosync" is true, this enables autosync. Libguestfs * will make a best effort attempt to run "g.umount_all" * followed by "g.sync" when the handle is closed (also if * the program exits without closing handles). - * + *

* This is disabled by default (except in guestfish where * it is enabled by default). - * + *

* @throws LibGuestFSException */ public void set_autosync (boolean autosync) @@ -376,9 +376,9 @@ public class GuestFS { /** * get autosync mode - * + *

* Get the autosync flag. - * + *

* @throws LibGuestFSException */ public boolean get_autosync () @@ -393,13 +393,13 @@ public class GuestFS { /** * set verbose mode - * + *

* If "verbose" is true, this turns on verbose messages (to * "stderr"). - * + *

* Verbose messages are disabled unless the environment * variable "LIBGUESTFS_DEBUG" is defined and set to 1. - * + *

* @throws LibGuestFSException */ public void set_verbose (boolean verbose) @@ -414,9 +414,9 @@ public class GuestFS { /** * get verbose mode - * + *

* This returns the verbose messages flag. - * + *

* @throws LibGuestFSException */ public boolean get_verbose () @@ -431,12 +431,12 @@ public class GuestFS { /** * is ready to accept commands - * + *

* This returns true iff this handle is ready to accept * commands (in the "READY" state). - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public boolean is_ready () @@ -451,12 +451,12 @@ public class GuestFS { /** * is in configuration state - * + *

* This returns true iff this handle is being configured * (in the "CONFIG" state). - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public boolean is_config () @@ -471,12 +471,12 @@ public class GuestFS { /** * is launching subprocess - * + *

* This returns true iff this handle is launching the * subprocess (in the "LAUNCHING" state). - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public boolean is_launching () @@ -491,12 +491,12 @@ public class GuestFS { /** * is busy processing a command - * + *

* This returns true iff this handle is busy processing a * command (in the "BUSY" state). - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public boolean is_busy () @@ -511,13 +511,13 @@ public class GuestFS { /** * get the current state - * + *

* This returns the current state as an opaque integer. * This is only useful for printing debug and internal * error messages. - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public int get_state () @@ -532,12 +532,12 @@ public class GuestFS { /** * set state to busy - * + *

* This sets the state to "BUSY". This is only used when * implementing actions using the low-level API. - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public void set_busy () @@ -552,12 +552,12 @@ public class GuestFS { /** * set state to ready - * + *

* This sets the state to "READY". This is only used when * implementing actions using the low-level API. - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public void set_ready () @@ -572,13 +572,13 @@ public class GuestFS { /** * leave the busy state - * + *

* This sets the state to "READY", or if in "CONFIG" then * it leaves the state as is. This is only used when * implementing actions using the low-level API. - * + *

* For more information on states, see guestfs(3). - * + *

* @throws LibGuestFSException */ public void end_busy () @@ -593,25 +593,25 @@ public class GuestFS { /** * mount a guest disk at a position in the filesystem - * + *

* Mount a guest disk at a position in the filesystem. * Block devices are named "/dev/sda", "/dev/sdb" and so * on, as they were added to the guest. If those block * devices contain partitions, they will have the usual * names (eg. "/dev/sda1"). Also LVM "/dev/VG/LV"-style * names can be used. - * + *

* The rules are the same as for mount(2): A filesystem * must first be mounted on "/" before others can be * mounted. Other filesystems can only be mounted on * directories which already exist. - * + *

* The mounted filesystem is writable, if we have * sufficient permissions on the underlying device. - * + *

* The filesystem options "sync" and "noatime" are set with * this call, in order to improve reliability. - * + *

* @throws LibGuestFSException */ public void mount (String device, String mountpoint) @@ -626,13 +626,13 @@ public class GuestFS { /** * sync disks, writes are flushed through to the disk image - * + *

* This syncs the disk, so that any writes are flushed * through to the underlying disk image. - * + *

* You should always call this if you have modified a disk * image, before closing the handle. - * + *

* @throws LibGuestFSException */ public void sync () @@ -647,11 +647,11 @@ public class GuestFS { /** * update file timestamps or create a new file - * + *

* Touch acts like the touch(1) command. It can be used to * update the timestamps on a file, or, if the file does * not exist, to create a new zero-length file. - * + *

* @throws LibGuestFSException */ public void touch (String path) @@ -666,19 +666,19 @@ public class GuestFS { /** * list the contents of a file - * + *

* Return the contents of the file named "path". - * + *

* Note that this function cannot correctly handle binary * files (specifically, files containing "\0" character * which is treated as end of string). For those you need * to use the "g.download" function which has a more * complex interface. - * + *

* 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 cat (String path) @@ -693,14 +693,14 @@ public class GuestFS { /** * list the files in a directory (long format) - * + *

* List the files in "directory" (relative to the root * directory, there is no cwd) in the format of 'ls -la'. - * + *

* This command is mostly useful for interactive sessions. * It is *not* intended that you try to parse the output * string. - * + *

* @throws LibGuestFSException */ public String ll (String directory) @@ -715,14 +715,14 @@ public class GuestFS { /** * list the files in a directory - * + *

* List the files in "directory" (relative to the root * directory, there is no cwd). The '.' and '..' entries * are not returned, but hidden files are shown. - * + *

* This command is mostly useful for interactive sessions. * Programs should probably use "g.readdir" instead. - * + *

* @throws LibGuestFSException */ public String[] ls (String directory) @@ -737,11 +737,11 @@ public class GuestFS { /** * list the block devices - * + *

* List all the block devices. - * + *

* The full block device names are returned, eg. "/dev/sda" - * + *

* @throws LibGuestFSException */ public String[] list_devices () @@ -756,15 +756,15 @@ public class GuestFS { /** * list the partitions - * + *

* List all the partitions detected on all block devices. - * + *

* The full partition device names are returned, eg. * "/dev/sda1" - * + *

* This does not return logical volumes. For that you will * need to call "g.lvs". - * + *

* @throws LibGuestFSException */ public String[] list_partitions () @@ -779,15 +779,15 @@ public class GuestFS { /** * list the LVM physical volumes (PVs) - * + *

* List all the physical volumes detected. This is the * equivalent of the pvs(8) command. - * + *

* This returns a list of just the device names that * contain PVs (eg. "/dev/sda2"). - * + *

* See also "g.pvs_full". - * + *

* @throws LibGuestFSException */ public String[] pvs () @@ -802,15 +802,15 @@ public class GuestFS { /** * list the LVM volume groups (VGs) - * + *

* List all the volumes groups detected. This is the * equivalent of the vgs(8) command. - * + *

* This returns a list of just the volume group names that * were detected (eg. "VolGroup00"). - * + *

* See also "g.vgs_full". - * + *

* @throws LibGuestFSException */ public String[] vgs () @@ -825,15 +825,15 @@ public class GuestFS { /** * list the LVM logical volumes (LVs) - * + *

* List all the logical volumes detected. This is the * equivalent of the lvs(8) command. - * + *

* This returns a list of the logical volume device names * (eg. "/dev/VolGroup00/LogVol00"). - * + *

* See also "g.lvs_full". - * + *

* @throws LibGuestFSException */ public String[] lvs () @@ -848,11 +848,11 @@ public class GuestFS { /** * list the LVM physical volumes (PVs) - * + *

* List all the physical volumes detected. This is the * equivalent of the pvs(8) command. The "full" version * includes all fields. - * + *

* @throws LibGuestFSException */ public PV[] pvs_full () @@ -867,11 +867,11 @@ public class GuestFS { /** * list the LVM volume groups (VGs) - * + *

* List all the volumes groups detected. This is the * equivalent of the vgs(8) command. The "full" version * includes all fields. - * + *

* @throws LibGuestFSException */ public VG[] vgs_full () @@ -886,11 +886,11 @@ public class GuestFS { /** * list the LVM logical volumes (LVs) - * + *

* List all the logical volumes detected. This is the * equivalent of the lvs(8) command. The "full" version * includes all fields. - * + *

* @throws LibGuestFSException */ public LV[] lvs_full () @@ -905,19 +905,19 @@ public class GuestFS { /** * read file as lines - * + *

* Return the contents of the file named "path". - * + *

* The file contents are returned as a list of lines. * Trailing "LF" and "CRLF" character sequences are *not* * returned. - * + *

* Note that this function cannot correctly handle binary * files (specifically, files containing "\0" character * which is treated as end of line). For those you need to * use the "g.read_file" function which has a more complex * interface. - * + *

* @throws LibGuestFSException */ public String[] read_lines (String path) @@ -932,45 +932,45 @@ public class GuestFS { /** * create a new Augeas handle - * + *

* Create a new Augeas handle for editing configuration * files. If there was any previous Augeas handle * associated with this guestfs session, then it is closed. - * + *

* You must call this before using any other "g.aug_*" * commands. - * + *

* "root" is the filesystem root. "root" must not be NULL, * use "/" instead. - * + *

* The flags are the same as the flags defined in * , the logical *or* of the following integers: - * + *

* "AUG_SAVE_BACKUP" = 1 * Keep the original file with a ".augsave" extension. - * + *

* "AUG_SAVE_NEWFILE" = 2 * Save changes into a file with extension ".augnew", * and do not overwrite original. Overrides * "AUG_SAVE_BACKUP". - * + *

* "AUG_TYPE_CHECK" = 4 * Typecheck lenses (can be expensive). - * + *

* "AUG_NO_STDINC" = 8 * Do not use standard load path for modules. - * + *

* "AUG_SAVE_NOOP" = 16 * Make save a no-op, just record what would have been * changed. - * + *

* "AUG_NO_LOAD" = 32 * Do not load the tree in "g.aug_init". - * + *

* To close the handle, you can call "g.aug_close". - * + *

* To find out more about Augeas, see . - * + *

* @throws LibGuestFSException */ public void aug_init (String root, int flags) @@ -985,12 +985,12 @@ public class GuestFS { /** * close the current Augeas handle - * + *

* Close the current Augeas handle and free up any * resources used by it. After calling this, you have to * call "g.aug_init" again before you can use any other * Augeas functions. - * + *

* @throws LibGuestFSException */ public void aug_close () @@ -1005,15 +1005,15 @@ public class GuestFS { /** * define an Augeas variable - * + *

* Defines an Augeas variable "name" whose value is the * result of evaluating "expr". If "expr" is NULL, then * "name" is undefined. - * + *

* On success this returns the number of nodes in "expr", * or 0 if "expr" evaluates to something which is not a * nodeset. - * + *

* @throws LibGuestFSException */ public int aug_defvar (String name, String expr) @@ -1028,19 +1028,19 @@ public class GuestFS { /** * define an Augeas node - * + *

* Defines a variable "name" whose value is the result of * evaluating "expr". - * + *

* If "expr" evaluates to an empty nodeset, a node is * created, equivalent to calling "g.aug_set" "expr", * "value". "name" will be the nodeset containing that * single node. - * + *

* On success this returns a pair containing the number of * nodes in the nodeset, and a boolean flag if a node was * created. - * + *

* @throws LibGuestFSException */ public IntBool aug_defnode (String name, String expr, String val) @@ -1055,10 +1055,10 @@ public class GuestFS { /** * look up the value of an Augeas path - * + *

* Look up the value associated with "path". If "path" * matches exactly one node, the "value" is returned. - * + *

* @throws LibGuestFSException */ public String aug_get (String path) @@ -1073,9 +1073,9 @@ public class GuestFS { /** * set Augeas path to value - * + *

* Set the value associated with "path" to "value". - * + *

* @throws LibGuestFSException */ public void aug_set (String path, String val) @@ -1090,15 +1090,15 @@ public class GuestFS { /** * insert a sibling Augeas node - * + *

* Create a new sibling "label" for "path", inserting it * into the tree before or after "path" (depending on the * boolean flag "before"). - * + *

* "path" must match exactly one existing node in the tree, * and "label" must be a label, ie. not contain "/", "*" or * end with a bracketed index "[N]". - * + *

* @throws LibGuestFSException */ public void aug_insert (String path, String label, boolean before) @@ -1113,12 +1113,12 @@ public class GuestFS { /** * remove an Augeas path - * + *

* Remove "path" and all of its children. - * + *

* On success this returns the number of entries which were * removed. - * + *

* @throws LibGuestFSException */ public int aug_rm (String path) @@ -1133,10 +1133,10 @@ public class GuestFS { /** * move Augeas node - * + *

* Move the node "src" to "dest". "src" must match exactly * one node. "dest" is overwritten if it exists. - * + *

* @throws LibGuestFSException */ public void aug_mv (String src, String dest) @@ -1151,11 +1151,11 @@ public class GuestFS { /** * return Augeas nodes which match path - * + *

* Returns a list of paths which match the path expression * "path". The returned paths are sufficiently qualified so * that they match exactly one node in the current tree. - * + *

* @throws LibGuestFSException */ public String[] aug_match (String path) @@ -1170,12 +1170,12 @@ public class GuestFS { /** * write all pending Augeas changes to disk - * + *

* This writes all pending changes to disk. - * + *

* The flags which were passed to "g.aug_init" affect * exactly how files are saved. - * + *

* @throws LibGuestFSException */ public void aug_save () @@ -1190,12 +1190,12 @@ public class GuestFS { /** * load files into the tree - * + *

* Load files into the tree. - * + *

* See "aug_load" in the Augeas documentation for the full * gory details. - * + *

* @throws LibGuestFSException */ public void aug_load () @@ -1210,11 +1210,11 @@ public class GuestFS { /** * list Augeas nodes under a path - * + *

* This is just a shortcut for listing "g.aug_match" * "path/*" and sorting the resulting nodes into * alphabetical order. - * + *

* @throws LibGuestFSException */ public String[] aug_ls (String path) @@ -1229,9 +1229,9 @@ public class GuestFS { /** * remove a file - * + *

* Remove the single file "path". - * + *

* @throws LibGuestFSException */ public void rm (String path) @@ -1246,9 +1246,9 @@ public class GuestFS { /** * remove a directory - * + *

* Remove the single directory "path". - * + *

* @throws LibGuestFSException */ public void rmdir (String path) @@ -1263,11 +1263,11 @@ public class GuestFS { /** * remove a file or directory recursively - * + *

* Remove the file or directory "path", recursively * removing the contents if its a directory. This is like * the "rm -rf" shell command. - * + *

* @throws LibGuestFSException */ public void rm_rf (String path) @@ -1282,9 +1282,9 @@ public class GuestFS { /** * create a directory - * + *

* Create a directory named "path". - * + *

* @throws LibGuestFSException */ public void mkdir (String path) @@ -1299,11 +1299,11 @@ public class GuestFS { /** * create a directory and parents - * + *

* Create a directory named "path", creating any parent * directories as necessary. This is like the "mkdir -p" * shell command. - * + *

* @throws LibGuestFSException */ public void mkdir_p (String path) @@ -1318,10 +1318,10 @@ public class GuestFS { /** * change file mode - * + *

* Change the mode (permissions) of "path" to "mode". Only * numeric modes are supported. - * + *

* @throws LibGuestFSException */ public void chmod (int mode, String path) @@ -1336,14 +1336,14 @@ public class GuestFS { /** * change file owner and group - * + *

* Change the file owner to "owner" and group to "group". - * + *

* Only numeric uid and gid are supported. If you want to * use names, you will need to locate and parse the * password file yourself (Augeas support makes this * relatively easy). - * + *

* @throws LibGuestFSException */ public void chown (int owner, int group, String path) @@ -1358,12 +1358,12 @@ public class GuestFS { /** * test if file or directory exists - * + *

* This returns "true" if and only if there is a file, * directory (or anything) with the given "path" name. - * + *

* See also "g.is_file", "g.is_dir", "g.stat". - * + *

* @throws LibGuestFSException */ public boolean exists (String path) @@ -1378,13 +1378,13 @@ public class GuestFS { /** * test if file exists - * + *

* This returns "true" if and only if there is a file with * the given "path" name. Note that it returns false for * other objects like directories. - * + *

* See also "g.stat". - * + *

* @throws LibGuestFSException */ public boolean is_file (String path) @@ -1399,13 +1399,13 @@ public class GuestFS { /** * test if file exists - * + *

* This returns "true" if and only if there is a directory * with the given "path" name. Note that it returns false * for other objects like files. - * + *

* See also "g.stat". - * + *

* @throws LibGuestFSException */ public boolean is_dir (String path) @@ -1420,11 +1420,11 @@ public class GuestFS { /** * create an LVM physical volume - * + *

* This creates an LVM physical volume on the named * "device", where "device" should usually be a partition * name such as "/dev/sda1". - * + *

* @throws LibGuestFSException */ public void pvcreate (String device) @@ -1439,10 +1439,10 @@ public class GuestFS { /** * create an LVM volume group - * + *

* This creates an LVM volume group called "volgroup" from * the non-empty list of physical volumes "physvols". - * + *

* @throws LibGuestFSException */ public void vgcreate (String volgroup, String[] physvols) @@ -1457,10 +1457,10 @@ public class GuestFS { /** * create an LVM volume group - * + *

* This creates an LVM volume group called "logvol" on the * volume group "volgroup", with "size" megabytes. - * + *

* @throws LibGuestFSException */ public void lvcreate (String logvol, String volgroup, int mbytes) @@ -1475,11 +1475,11 @@ public class GuestFS { /** * make a filesystem - * + *

* This creates a filesystem on "device" (usually a * partition or LVM logical volume). The filesystem type is * "fstype", for example "ext3". - * + *

* @throws LibGuestFSException */ public void mkfs (String fstype, String device) @@ -1494,13 +1494,13 @@ public class GuestFS { /** * create partitions on a block device - * + *

* This is a direct interface to the sfdisk(8) program for * creating partitions on block devices. - * + *

* "device" should be a block device, for example * "/dev/sda". - * + *

* "cyls", "heads" and "sectors" are the number of * cylinders, heads and sectors on the device, which are * passed directly to sfdisk as the *-C*, *-H* and *-S* @@ -1510,19 +1510,19 @@ public class GuestFS { * (floppy-sized) disks, sfdisk (or rather, the kernel) * cannot work out the right geometry and you will need to * tell it. - * + *

* "lines" is a list of lines that we feed to "sfdisk". For * more information refer to the sfdisk(8) manpage. - * + *

* To create a single partition occupying the whole disk, * you would pass "lines" as a single element list, when * the single element being the string "," (comma). - * + *

* See also: "g.sfdisk_l", "g.sfdisk_N" - * + *

* This command is dangerous. Without careful use you can * easily destroy all your data. - * + *

* @throws LibGuestFSException */ public void sfdisk (String device, int cyls, int heads, int sectors, String[] lines) @@ -1537,24 +1537,24 @@ public class GuestFS { /** * create a file - * + *

* This call creates a file called "path". The contents of * the file is the string "content" (which can contain any * 8 bit data), with length "size". - * + *

* As a special case, if "size" is 0 then the length is * calculated using "strlen" (so in this case the content * cannot contain embedded ASCII NULs). - * + *

* *NB.* Owing to a bug, writing content containing ASCII * NUL characters does *not* work, even if the length is * specified. We hope to resolve this bug in a future * version. In the meantime use "g.upload". - * + *

* 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 void write_file (String path, String content, int size) @@ -1569,11 +1569,11 @@ public class GuestFS { /** * unmount a filesystem - * + *

* This unmounts the given filesystem. The filesystem may * be specified either by its mountpoint (path) or the * device which contains the filesystem. - * + *

* @throws LibGuestFSException */ public void umount (String pathordevice) @@ -1588,13 +1588,13 @@ public class GuestFS { /** * show mounted filesystems - * + *

* This returns the list of currently mounted filesystems. * It returns the list of devices (eg. "/dev/sda1", * "/dev/VG/LV"). - * + *

* Some internal mounts are not shown. - * + *

* @throws LibGuestFSException */ public String[] mounts () @@ -1609,11 +1609,11 @@ public class GuestFS { /** * unmount all filesystems - * + *

* This unmounts all mounted filesystems. - * + *

* Some internal mounts are not unmounted by this call. - * + *

* @throws LibGuestFSException */ public void umount_all () @@ -1628,13 +1628,13 @@ public class GuestFS { /** * remove all LVM LVs, VGs and PVs - * + *

* This command removes all LVM logical volumes, volume * groups and physical volumes. - * + *

* This command is dangerous. Without careful use you can * easily destroy all your data. - * + *

* @throws LibGuestFSException */ public void lvm_remove_all () @@ -1649,16 +1649,16 @@ public class GuestFS { /** * determine file type - * + *

* This call uses the standard file(1) command to determine * the type or contents of the file. This also works on * devices, for example to find out whether a partition * contains a filesystem. - * + *

* The exact command which runs is "file -bsL path". Note * in particular that the filename is not prepended to the * output (the "-b" option). - * + *

* @throws LibGuestFSException */ public String file (String path) @@ -1673,39 +1673,39 @@ public class GuestFS { /** * run a command from the guest filesystem - * + *

* This call runs a command from the guest filesystem. The * filesystem must be mounted, and must contain a * compatible operating system (ie. something Linux, with * the same or compatible processor architecture). - * + *

* The single parameter is an argv-style list of arguments. * The first element is the name of the program to run. * 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 * the first parameter. - * + *

* Shared libraries and data files required by the program * must be available on filesystems which are mounted in * the correct places. It is the caller's responsibility to * 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) @@ -1720,14 +1720,14 @@ public class GuestFS { /** * run a command, returning lines - * + *

* 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) @@ -1742,11 +1742,11 @@ public class GuestFS { /** * get file information - * + *

* Returns file information for the given "path". - * + *

* This is the same as the stat(2) system call. - * + *

* @throws LibGuestFSException */ public Stat stat (String path) @@ -1761,15 +1761,15 @@ public class GuestFS { /** * get file information for a symbolic link - * + *

* Returns file information for the given "path". - * + *

* This is the same as "g.stat" except that if "path" is a * symbolic link, then the link is stat-ed, not the file it * refers to. - * + *

* This is the same as the lstat(2) system call. - * + *

* @throws LibGuestFSException */ public Stat lstat (String path) @@ -1784,14 +1784,14 @@ public class GuestFS { /** * get file system statistics - * + *

* Returns file system statistics for any mounted file * system. "path" should be a file or directory in the * mounted file system (typically it is the mount point * itself, but it doesn't need to be). - * + *

* This is the same as the statvfs(2) system call. - * + *

* @throws LibGuestFSException */ public StatVFS statvfs (String path) @@ -1806,16 +1806,16 @@ public class GuestFS { /** * get ext2/ext3/ext4 superblock details - * + *

* This returns the contents of the ext2, ext3 or ext4 * filesystem superblock on "device". - * + *

* It is the same as running "tune2fs -l device". See * tune2fs(8) manpage for more details. The list of fields * returned isn't clearly defined, and depends on both the * version of "tune2fs" that libguestfs was built against, * and the filesystem itself. - * + *

* @throws LibGuestFSException */ public HashMap tune2fs_l (String device) @@ -1830,11 +1830,11 @@ public class GuestFS { /** * set block device to read-only - * + *

* Sets the block device named "device" to read-only. - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public void blockdev_setro (String device) @@ -1849,11 +1849,11 @@ public class GuestFS { /** * set block device to read-write - * + *

* Sets the block device named "device" to read-write. - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public void blockdev_setrw (String device) @@ -1868,12 +1868,12 @@ public class GuestFS { /** * is block device set to read-only - * + *

* Returns a boolean indicating if the block device is * read-only (true if read-only, false if not). - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public boolean blockdev_getro (String device) @@ -1888,15 +1888,15 @@ public class GuestFS { /** * get sectorsize of block device - * + *

* This returns the size of sectors on a block device. * Usually 512, but can be larger for modern devices. - * + *

* (Note, this is not the size in sectors, use * "g.blockdev_getsz" for that). - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public int blockdev_getss (String device) @@ -1911,14 +1911,14 @@ public class GuestFS { /** * get blocksize of block device - * + *

* This returns the block size of a device. - * + *

* (Note this is different from both *size in blocks* and * *filesystem block size*). - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public int blockdev_getbsz (String device) @@ -1933,14 +1933,14 @@ public class GuestFS { /** * set blocksize of block device - * + *

* This sets the block size of a device. - * + *

* (Note this is different from both *size in blocks* and * *filesystem block size*). - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public void blockdev_setbsz (String device, int blocksize) @@ -1955,17 +1955,17 @@ public class GuestFS { /** * get total size of device in 512-byte sectors - * + *

* This returns the size of the device in units of 512-byte * sectors (even if the sectorsize isn't 512 bytes ... * weird). - * + *

* See also "g.blockdev_getss" for the real sector size of * the device, and "g.blockdev_getsize64" for the more * useful *size in bytes*. - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public long blockdev_getsz (String device) @@ -1980,13 +1980,13 @@ public class GuestFS { /** * get total size of device in bytes - * + *

* This returns the size of the device in bytes. - * + *

* See also "g.blockdev_getsz". - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public long blockdev_getsize64 (String device) @@ -2001,12 +2001,12 @@ public class GuestFS { /** * flush device buffers - * + *

* This tells the kernel to flush internal buffers * associated with "device". - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public void blockdev_flushbufs (String device) @@ -2021,11 +2021,11 @@ public class GuestFS { /** * reread partition table - * + *

* Reread the partition table on "device". - * + *

* This uses the blockdev(8) command. - * + *

* @throws LibGuestFSException */ public void blockdev_rereadpt (String device) @@ -2040,14 +2040,14 @@ public class GuestFS { /** * upload a file from the local machine - * + *

* Upload local file "filename" to "remotefilename" on the * filesystem. - * + *

* "filename" can also be a named pipe. - * + *

* See also "g.download". - * + *

* @throws LibGuestFSException */ public void upload (String filename, String remotefilename) @@ -2062,14 +2062,14 @@ public class GuestFS { /** * download a file to the local machine - * + *

* Download file "remotefilename" and save it as "filename" * on the local machine. - * + *

* "filename" can also be a named pipe. - * + *

* See also "g.upload", "g.cat". - * + *

* @throws LibGuestFSException */ public void download (String remotefilename, String filename) @@ -2084,42 +2084,42 @@ public class GuestFS { /** * compute MD5, SHAx or CRC checksum of file - * + *

* This call computes the MD5, SHAx or CRC checksum of the * file named "path". - * + *

* The type of checksum to compute is given by the * "csumtype" parameter which must have one of the * following values: - * + *

* "crc" * Compute the cyclic redundancy check (CRC) specified * by POSIX for the "cksum" command. - * + *

* "md5" * Compute the MD5 hash (using the "md5sum" program). - * + *

* "sha1" * Compute the SHA1 hash (using the "sha1sum" program). - * + *

* "sha224" * Compute the SHA224 hash (using the "sha224sum" * program). - * + *

* "sha256" * Compute the SHA256 hash (using the "sha256sum" * program). - * + *

* "sha384" * Compute the SHA384 hash (using the "sha384sum" * program). - * + *

* "sha512" * Compute the SHA512 hash (using the "sha512sum" * program). - * + *

* The checksum is returned as a printable string. - * + *

* @throws LibGuestFSException */ public String checksum (String csumtype, String path) @@ -2134,12 +2134,12 @@ public class GuestFS { /** * unpack tarfile to directory - * + *

* This command uploads and unpacks local file "tarfile" * (an *uncompressed* tar file) into "directory". - * + *

* To upload a compressed tarball, use "g.tgz_in". - * + *

* @throws LibGuestFSException */ public void tar_in (String tarfile, String directory) @@ -2154,12 +2154,12 @@ public class GuestFS { /** * pack directory into tarfile - * + *

* This command packs the contents of "directory" and * downloads it to local file "tarfile". - * + *

* To download a compressed tarball, use "g.tgz_out". - * + *

* @throws LibGuestFSException */ public void tar_out (String directory, String tarfile) @@ -2174,12 +2174,12 @@ public class GuestFS { /** * unpack compressed tarball to directory - * + *

* This command uploads and unpacks local file "tarball" (a * *gzip compressed* tar file) into "directory". - * + *

* To upload an uncompressed tarball, use "g.tar_in". - * + *

* @throws LibGuestFSException */ public void tgz_in (String tarball, String directory) @@ -2194,12 +2194,12 @@ public class GuestFS { /** * pack directory into compressed tarball - * + *

* This command packs the contents of "directory" and * downloads it to local file "tarball". - * + *

* To download an uncompressed tarball, use "g.tar_out". - * + *

* @throws LibGuestFSException */ public void tgz_out (String directory, String tarball) @@ -2214,10 +2214,10 @@ public class GuestFS { /** * mount a guest disk, read-only - * + *

* This is the same as the "g.mount" command, but it mounts * the filesystem with the read-only (*-o ro*) flag. - * + *

* @throws LibGuestFSException */ public void mount_ro (String device, String mountpoint) @@ -2232,11 +2232,11 @@ public class GuestFS { /** * mount a guest disk with mount options - * + *

* This is the same as the "g.mount" command, but it allows * you to set the mount options as for the mount(8) *-o* * flag. - * + *

* @throws LibGuestFSException */ public void mount_options (String options, String device, String mountpoint) @@ -2251,11 +2251,11 @@ public class GuestFS { /** * mount a guest disk with mount options and vfstype - * + *

* This is the same as the "g.mount" command, but it allows * you to set both the mount options and the vfstype as for * the mount(8) *-o* and *-t* flags. - * + *

* @throws LibGuestFSException */ public void mount_vfs (String options, String vfstype, String device, String mountpoint) @@ -2270,15 +2270,15 @@ public class GuestFS { /** * debugging and internals - * + *

* The "g.debug" command exposes some internals of * "guestfsd" (the guestfs daemon) that runs inside the * qemu subprocess. - * + *

* There is no comprehensive help for this command. You * have to look at the file "daemon/debug.c" in the * libguestfs source to find out what you can do. - * + *

* @throws LibGuestFSException */ public String debug (String subcmd, String[] extraargs) @@ -2293,13 +2293,13 @@ public class GuestFS { /** * remove an LVM logical volume - * + *

* Remove an LVM logical volume "device", where "device" is * the path to the LV, such as "/dev/VG/LV". - * + *

* You can also remove all LVs in a volume group by * specifying the VG name, "/dev/VG". - * + *

* @throws LibGuestFSException */ public void lvremove (String device) @@ -2314,12 +2314,12 @@ public class GuestFS { /** * remove an LVM volume group - * + *

* Remove an LVM volume group "vgname", (for example "VG"). - * + *

* This also forcibly removes all logical volumes in the * volume group (if any). - * + *

* @throws LibGuestFSException */ public void vgremove (String vgname) @@ -2334,14 +2334,14 @@ public class GuestFS { /** * remove an LVM physical volume - * + *

* This wipes a physical volume "device" so that LVM will * no longer recognise it. - * + *

* The implementation uses the "pvremove" command which * refuses to wipe physical volumes that contain any volume * groups, so you have to remove those first. - * + *

* @throws LibGuestFSException */ public void pvremove (String device) @@ -2356,14 +2356,14 @@ public class GuestFS { /** * set the ext2/3/4 filesystem label - * + *

* This sets the ext2/3/4 filesystem label of the * filesystem on "device" to "label". Filesystem labels are * limited to 16 characters. - * + *

* You can use either "g.tune2fs_l" or "g.get_e2label" to * return the existing label on a filesystem. - * + *

* @throws LibGuestFSException */ public void set_e2label (String device, String label) @@ -2378,10 +2378,10 @@ public class GuestFS { /** * get the ext2/3/4 filesystem label - * + *

* This returns the ext2/3/4 filesystem label of the * filesystem on "device". - * + *

* @throws LibGuestFSException */ public String get_e2label (String device) @@ -2396,15 +2396,15 @@ public class GuestFS { /** * set the ext2/3/4 filesystem UUID - * + *

* This sets the ext2/3/4 filesystem UUID of the filesystem * on "device" to "uuid". The format of the UUID and * alternatives such as "clear", "random" and "time" are * described in the tune2fs(8) manpage. - * + *

* You can use either "g.tune2fs_l" or "g.get_e2uuid" to * return the existing UUID of a filesystem. - * + *

* @throws LibGuestFSException */ public void set_e2uuid (String device, String uuid) @@ -2419,10 +2419,10 @@ public class GuestFS { /** * get the ext2/3/4 filesystem UUID - * + *

* This returns the ext2/3/4 filesystem UUID of the * filesystem on "device". - * + *

* @throws LibGuestFSException */ public String get_e2uuid (String device) @@ -2437,27 +2437,27 @@ public class GuestFS { /** * run the filesystem checker - * + *

* This runs the filesystem checker (fsck) on "device" * which should have filesystem type "fstype". - * + *

* The returned integer is the status. See fsck(8) for the * list of status codes from "fsck". - * + *

* Notes: - * + *

* * Multiple status codes can be summed together. - * + *

* * A non-zero return code can mean "success", for * example if errors have been corrected on the * filesystem. - * + *

* * Checking or repairing NTFS volumes is not supported * (by linux-ntfs). - * + *

* This command is entirely equivalent to running "fsck -a * -t fstype device". - * + *

* @throws LibGuestFSException */ public int fsck (String fstype, String device) @@ -2472,15 +2472,15 @@ public class GuestFS { /** * write zeroes to the device - * + *

* This command writes zeroes over the first few blocks of * "device". - * + *

* How many blocks are zeroed isn't specified (but it's * *not* enough to securely wipe the device). It should be * sufficient to remove any partition tables, filesystem * superblocks and so on. - * + *

* @throws LibGuestFSException */ public void zero (String device) @@ -2495,11 +2495,11 @@ public class GuestFS { /** * install GRUB - * + *

* This command installs GRUB (the Grand Unified * Bootloader) on "device", with the root directory being * "root". - * + *

* @throws LibGuestFSException */ public void grub_install (String root, String device) @@ -2514,10 +2514,10 @@ public class GuestFS { /** * copy a file - * + *

* This copies a file from "src" to "dest" where "dest" is * either a destination filename or destination directory. - * + *

* @throws LibGuestFSException */ public void cp (String src, String dest) @@ -2532,10 +2532,10 @@ public class GuestFS { /** * copy a file or directory recursively - * + *

* This copies a file or directory from "src" to "dest" * recursively using the "cp -a" command. - * + *

* @throws LibGuestFSException */ public void cp_a (String src, String dest) @@ -2550,10 +2550,10 @@ public class GuestFS { /** * move a file - * + *

* This moves a file from "src" to "dest" where "dest" is * either a destination filename or destination directory. - * + *

* @throws LibGuestFSException */ public void mv (String src, String dest) @@ -2568,17 +2568,17 @@ public class GuestFS { /** * drop kernel page cache, dentries and inodes - * + *

* This instructs the guest kernel to drop its page cache, * and/or dentries and inode caches. The parameter * "whattodrop" tells the kernel what precisely to drop, * see - * + *

* Setting "whattodrop" to 3 should drop everything. - * + *

* This automatically calls sync(2) before the operation, * so that the maximum guest memory is freed. - * + *

* @throws LibGuestFSException */ public void drop_caches (int whattodrop) @@ -2593,16 +2593,16 @@ public class GuestFS { /** * return kernel messages - * + *

* This returns the kernel messages ("dmesg" output) from * the guest kernel. This is sometimes useful for extended * debugging of problems. - * + *

* Another way to get the same information is to enable * verbose messages with "g.set_verbose" or by setting the * environment variable "LIBGUESTFS_DEBUG=1" before running * the program. - * + *

* @throws LibGuestFSException */ public String dmesg () @@ -2617,13 +2617,13 @@ public class GuestFS { /** * ping the guest daemon - * + *

* This is a test probe into the guestfs daemon running * inside the qemu subprocess. Calling this function checks * that the daemon responds to the ping message, without * affecting the daemon or attached block device(s) in any * other way. - * + *

* @throws LibGuestFSException */ public void ping_daemon () @@ -2638,13 +2638,13 @@ public class GuestFS { /** * test if two files have equal contents - * + *

* This compares the two files "file1" and "file2" and * returns true if their content is exactly equal, or false * otherwise. - * + *

* The external cmp(1) program is used for the comparison. - * + *

* @throws LibGuestFSException */ public boolean equal (String file1, String file2) @@ -2659,14 +2659,14 @@ public class GuestFS { /** * print the printable strings in a file - * + *

* This runs the strings(1) command on a file and returns * the list of printable strings found. - * + *

* 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[] strings (String path) @@ -2681,22 +2681,22 @@ public class GuestFS { /** * print the printable strings in a file - * + *

* This is like the "g.strings" command, but allows you to * specify the encoding. - * + *

* See the strings(1) manpage for the full list of * encodings. - * + *

* Commonly useful encodings are "l" (lower case L) which * will show strings inside Windows/x86 files. - * + *

* The returned strings are transcoded to UTF-8. - * + *

* 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[] strings_e (String encoding, String path) @@ -2711,14 +2711,14 @@ public class GuestFS { /** * dump a file in hexadecimal - * + *

* This runs "hexdump -C" on the given "path". The result * is the human-readable, canonical hex dump of the file. - * + *

* 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 hexdump (String path) @@ -2733,18 +2733,18 @@ public class GuestFS { /** * zero unused inodes and disk blocks on ext2/3 filesystem - * + *

* This runs the *zerofree* program on "device". This * program claims to zero unused inodes and disk blocks on * an ext2/3 filesystem, thus making it possible to * compress the filesystem more effectively. - * + *

* You should not run this program if the filesystem is * mounted. - * + *

* It is possible that using this program can damage the * filesystem or data on the filesystem. - * + *

* @throws LibGuestFSException */ public void zerofree (String device) @@ -2759,11 +2759,11 @@ public class GuestFS { /** * resize an LVM physical volume - * + *

* This resizes (expands or shrinks) an existing LVM * physical volume to match the new size of the underlying * device. - * + *

* @throws LibGuestFSException */ public void pvresize (String device) @@ -2778,16 +2778,16 @@ public class GuestFS { /** * modify a single partition on a block device - * + *

* This runs sfdisk(8) option to modify just the single * partition "n" (note: "n" counts from 1). - * + *

* For other parameters, see "g.sfdisk". You should usually * pass 0 for the cyls/heads/sectors parameters. - * + *

* This command is dangerous. Without careful use you can * easily destroy all your data. - * + *

* @throws LibGuestFSException */ public void sfdisk_N (String device, int n, int cyls, int heads, int sectors, String line) @@ -2802,11 +2802,11 @@ public class GuestFS { /** * display the partition table - * + *

* This displays the partition table on "device", in the * human-readable output of the sfdisk(8) command. It is * not intended to be parsed. - * + *

* @throws LibGuestFSException */ public String sfdisk_l (String device) @@ -2821,13 +2821,13 @@ public class GuestFS { /** * display the kernel geometry - * + *

* This displays the kernel's idea of the geometry of * "device". - * + *

* The result is in human-readable format, and not designed * to be parsed. - * + *

* @throws LibGuestFSException */ public String sfdisk_kernel_geometry (String device) @@ -2842,16 +2842,16 @@ public class GuestFS { /** * display the disk geometry from the partition table - * + *

* This displays the disk geometry of "device" read from * the partition table. Especially in the case where the * underlying block device has been resized, this can be * different from the kernel's idea of the geometry (see * "g.sfdisk_kernel_geometry"). - * + *

* The result is in human-readable format, and not designed * to be parsed. - * + *

* @throws LibGuestFSException */ public String sfdisk_disk_geometry (String device) @@ -2866,15 +2866,15 @@ public class GuestFS { /** * activate or deactivate all volume groups - * + *

* This command activates or (if "activate" is false) * deactivates all logical volumes in all volume groups. If * activated, then they are made known to the kernel, ie. * they appear as "/dev/mapper" devices. If deactivated, * then those devices disappear. - * + *

* This command is the same as running "vgchange -a y|n" - * + *

* @throws LibGuestFSException */ public void vg_activate_all (boolean activate) @@ -2889,19 +2889,19 @@ public class GuestFS { /** * activate or deactivate some volume groups - * + *

* This command activates or (if "activate" is false) * deactivates all logical volumes in the listed volume * groups "volgroups". If activated, then they are made * known to the kernel, ie. they appear as "/dev/mapper" * devices. If deactivated, then those devices disappear. - * + *

* This command is the same as running "vgchange -a y|n * volgroups..." - * + *

* Note that if "volgroups" is an empty list then all * volume groups are activated or deactivated. - * + *

* @throws LibGuestFSException */ public void vg_activate (boolean activate, String[] volgroups) @@ -2916,11 +2916,11 @@ public class GuestFS { /** * resize an LVM logical volume - * + *

* This resizes (expands or shrinks) an existing LVM * logical volume to "mbytes". When reducing, data in the * reduced part is lost. - * + *

* @throws LibGuestFSException */ public void lvresize (String device, int mbytes) @@ -2935,17 +2935,17 @@ public class GuestFS { /** * resize an ext2/ext3 filesystem - * + *

* This resizes an ext2 or ext3 filesystem to match the * size of the underlying device. - * + *

* *Note:* It is sometimes required that you run * "g.e2fsck_f" on the "device" before calling this * command. For unknown reasons "resize2fs" sometimes gives * an error about this and sometimes not. In any case, it * is always safe to call "g.e2fsck_f" before calling this * function. - * + *

* @throws LibGuestFSException */ public void resize2fs (String device) @@ -2960,33 +2960,33 @@ public class GuestFS { /** * find all files and directories - * + *

* This command lists out all files and directories, * recursively, starting at "directory". It is essentially * equivalent to running the shell command "find directory * -print" but some post-processing happens on the output, * described below. - * + *

* This returns a list of strings *without any prefix*. * Thus if the directory structure was: - * + *

* /tmp/a * /tmp/b * /tmp/c/d - * + *

* then the returned list from "g.find" "/tmp" would be 4 * elements: - * + *

* a * b * c * c/d - * + *

* If "directory" is not a directory, then this command * returns an error. - * + *

* The returned list is sorted. - * + *

* @throws LibGuestFSException */ public String[] find (String directory) @@ -3001,14 +3001,14 @@ public class GuestFS { /** * check an ext2/ext3 filesystem - * + *

* This runs "e2fsck -p -f device", ie. runs the ext2/ext3 * filesystem checker on "device", noninteractively ("-p"), * even if the filesystem appears to be clean ("-f"). - * + *

* This command is only needed because of "g.resize2fs" * (q.v.). Normally you should use "g.fsck". - * + *

* @throws LibGuestFSException */ public void e2fsck_f (String device) diff --git a/src/generator.ml b/src/generator.ml index 9c210bc..4e18f98 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -6492,11 +6492,16 @@ public class GuestFS { doc ^ "\n\n" ^ danger_will_robinson else doc in let doc = pod2text ~width:60 name doc in + let doc = List.map ( (* RHBZ#501883 *) + function + | "" -> "

" + | nonempty -> nonempty + ) doc in let doc = String.concat "\n * " doc in pr " /**\n"; pr " * %s\n" shortdesc; - pr " *\n"; + pr " *

\n"; pr " * %s\n" doc; pr " * @throws LibGuestFSException\n"; pr " */\n"; -- 1.8.3.1