1nbdkit-release-notes-1.20(1)        NBDKIT        nbdkit-release-notes-1.20(1)
2
3
4

NAME

6       nbdkit-release-notes-1.20 - release notes for nbdkit 1.20
7

DESCRIPTION

9       These are the release notes for nbdkit stable release 1.20.  This
10       describes the major changes since 1.18.
11
12       nbdkit 1.20.0 was released on 2nd May 2020.
13
14   Security
15       There were no security issues found.  All past security issues and
16       information about how to report new ones can be found in
17       nbdkit-security(1).
18
19   Plugins
20       New nbdkit-tmpdisk-plugin(1) is a scriptable “remote tmpfs” for
21       creating temporary filesystems (eg. for thin clients), and also for
22       blank or prepopulated temporary disks.
23
24       nbdkit-data-plugin(1) now has support for prepopulating disks with more
25       complex test patterns such as repeated sequences of bytes.
26
27       nbdkit-curl-plugin(1) now supports setting a proxy, enabling TCP
28       keepalives, and disabling Nagle’s algorithm.
29
30       nbdkit-perl-plugin(1) now supports API version 2.  In particular the
31       full NBD client flags are visible to plugins, along with support for
32       the ".get_ready" callback.  Also there is a new function
33       "Nbdkit::debug" which is a wrapper around the "nbdkit_debug" API.
34
35       nbdkit-vddk-plugin(1) drops support for VDDK 5.1.1.  This version was
36       last updated in 2014 and is no longer supported by VMware.  Since this
37       was the last version of VDDK to support i686, 32-bit support is also
38       dropped (Eric Blake).
39
40   Language bindings
41       Plugins may now be written in Golang, see nbdkit-golang-plugin(3)
42       (thanks Dan Berrangé, James Shubin).
43
44       OCaml plugins can now access "nbdkit_realpath", "nbdkit_nanosleep",
45       "nbdkit_export_name" and "nbdkit_shutdown".
46
47       Python plugins now transparently support fail-fast zero (Eric Blake).
48
49   Filters
50       New nbdkit-exitlast-filter(1) causes nbdkit to exit after the last
51       client connection.
52
53       New nbdkit-limit-filter(1) allows you to limit the number of clients
54       which can simultaneously connect to any plugin.
55
56   Server
57       The --run option now waits for the nbdkit plugin and nbdkit to exit
58       before returning to the caller.  This allows for more predictable clean
59       up in shell scripts using this feature.
60
61       nbdkit --dump-config output now includes separate lines for
62       "version_major" and "version_minor", making it easier to find out from
63       shell scripts which version of nbdkit is installed.
64
65       nbdkit -s option (which connects to the client over stdin/stdout) now
66       rejects various options that would also try to read from or write to
67       stdin/stdout, for example --dump-plugin or "password=-" (Eric Blake).
68
69   API
70       New "nbdkit_shutdown" call which allows plugins to ask for nbdkit to
71       exit.  This is used to implement the new "exitlast" filter.
72
73       New "nbdkit_stdio_safe" call allows plugins to check if reading from
74       stdin or writing to stdout is safe, eg. if it is safe to read passwords
75       interactively (Eric Blake).
76
77       "can_*" callbacks which return booleans can return any value ≥ 1 to
78       mean true.  Previous versions of nbdkit had inconsistent behaviour if
79       plugins returned anything other than 1 for true (Eric Blake).
80
81   Bug fixes
82       nbdkit-tar-plugin now works and there is a regression test for it.
83
84       nbdkit-curl-plugin(1) -D curl.version=1 option now works.
85
86       Fixed a rare hang when closing a connection in nbdkit-nbd-plugin(1)
87       (Eric Blake).
88
89       Fix compilation on certain platforms with clang (Khem Raj).
90
91       Don’t leak $tmpdir from nbdkit-sh-plugin(1) into the --run subcommand.
92
93       nbdkit now correctly sets "FD_CLOEXEC" when using systemd socket
94       activation (Eric Blake).
95
96   Documentation
97       The nbdkit-plugin(3) man page has been overhauled completely to make it
98       easier to follow.  Also we now have documentation for how to compile
99       plugins in various environments which was missing before.
100
101   Tests
102       All valgrind tests now pass.
103
104       “Old plugin” tests were added for v1.18.2 on x86-64, and a variety of
105       old plugins compiled on i686.  The i686 plugins will allow us to test
106       for regressions in 32 bit support.
107
108       Tests of the nbd plugin should now be stable (Eric Blake).
109
110       There is an additional test combining the offset and truncate filters,
111       which tests several corner cases as well as providing tests of error
112       handling between layers.
113
114   Build
115       nbdkit-nbd-plugin(1) now requires libnbd.  (If libnbd is not present at
116       build time then this plugin is not built).  The fallback code in this
117       plugin which made NBD connections by constructing NBD command packets
118       without using libnbd has been removed (Eric Blake).
119
120       scripts/git.orderfile has been improved so that commands like
121       "git diff" and "git show" display OCaml sources in a natural order with
122       interface first followed by implementation.
123
124       Various fixes for MinGW.  Note MinGW / MSYS support is a work in
125       progress and not finished yet (Frank Gu).
126
127       Multiple fixes to Haiku build.
128
129       awk(1) is no longer required to run the tests.  It was a “hidden”
130       required dependency, but all use of it has now been eliminated.
131
132   Internals
133       There is now an internal utility library for creating vectors/lists of
134       objects, for example lists of strings (common/utils/vector.h).  It is
135       widely used by the server, plugins and filters.
136
137       README discusses how to use lcov(1) for code coverage reports.
138

SEE ALSO

140       nbdkit(1).
141

AUTHORS

143       Authors of nbdkit 1.20:
144
145       Eric Blake
146           (33 commits)
147
148       Khem Raj
149           (1 commit)
150
151       Richard W.M. Jones
152           (134 commits)
153
154       Frank Gu
155           (6 commits)
156
158       Copyright (C) 2020 Red Hat Inc.
159

LICENSE

161       Redistribution and use in source and binary forms, with or without
162       modification, are permitted provided that the following conditions are
163       met:
164
165       •   Redistributions of source code must retain the above copyright
166           notice, this list of conditions and the following disclaimer.
167
168       •   Redistributions in binary form must reproduce the above copyright
169           notice, this list of conditions and the following disclaimer in the
170           documentation and/or other materials provided with the
171           distribution.
172
173       •   Neither the name of Red Hat nor the names of its contributors may
174           be used to endorse or promote products derived from this software
175           without specific prior written permission.
176
177       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
178       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
179       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
180       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
181       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
182       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
183       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
184       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
185       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
186       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
187       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
188
189
190
191nbdkit-1.30.7                     2022-07-10      nbdkit-release-notes-1.20(1)
Impressum