]> git.evergreen-ils.org Git - OpenSRF.git/blob - doc/RELEASE_NOTES.txt
update release notes for 2.2.1
[OpenSRF.git] / doc / RELEASE_NOTES.txt
1 Release notes for OpenSRF 2.2.1
2 ===============================
3
4 Supported platforms
5 -------------------
6 The following Linux distributions are supported:
7
8   * Debian 6 (Squeeze) and 7 (Wheezy)
9   * Fedora 17, 18
10   * Ubuntu 10.04 LTS (Lucid Lynx), 12.04 LTS (Precise Pangolin)
11
12 Changes in 2.2.1
13 ----------------
14
15 Disable use of multipart/mixed XHR for most clients
16 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 Due to Mozilla withdrawing support for multipart XHR responses from
18 Firefox as of version 22, multipart message support is now disabled
19 for all clients except the Evergreen staff client.
20
21 Default per-process client locale (Perl)
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23 A method was added to get and/or set the locale used by all new client
24 sessions for the current process.  This is primarily useful for
25 clients that wish to make a series of OpenSRF calls and don't wish to
26 set the locale for each new AppSession object.
27
28 Minor fixes
29 ~~~~~~~~~~~
30 One fix improves support for Debian testing while another resolves some
31 unitialized variable warnings.
32
33 New features in 2.2.0
34 ----------------------
35
36 Apache 2.4 support
37 ~~~~~~~~~~~~~~~~~~
38 OpenSRF now supports Apache 2.4.
39
40 Support graceful reload of Perl services via SIGHUP
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42 Sending a SIGHUP signal to the listener process of a Perl service will
43 now cause it to re-read the OpenSRF core configuration and respawn
44 its child processes.  This allows the log level of the service to be
45 changed on the fly.
46
47 Send Perl warnings to OpenSRF logs
48 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
49 Warning messages generated by `warn()` and `carp()` calls in Perl
50 services are now sent to the main OpenSRF log subsystem rather than
51 the `*_stderr.log` files.
52
53 Enable client logtrace with environment vars
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55 A new environment variable, `OSRF_LOG_CLIENT`, is now recognized which,
56 if set to true, enables control and generation of the client log trace
57 value.  This is the same as setting `<client>true</client>` within the 
58 OpenSRF core configuration file.
59
60 As a shortcut, if the `MOD_PERL` environment variable is set, assume
61 client=true.
62
63 This allows clients and non-clients to share an OpenSRF core
64 configuration file, when previously the only difference between the two
65 was the `<client>` setting.
66
67 Significant bugfixes in 2.2.0
68 -----------------------------
69
70 Eliminate CPU spikes caused by use of MultiSession
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72 The MultiSession module now blocks on the XMPP socket while waiting for
73 responses from the service requests it fires off rather than using
74 a CPU-intensive loop to poll for responses.
75
76
77 Fix Java client's parsing of OpenSRF core configuration
78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79 This issue had prevented Java client library from successfully connecting
80 to an OpenSRF network.
81
82 Build improvements
83 ------------------
84 OpenSRF no longer uses `/opensrf` as a non-standard default installation
85 directory prefix, easing the task of packagers.
86
87 OpenSRF's Java libraries can now be built without requiring that
88 `src/Java/Makefile` be edited manually.
89
90 OpenSRF no longer incorrectly asserts a dependency on the RPC::XML Perl module.
91
92 Continuous integration support
93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 An example configuration file for the http://buildbot.net/[Buildbot] continuous
95 integration server can be found in `examples/buildbot.cfg`. The most current
96 version of this file will always be found in the `master` branch of the OpenSRF
97 git repository.
98
99 The build steps configure and compile the code using the default arguments to
100 `configure`, as well as running the unit tests for C, Perl, and Python, and
101 running `pylint` against the Python source code.