plugins: Wire up file-based plugin support for NBD_INFO_INIT_STATE
[nbdkit/ericb.git] / docs / nbdkit-release-notes-1.6.pod
blob024ae503718335ab1444810d657133a201bc7a45
1 =head1 NAME
3 nbdkit-release-notes-1.6 - release notes for nbdkit 1.6
5 =head1 DESCRIPTION
7 These are the release notes for nbdkit stable release 1.6.
8 This describes the major changes since 1.4.
10 nbdkit 1.6.0 was released on 28th August 2018.
12 =head2 New features
14 =over 4
16 =item *
18 You can now write plugins in the Lua scripting language, see
19 L<nbdkit-lua-plugin(3)>.
21 =item *
23 nbdkit and common plugins are now "63 bit clean": the maximum disk
24 size supported is 2⁶³-1 bytes, and the core server and plugins now
25 have additional tests to check this works, even on 32 bit machines.
27 =item *
29 Multiple improvements to the L<nbdkit-file-plugin(1)> to make zeroing
30 and trimming perform better, work correctly with block devices, and
31 work on older Linux kernels [Nir Soffer, Eric Blake].
33 =item *
35 New L<nbdkit-pattern-plugin(1)> generates a simple, fixed test pattern
36 for testing nbdkit filters and NBD clients.
38 =item *
40 New L<nbdkit-truncate-filter(1)> can: truncate or extend the size of
41 plugins, or round up or down the size to next multiple of a power of
42 2.  Useful for NBD clients like qemu which can only handle NBD sizes
43 which are a multiple of 512 bytes.
45 =item *
47 New L<nbdkit-error-filter(1)> which can be used to inject errors into
48 the protocol for testing how clients can handle and recover from
49 errors.
51 =item *
53 New L<nbdkit-data-plugin(1)> allows you to specify (small) disk images
54 directly on the command line.
56 =item *
58 Enhanced error reporting in the Python plugin so full tracebacks
59 from errors are now displayed instead of being lost as before.
61 =item *
63 C<NBD_OPT_GO> now supported, so we can return errors when negotiating
64 the export name.
66 =item *
68 Support for logging error messages to syslog.
70 =item *
72 nbdkit can now be compiled with Clang (as well as GCC).
74 =item *
76 nbdkit can now be compiled on FreeBSD.
78 =item *
80 L<nbdkit-vddk-plugin(1)> is compiled unconditionally.  You no longer
81 need to install the proprietary VDDK to compile it.
83 =item *
85 Debug messages now include the name of the filter when invoked from
86 a filter context.
88 =item *
90 Debug flags (I<-D> option) provides lightweight debugging for plugin
91 authors.
93 =back
95 =head2 Acknowledgements
97 Thanks to all who contributed, especially Nir Soffer and Eric Blake.
99 =head1 SEE ALSO
101 L<nbdkit(1)>,
102 L<https://www.redhat.com/archives/libguestfs/2018-August/msg00279.html>.
104 =head1 AUTHORS
106 Eric Blake
108 Richard W.M. Jones
110 =head1 COPYRIGHT
112 Copyright (C) 2018 Red Hat Inc.