docs/nbdkit-release-notes-1.30.pod

   1 =head1 NAME
   2
   3 nbdkit-release-notes-1.30 - release notes for nbdkit 1.30
   4
   5 =head1 DESCRIPTION
   6
   7 These are the release notes for nbdkit stable release 1.30.
   8 This describes the major changes since 1.28.
   9
  10 nbdkit 1.30.0 was released on B<24 February 2022>.
  11
  12 =head2 Security
  13
  14 There were no security issues found.  All past security issues and
  15 information about how to report new ones can be found in
  16 L<nbdkit-security(1)>.
  17
  18 =head2 Plugins
  19
  20 B<nbdkit-streaming-plugin> has been removed.  It was deprecated in
  21 1.26 and scheduled for removal in this release.  If you were using
  22 this plugin, use L<nbdcopy(1)> instead.
  23
  24 L<nbdkit-vddk-plugin(1)> has several changes:
  25
  26 =over 4
  27
  28 =item *
  29
  30 This plugin can now create (as well as reading and writing) local VMDK
  31 files.  See the new C<create=true> option and the various C<create-*>
  32 options.
  33
  34 =item *
  35
  36 Read and write is now implemented using the VDDK Async functions,
  37 which improves performance.  The full nbdkit parallel thread model is
  38 supported.
  39
  40 =item *
  41
  42 VDDK E<ge> 6.5 (released Nov 2016) is now the minimum required
  43 version.
  44
  45 =item *
  46
  47 Stats collected when using I<-D vddk.stats=1> have been extended to
  48 include number of calls and bytes transferred.
  49
  50 =item *
  51
  52 I<--dump-plugin> output now includes the VDDK major version and
  53 information about each VDDK API that is implemented by the library.
  54
  55 =item *
  56
  57 A new example F<scripts/vddk-open.sh> is provided to help with
  58 automating connections to remote ESXi virtual machines.
  59
  60 =back
  61
  62 L<nbdkit-curl-plugin(1)> adds support for choosing TLS/SSL versions
  63 and ciphers and TLS 1.3 cipher versions (Przemyslaw Czarnowski).
  64
  65 L<nbdkit-file-plugin(1)> now implements C<cache=none> for writes so
  66 that the Linux page cache is not destroyed when writing huge files.
  67
  68 L<nbdkit-cc-plugin(1)> now implements the C<.cleanup> callback.  Also
  69 we document how to use this plugin to implement OCaml plugin scripts.
  70
  71 L<nbdkit-info-plugin(1)> I<--dump-plugin> option now prints
  72 C<info_address=yes> when the platform supports C<mode=address>.
  73
  74 =head2 Filters
  75
  76 New L<nbdkit-retry-request-filter(1)>, which is similar to
  77 L<nbdkit-retry-filter(1)> but only retries a single failing request.
  78
  79 New L<nbdkit-protect-filter(1)> lets you add write-protection over
  80 regions of a plugin.
  81
  82 New L<nbdkit-blocksize-policy-filter(1)> lets you adjust or set the
  83 block size constraints and policy of underlying plugins.  See L</API>
  84 below.
  85
  86 L<nbdkit-cow-filter(1)> now permits the COW block size to be set as
  87 small as 4096 bytes.
  88
  89 Debug messages in L<nbdkit-error-filter(1)> are now easier to read
  90 because they no longer all have an C<error:> prefix (Eric Blake).
  91
  92 =head2 Language bindings
  93
  94 For L<plugins written in OCaml|nbdkit-ocaml-plugin(3)> the minimum
  95 version of OCaml is now 4.03 (instead of 4.02.2 previously).  Various
  96 source-level incompatible changes were made to OCaml plugins in this
  97 release.  Please consult the new documentation and example if writing
  98 plugins in OCaml.
  99
 100 OCaml plugins now support C<magic_config_key>.
 101
 102 Several fixes to the handling of integers in Python plugins (Nir
 103 Soffer).
 104
 105 New Python example which simulates request errors (Nir Soffer).
 106
 107 =head2 Server
 108
 109 The server no longer requests the C<AI_ADDRCONFIG> hint when opening a
 110 server socket.  This improves handling of IPv6.  In a related change,
 111 the I<-i> (I<--ipaddr>) option now works as intended, and new I<-4>
 112 and I<-6> options have been added to restrict the listening socket to
 113 IPv4 or IPv6 addresses (Laszlo Ersek).
 114
 115 =head2 API
 116
 117 There is a new C<.block_size> callback for plugins and filters.
 118 nbdkit uses this to export block size constraints to clients,
 119 specifically the minimum, preferred and maximum block size that
 120 clients should use.
 121
 122 As well as regular C plugins, L<nbdkit-cc-plugin(3)>,
 123 L<nbdkit-eval-plugin(1)>, L<nbdkit-ocaml-plugin(3)>,
 124 L<nbdkit-python-plugin(3)> and L<nbdkit-sh-plugin(3)> support block
 125 size constraints.  L<nbdkit-nbd-plugin(1)> reexports block size
 126 constraints from the proxied NBD server.  L<nbdkit-vddk-plugin(1)> now
 127 advertises a minimum 512 byte block size.
 128
 129 L<nbdkit-blocksize-filter(1)>, L<nbdkit-cache-filter(1)>,
 130 L<nbdkit-cow-filter(1)> and L<nbdkit-swab-filter(1)> adjust block size
 131 constraints from plugins (Eric Blake).
 132
 133 L<nbdkit-blocksize-filter(1)> can also use the block size hints from
 134 the plugin instead of needing manual adjustment on the command line.
 135 L<nbdkit-log-filter(1)> logs block size constraints (Eric Blake).
 136
 137 L<nbdkit-blocksize-policy-filter(1)> can be used to add block size
 138 constraints to plugins which don't support it, or adjust constraints,
 139 or set the error policy.
 140
 141 =head2 Bug fixes
 142
 143 L<nbdkit-memory-plugin(1)> (and others), using
 144 C<allocator=malloc,mlock=true> was broken.  This was especially
 145 evident on non-Linux or on Linux with 64K pages (eg. POWER).  It
 146 should now work correctly.
 147
 148 =begin comment
 149
 150 =head2 Documentation
 151
 152 =end comment
 153
 154 =head2 Tests
 155
 156 C<./configure --disable-libguestfs-tests> can now be used to disable
 157 tests which need libguestfs, without disabling
 158 L<nbdkit-guestfs-plugin(1)>.
 159
 160 We now use L<mke2fs(8)> instead of L<guestfish(1)> to create the ext4
 161 test image.  On armv7 this allows the test suite to run much more
 162 quickly.
 163
 164 The time taken to run the test suite has been reduced significantly.
 165
 166 =head2 Build
 167
 168 Multiple fixes to the Windows (MinGW) build.  The test suite should
 169 now pass fully if you have the version of Wine with the unofficial
 170 C<AF_UNIX> patch.
 171
 172 The top level F<bash> source directory has been renamed to
 173 F<bash-completion>.  This prevents problems when setting C<$PATH> to
 174 the source directory and trying to run bash.
 175
 176 =head2 Internals
 177
 178 The performance of the internal vector library has been improved
 179 greatly and overflow is now handled correctly (Nir Soffer, Laszlo
 180 Ersek and Eric Blake).
 181
 182 New "nbdkit-string.h" header file which defines a common string type
 183 (based on vector).  Existing places which defined a string based on
 184 vector have been updated to use it.
 185
 186 C<MIN> and C<MAX> macros can be nested (thanks Eric Blake).
 187
 188 =head1 SEE ALSO
 189
 190 L<nbdkit(1)>.
 191
 192 =head1 AUTHORS
 193
 194 Authors of nbdkit 1.30:
 195
 196 =begin comment
 197
 198 git shortlog -s v1.28.0..
 199
 200 =end comment
 201
 202 =over 4
 203
 204 =item Alan Somers
 205
 206 =item Eric Blake
 207
 208 =item Hilko Bengen
 209
 210 =item Laszlo Ersek
 211
 212 =item Nir Soffer
 213
 214 =item Przemyslaw Czarnowski
 215
 216 =item Richard W.M. Jones
 217
 218 =back
 219
 220 =head1 COPYRIGHT
 221
 222 Copyright Red Hat