RELEASE-NOTES

   1 Release notes for libguestfs 1.8.0
   2 ----------------------------------
   3
   4 Updated to commit 0b2a3bd8404a72a3b7e99e330143c26bf42d458a (1.7.16).
   5
   6 These release notes only cover the differences from the previous
   7 stable/dev branch split (1.6.0).  For detailed changelogs, please see
   8 the git repository, or the ChangeLog file distributed in the tarball.
   9
  10 New features
  11
  12  - The following tools have been rewritten in C (originally in Perl):
  13
  14      . virt-cat
  15      . virt-df
  16      . virt-inspector
  17      . virt-ls
  18      . virt-rescue
  19
  20  - Some C tools support encrypted guests automatically.  This is
  21    supported in: guestfish, guestmount, virt-cat, virt-inspector,
  22    virt-ls.
  23
  24  - New tool virt-filesystems (in C) which is a replacement for
  25    virt-list-filesystems and virt-list-partitions, and has a superset
  26    of the functionality of those tools.
  27
  28  - guestfish, guestmount and the C tools use unified command line option
  29    parsing, so they support many common options such as '-a disk.img',
  30    '-d libvirt-domain', '-x', '-v'.  The old command line option
  31    parsing is preserved for compatibility in scripts etc.
  32
  33  - guestfish no longer has any dependencies on Perl
  34
  35  - New man pages containing programming examples: guestfs-examples(3) (C/C++),
  36    guestfs-ocaml(3), guestfs-python(3), guestfs-ruby(3).
  37
  38  - Trace mode prints return values from API functions.
  39
  40  - virt-inspector can list applications installed in Windows guests, along
  41    with a great deal of information about those applications.
  42
  43  - Add support for inspecting: Linux Mint, Mandriva, FreeBSD.
  44
  45  - guestfish --rw option (with no effect currently) to make potentially
  46    dangerous write access explicit.
  47
  48  - guestfish --listen --csh for compatibility with csh, tcsh (thanks
  49    Eric Blake).
  50
  51  - The first upstream version that introduced each API function is now
  52    documented in guestfs(3).
  53
  54  - guestfs_last_errno allows you to retrieve the errno from the
  55    daemon, correctly translated to the local operating system.
  56
  57  - Some functions now support optional parameters.
  58
  59 Security
  60
  61  - New SECURITY section in guestfs(3) API documentation.
  62
  63  - virt-inspector no longer runs any guest commands.
  64
  65  - Inspection code is more careful about avoiding very large files
  66    from guests which might previously have caused a denial of service.
  67
  68 New APIs
  69
  70  - add-domain
  71  - add-drive-opts
  72  - inspect-get-hostname
  73  - inspect-get-package-format
  74  - inspect-get-package-management
  75  - inspect-get-roots
  76  - inspect-list-applications
  77
  78 Internals
  79
  80  - C programs now only link precisely with the libraries that they use.
  81
  82  - PCRE, libmagic, hivex and libvirt libraries are now completely
  83    optional for building.
  84
  85  - Multiple memory leaks and file descriptor leaks fixed.
  86
  87  - Add a POD wrapper to unify generation of man pages and HTML files
  88    across all programs.
  89
  90  - Source includes phony images of Fedora, Debian, Ubuntu and
  91    Windows guests.
  92
  93  - Ruby bindings have 'make install' rule.
  94
  95  - <guestfs.h> is now a single file.
  96
  97  - <guestfs.h> does not require XDR headers.
  98
  99  - ocaml xml-light library is no longer required to build (thanks
 100    Maxim Koltsov).
 101
 102  - ./configure --disable-[...] for each language binding (thanks
 103    Maxim Koltsov).
 104
 105  - Old ocaml-viewer program removed (use guestfs-browser instead).
 106
 107 Bugs fixed
 108
 109  - 657499 checksum: wrong check sum type causes umount to fail
 110  - 655554 Whole disk paths are not made canonical by virt-inspector
 111  - 654638 openssl updated to 1.0.0b libguestfs depends on exact file names
 112  - 652796 ruby bindings not installed by 'make install', hence omitted from the binary distribution
 113
 114 Release notes for libguestfs 1.6.0
 115 ----------------------------------
 116
 117 These release notes only cover the differences from the previous
 118 stable/dev branch split (1.4.0).  For detailed changelogs, please see
 119 the git repository, or the ChangeLog file distributed in the tarball.
 120
 121 New features
 122
 123  - Use a new method for creating and caching the appliance.  This
 124    greatly improves the performance of libguestfs, often by a factor
 125    of x 4 to x 5.
 126
 127  - Support for guest inspection (like virt-inspector) via the ordinary
 128    API and all language bindings.  'guestfish -i' option is as a side-
 129    effect much quicker.
 130
 131  - virt-inspector and core inspection API can now detect guests running:
 132    Fedora, Debian, Ubuntu, Windows, Red Hat Enterprise Linux, CentOS,
 133    Scientific Linux, Gentoo, Pardus, Arch Linux, MeeGo.
 134
 135  - Support for LUKS whole-disk encryption in guests.
 136
 137  - PHP bindings.
 138
 139  - Progress messages (and progress bars in guestfish and virt-resize)
 140    for certain long-running operations.
 141
 142  - virt-df is now much more efficient.  Use '--one-per-guest' to restore
 143    the old per-guest isolation behaviour.
 144
 145  - guestfish 'copy-in' and 'copy-out' commands for copying files and
 146    directories recursively in and out of the guest.
 147
 148  - guestfish 'hexedit' command for doing binary edits to devices and
 149    files.
 150
 151  - Change guestfish -i syntax to allow commands to be specified on the
 152    command line (retaining backwards compatibility).
 153
 154  - guestfish '-d <domain>' for adding disks from libvirt domains.
 155
 156  - guestfish '-N' option supports several new prepared disk image types:
 157          lvfs : disk with LV formatted with filesystem
 158            lv : disk with LV
 159      bootroot : boot+root
 160    bootrootlv : boot and root on LV
 161
 162  - guestfish 'more' and 'edit' commands now work with arbitrary files.
 163
 164  - guestfish '--echo-keys' option allows you to echo keys/passphrases
 165    while typing them.
 166
 167  - guestmount now supports -a / -d / -i options, like guestfish.
 168
 169  - Use virtio-serial for communications with the appliance.  This
 170    also has a major performance benefit.
 171
 172  - virt-edit '-b' option to create a backup of edited files.
 173
 174  - virt-edit '-e' option for non-interactive edits to files.
 175
 176  - Ability to capture core dumps from the appliance (thanks Matthew Booth).
 177
 178  - virt-rescue now shuts down cleanly (thanks Matthew Booth).
 179
 180  - virt-rescue now has a --network option to enable network access.
 181
 182  - virt-resize can now handle guests which use GPT partition table format.
 183
 184  - virt-resize has better support for shrinking guests.
 185
 186  - virt-resize supports qcow2-format guests.
 187
 188  - $TMPDIR can be used to override almost all temporary directory usage.
 189
 190  - OCaml users can use an alternate OO-style of coding, eg. g#launch ()
 191
 192  - The API supports calls which take optional parameters, eg.
 193      $g->add_drive_opts ("disk", readonly => 1);
 194
 195  - Trace output now escapes and shortens large strings (thanks
 196    Matthew Booth).
 197
 198  - Autosync is now on by default, resulting in more reliable behaviour
 199    when the handle is closed.
 200
 201  - virt-df --uuid option allows you to follow a domain across migration
 202    and renaming.
 203
 204  - Translations of manual pages.
 205
 206 Security
 207
 208  - CVE-2010-3851 libguestfs: missing disk format specifier when adding a disk
 209    https://www.redhat.com/archives/libguestfs/2010-October/msg00036.html
 210    This is comprehensively fixed in this release, and the fix will be
 211    backported to the other stable branches after more testing.
 212
 213  - virt-inspector no longer relies on untrusted guest code to list
 214    applications in some guests.
 215
 216 New APIs
 217
 218   download-offset, file-architecture, findfs-label, findfs-uuid,
 219   inspect-os, inspect-get-arch, inspect-get-distro,
 220   inspect-get-filesystems, inspect-get-major-version,
 221   inspect-get-minor-version, inspect-get-mountpoints,
 222   inspect-get-product-name, inspect-get-type, is-blockdev, is-chardev,
 223   is-fifo, is-lv, is-socket, is-symlink, list-filesystems, luks-add-key,
 224   luks-close, luks-format, luks-format-cipher, luks-kill-slot,
 225   luks-open, luks-open-ro, lvm-clear-filter, lvm-canonical-lv-name,
 226   lvm-set-filter, part-to-dev, pread-device, pwrite-device,
 227   upload-offset
 228
 229 Internals
 230
 231  - Use size_t for loop iterators.
 232  - Refactor the library code into separate files.
 233  - Refactor the generator code into separate files.
 234  - Generate guestfish commands.
 235  - guestfish & guestmount options processing is unified.
 236  - Protocol changes:
 237      error message size increased to 64K
 238      send errno to library
 239  - Add 'make bindist' to make a binary distribution.
 240  - Cleaner behaviour under valgrind.
 241  - More testing of the guestfish command line options and libvirt
 242    integration.
 243  - The Perl inspection code is no longer used by any of the tools.
 244
 245 Bugs fixed
 246
 247  - 646822 libguestfs trace mode should not print long binary strings
 248  - 646821 virt-df should have --uuid option
 249  - 646432 /dev/mapper paths should not be returned from guestfs_mountpoints
 250  - 643624 libguestfs tools documentation should describe how to quote guest domain names from shell
 251  - 642934 No way to specify disk format when adding a disk to libguestfs
 252  - 642933 guestfs_list_filesystems should be used in all possible places
 253  - 642932 guestmount options should match guestfish options
 254  - 642930 virt-inspector (Sys::Guestfs::Lib) should use C inspection APIs
 255  - 642929 C inspection code should ignore /dev/fd* in /etc/fstab
 256  - 642826 virt-resize converts any other image format to raw without notifying user, instructions do not account for this
 257  - 640961 Document that grub-install might be needed for old Linux guests after virt-resize
 258  - 639986 virt-df --csv does not properly quote " in libvirt domain names
 259  - 639405 Interrupted cached appliance creation leaves libguestfs unusable
 260  - 638901 Appliance filename should not contain repository name
 261  - 638899 /dev/mapper paths should not be returned from C inspection APIs
 262  - 636918 Updates to Spanish translation
 263  - 636061 [abrt] guestfish-1.2.11-1.fc12: malloc_consolidate: Process /usr/bin/guestfish was killed by signal 11 (SIGSEGV)
 264  - 635969 glob echo mkfs ext2 /dev/vd[b-t]1 prints garbage
 265  - 634246 guestfs_part_get_parttype returns "loop" when run against a partition, LV or filesystem
 266  - 633766 virt-resize --shrink fails
 267  - 633357 Updates to Spanish translation
 268  - 633096 virt-resize calculates block device size incorrectly, doesn't work with qcow2 target
 269  - 629593 Dutch translation added
 270  - 627556 Updates to Spanish translations of libguestfs
 271  - 626843 Updates to Spanish translations
 272  - 619793 [RFE] Need a way to determine if a particular block device is a logical volume
 273  - 618556 virt-rescue return none zero value when exit
 274  - 617200 mount operation failed and hung on some images which running in read-only mode
 275  - 610880 libguestfs should set broader read perms on tmpdir, so works in some situations when executed with umask 077
 276  - 599503 document that mkmountpoint and umount-all cannot be mixed
 277  - 571714 Running virt-df on disk image relabels it, so qemu can no longer write to it.
 278  - 502533 Updated Polish translation of libguestfs
 279
 280 Release notes for libguestfs 1.4.0
 281 ----------------------------------
 282
 283 These release notes only cover the differences from the previous
 284 stable/dev branch split (1.2.0).  For detailed changelogs, please see
 285 the git repository, or the ChangeLog file distributed in the tarball.
 286
 287 New features
 288
 289  - guestfish lets you choose a prepared disk image, eg:
 290      guestfish -N fs:ext4
 291
 292  - Add write support to guestmount (FUSE) module.
 293
 294  - virt-resize can now resize the content of partitions and logical
 295    volumes in the guest, and we have better support for shrinking guests.
 296
 297  - Bash tab-completion script for guestfish.
 298
 299  - Add ZFS support to virt-rescue.
 300
 301  - New tool 'virt-make-fs' for creating filesystems with content.
 302
 303  - Allow suffixes on any guestfish number parameter, eg. "1M".
 304
 305  - guestfish 'man' command opens the manual page.
 306
 307  - guestfish supports a "heredoc" syntax for uploading files:
 308      upload -<<_end_ /foo
 309      content
 310      _end_
 311
 312  - Some guestfish commands now print their output in octal or hex
 313    where appropriate (RHBZ#583242).
 314
 315  - Allow dash prefix on guestfish command line.  This ignores any
 316    error from the second command:                   (RHBZ#578407)
 317      guestfish -- cmd1 : -cmd2 : cmd3
 318
 319  - guestfish -h / help command now returns an error for non-existent
 320    commands (RHBZ#597145).
 321
 322  - New 'supported' command in guestfish to list optional groups of
 323    commands which are supported by the daemon / configuration.
 324
 325  - virt-inspector and guestfish -i now work for filenames which
 326    contain spaces (RHBZ#507810).
 327
 328  - Change the protocol to use link-local addresses, to avoid
 329    conflicting with any address that the host might be using
 330    (RHBZ#588763).
 331
 332  - libguestfs now sets the correct time and timezone on filesystem
 333    modifications.
 334
 335  - Sort the domains into alphabetical order in virt-df.
 336
 337  - Make mkfs-b command work for FAT and NTFS by mapping the blocksize
 338    parameter to the cluster size (RHBZ#599464).
 339
 340  - Add version numbers to Perl modules (RHBZ#521674).
 341
 342  - Localization now works for all the libguestfs tools (RHBZ#559963).
 343
 344  - Tools now support filesystem-on-image VMs (RHBZ#590167).
 345
 346  - virt-list-partitions has a '-t' option to show the total size of disks.
 347
 348  - Include extra Augeas lenses in the supermin appliance (Matthew Booth).
 349
 350  - Add error and close callbacks.
 351
 352  - Add explicit close method in the Perl API.
 353
 354  - Multiple fixes for RHEL 5 compatibility.
 355
 356  - Multiple fixes for Debian/Ubuntu compatibility.
 357
 358  - Multiple revisions to improve the documentation.
 359
 360 Security
 361
 362  - Fix a potential DoS in virt-inspector and virt-v2v if a specially
 363    crafted disk image contained a char device in place of one of the
 364    configuration files that we read under /etc (RHBZ#582484).
 365
 366 New APIs
 367
 368  - aug-clear - clear Augeas path
 369  - available-all-groups - return a list of all optional groups
 370  - base64-in - upload base64-encoded data to file
 371  - base64-out - download file and encode as base64
 372  - checksum-device - compute checksums on the contents of a device
 373  - checksums-out - compute checksums of multiple files in a directory
 374  - debug-upload - upload a file to the appliance
 375  - fallocate64 - preallocate a file in the guest filesystem
 376  - fill-pattern - fill a file with a repeating pattern of bytes
 377  - get-umask - get the current umask
 378  - lvresize-free - expand an LV to fill free space
 379  - ntfsresize - resize an NTFS filesystem
 380  - ntfsresize-size - resize an NTFS filesystem (with size)
 381  - part-del - delete a partition
 382  - part-get-bootable - get the bootable flag of a partition
 383  - part-get-mbr-id - get the MBR type byte of a partition
 384  - part-set-mbr-id - set the MBR type byte of a partition
 385  - pvresize-size - resize a physical volume (with size)
 386  - pwrite - write to part of a file
 387  - resize2fs-size - resize an ext2/3/4 filesystem (with size)
 388  - txz-in - unpack compressed tarball to directory (RHBZ#580556)
 389  - txz-out - pack directory into compressed tarball (RHBZ#580556)
 390  - vfs-label - get the filesystem label
 391  - vfs-uuid - get the filesystem UUID
 392  - vgscan - rescan for LVM physical volumes, volume groups and logical volumes
 393  - write - create a new file
 394  - zero-device - write zeroes to an entire device
 395
 396 Internals
 397
 398  - Extend the generator to support testing optional features.
 399  - Stricter checks on input parameters to many calls (RHBZ#501893 RHBZ#501894)
 400  - Extend the protocol to support sending arbitrary 8 bit data buffers.
 401  - Ship 'BUGS' file with releases.  This is a summary of the bugs in
 402    the Red Hat Bugzilla database.
 403  - Ship 'RELEASE-NOTES' file with releases, containing release notes.
 404  - Unify supermin appliance building into one place, in febootstrap 2.7.
 405  - Fix the protocol code to handle the case where both ends send cancel
 406    messages at the same time.
 407
 408 Bugs fixed
 409
 410  - 612178 guestfish: using -m option in conjunction with --listen option causes appliance to die
 411  - 610880 libguestfs should set broader read perms on tmpdir, so works in some situations when executed with umask 077
 412  - 604691 OCaml bindings are not thread safe
 413  - 603870 Updates to Spanish translation
 414  - 602592 [RFE] expose guestfs_close in perl bindings
 415  - 600977 virt-df -h --csv "Argument .. isn't numeric in printf"
 416  - 599464 mkfs-b does not support vfat/ntfs
 417  - 598807 add_cdrom does not work in RHEL 6
 418  - 598309 part-list and several other cmd failed on libguestfs on RHEL5
 419  - 597145 guestfish 'help' command should indicate error in exit status with an unknown command
 420  - 597135 guestfish write-file cmd does not check "size" parameter
 421  - 597118 A warning should be given in the help of mke2journal-L for the length of label
 422  - 597112 get-e2uuid should use blkid instead of "tune2fs -l" to get filesystem UUID
 423  - 596776 virt-inspector doesn't discover modprobe aliases on RHEL 3 guests
 424  - 596763 Updates to Spanish translation
 425  - 593292 Updates to Spanish translation
 426  - 592883 can not edit files on  images mounted with guestmount cmd
 427  - 592360 Updates to Spanish translation
 428  - 591250 virt-tar prints "tar_in: tar subcommand failed on directory" if the archive is compressed or not in the right format
 429  - 591155 virt-tar prints "tar_in: tar subcommand failed on directory" if a disk image is not writable
 430  - 591142 virt-inspector should give an error for unrecognized disk images
 431  - 590167 virt-inspector and other virt tools should be able to handle filesystem-on-image VMs
 432  - 589039 guestfish read-file cmd will cause daemon hang when read large files
 433  - 588851 guestfs_launch() returns -1, but guestfs_last_error() == NULL
 434  - 588763 libguestfs should use non-public or link-local addresses for appliance network
 435  - 588733 Updates to Spanish translation
 436  - 588651 guestfish 'strings-e' cmd does not give proper error message or hint
 437  - 587484 lvresize can't reduce size of a volumn
 438  - 585961 Updates to Spanish translation
 439  - 585223 ntfsresize should support shrinking filesystems
 440  - 585222 pvresize should support shrinking PVs
 441  - 585221 resize2fs should support shrinking filesystems
 442  - 584038 Updates to Spanish translation
 443  - 583554 [FEAT] mknod-mode command is needed to set mode explicitly
 444  - 583242 [RFE] guestfish should print outputs in a suitable base (eg. octal for modes)
 445  - 582993 guestfish eats words when tab completing case (in)sensitive paths
 446  - 582953 Misleading help information about lvcreate command
 447  - 582948 mknod command doesn't make block, character or FIFO devices
 448  - 582929 mknod doesn't check for invalid mode
 449  - 582901 guestfish chmod/umask commands do not check invalid mode value
 450  - 582899 guestfish:sparse is missed from command autocomplete list
 451  - 582891 [Feature Request] behavior and return value of guestfish umask cmd should be changed
 452  - 582548 [mknod] umask shouldn't take effect when mode is set explicitly
 453  - 582484 some guestfish sub commands can not handle special files properly
 454  - 582252 Updates to Spanish translation
 455  - 581501 Updates to Spanish translation
 456  - 580650 virt-inspector warns "No grub default specified at /usr/lib/perl5/Sys/Guestfs/Lib.pm at [...]"
 457  - 580556 request for libguestfs to support .txz tarballs
 458  - 580246 tar-in command hangs if uploading more than available space
 459  - 580016 aug-ls in guestfish does not take augeas variable as argument
 460  - 579664 guestfish doesn't report error when there is not enough space for image allocation
 461  - 579608 multiple commands in guestfish can not work for symbol links
 462  - 579155 libguestfs hangs if qemu doesn't start (in null vmchannel mode)
 463  - 578407 the prefix '-' in sub-command isn't handled by guestfish in remote control mode
 464  - 576879 libguestfs protocol loses synchronization if you 'upload' before mounting disks
 465  - 559963 libguestfs Perl programs do set locale, but still localization doesn't work
 466  - 521674 Perl modules are unversioned, but should carry version numbers
 467  - 516096 Race condition in test_swapon_label_0: /sbin/blockdev: BLKRRPART: Device or resource busy
 468  - 507810 guestfish -i / virt-inspector cannot handle spaces in filenames
 469  - 502533 Updated Polish translation of libguestfs
 470  - 501894 Some String parameters should be OptString
 471  - 501893 String parameters should be checked for != NULL
 472  - 501889 write-file does not support strings containing ASCII NUL
 473  - 484986 grub-install fails on virtio disk
 474
 475 Release notes for previous versions of libguestfs
 476 -------------------------------------------------
 477
 478 2009-11-10 : 1.0.78
 479 https://www.redhat.com/archives/libguestfs/2009-November/msg00095.html
 480
 481 2009-09-13 : 1.0.67
 482 https://www.redhat.com/archives/libguestfs/2009-August/msg00281.html
 483
 484 2009-07-23 : 1.0.64
 485 https://www.redhat.com/archives/libguestfs/2009-July/msg00059.html
 486
 487 2009-07-14 : 1.0.59
 488 https://www.redhat.com/archives/libguestfs/2009-July/msg00023.html