Added information to RELEASE_NOTES to reflect the 'release candidate' status of the current release.

Added information about needing to generate configure scripts with 'autoreconf'.
Updated Building with CMake documentation, moved 4.3.0 errata to a place of less prominence.
This commit is contained in:
Ward Fisher 2013-08-09 11:14:07 -06:00
parent 5a5f4c7b75
commit f9e1374b6f
2 changed files with 37 additions and 27 deletions

View File

@ -1,39 +1,45 @@
\page release_notes Release Notes
This file contains a high-level description of this package's evolution.
Releases are in reverse chronological order (most recent first). Recent
releases include references to Jira issue identifiers for more
Releases are in reverse chronological order (most recent first).
Recent releases include references to Jira issue identifiers for more
information, where '[NCF-XXX]' refers to https://www.unidata.ucar.edu/jira/browse/NCF-XXX .
### 4.3.1 Released TBD
### 4.3.1-rc1 Released 2013-08-09
* Migrated from the netCDF-C `subversion` repository to a publically available GitHub repository available at https://github.com/Unidata/netCDF-C. This repository may be checked out (cloned) with the following command:
> $ git clone https://github.com/Unidata/netCDF-C.git
> $ git clone https://github.com/Unidata/netCDF-C.git
* Added `nc_rename_grp` to allow for group renaming in netCDF-4 files. [NCF-204]
* Note: in this release, it is necessary to generate the `configure` script and makefile templates using `autoreconf` in the root netCDF-C directory.:
> $ autoreconf -i -f
[NCF-204]: https://bugtracking.unidata.ucar.edu/browse/NCF-204
* Added `nc_rename_grp` to allow for group renaming in netCDF-4 files.
https://bugtracking.unidata.ucar.edu/browse/NCF-204
* Added a `NC_HAVE_RENAME_GRP` macro to netcdf.h, [as per a request by Charlie Zender][cz1]. This will allow software compiling against netcdf to easily query whether or not nc\_rename\_grp() is available.
[cz1]: https://www.unidata.ucar.edu/esupport/staff/index.php?_m=tickets&_a=viewticket&ticketid=22442
* Added a `NC_HAVE_RENAME_GRP` macro to netcdf.h, as per a request by Charlie Zender. This will allow software compiling against netcdf to easily query whether or not `nc_rename_grp()` is available.
* https://www.unidata.ucar.edu/esupport/staff/index.php?_m=tickets&_a=viewticket&ticketid=22442
* Added Greg Sjaardema's contributed optimization for the nc4\_find\_dim\_len function in libsrc4/nc4internal.c. The patch eliminates several malloc/free calls that exist in the original coding.
* Added support for dynamic loading, to compliment the dynamic loading support introduced in hdf 1.8.11. Dynamic loading support depends on libdl, and is enabled as follows: [NCF-258]
* Added support for dynamic loading, to compliment the dynamic loading support introduced in hdf 1.8.11. Dynamic loading support depends on libdl, and is enabled as follows:
* autotools-based builds: --enable-dynamic-loading
* cmake-based builds: -DENABLE\_DYNAMIC\_LOADING=ON
[NCF-258]: https://www.unidata.ucar.edu/jira/browse/NCF-258
https://www.unidata.ucar.edu/jira/browse/NCF-258
* Fix issue of netCDF-4 parallel independent access with unlimited dimension hanging. Extending the size of an unlimited dimension in HDF5 must be a collective operation, so now an error is returned if trying to extend in independent access mode. [NCF-250]
[NCF-250]: https://bugtracking.unidata.ucar.edu/browse/NCF-250
* Fix issue of netCDF-4 parallel independent access with unlimited dimension hanging. Extending the size of an unlimited dimension in HDF5 must be a collective operation, so now an error is returned if trying to extend in independent access mode.
* Fixed bug with netCDF-4's inability to read HDF5 scalar numeric attributes. Also allow, in addition to zero length strings, a new NULL pointer as a string value. to improve interoperability with HDF5. This required a new CDL constant, 'NIL', that can be output from ncdump for such a string value in an HDF5 or netCDF-4 file. The ncgen utility was also modified to properly handle such NIL values for strings. [NCF-56]
https://bugtracking.unidata.ucar.edu/browse/NCF-250
[NCF-56]: https://bugtracking.unidata.ucar.edu/browse/NCF-56
* Fixed bug with netCDF-4's inability to read HDF5 scalar numeric attributes. Also allow, in addition to zero length strings, a new NULL pointer as a string value. to improve interoperability with HDF5. This required a new CDL constant, 'NIL', that can be output from ncdump for such a string value in an HDF5 or netCDF-4 file. The ncgen utility was also modified to properly handle such NIL values for strings.
https://bugtracking.unidata.ucar.edu/browse/NCF-56
* Parallel-build portability fixes, particularly for OpenMPI and gcc/gfortran-4.8.x on OSX.

View File

@ -2,21 +2,10 @@
# Overview
Starting with netCDF-C 4.3, we are happy to announce the inclusion of CMake support. CMake will allow for building netCDF on a wider range of platforms, include Microsoft Windows with Visual Studio. CMake support also provides robust unit and regression testing tools. We will also maintain the standard autotools-based build system in parallel.
Starting with netCDF-C 4.3.0, we are happy to announce the inclusion of CMake support. CMake will allow for building netCDF on a wider range of platforms, include Microsoft Windows with Visual Studio. CMake support also provides robust unit and regression testing tools. We will also maintain the standard autotools-based build system in parallel.
In addition to providing new build options for netCDF-C, we will also provide pre-built binary downloads for the shared versions of netCDF for use with Visual Studio.
# Errata
## netCDF 4.3.0
* When netCDF 4.3.0 was originally released, the file `nc-config.in.cmake` was accidentally excluded. This file can be downloaded [here]. The file should be placed in the root of the netcdf source directory.
[here]: https://www.unidata.ucar.edu/software/netcdf/win_netcdf/nc-config.in.cmake "nc-config.in.cmake"
* When building shared libraries via CMake on Unix/Linux, the resulting files have the soversion 4.3.0. This is a mistake, the soversion should be 7.2.0. This can be rectified post-install by creating a symbolic link from libnetcdf.4.3.0.so to libnetcdf.7.2.0.so. This would be accomplished thusly:
> sudo ln -s /usr/local/lib/libnetcdf.4.3.0.so /usr/local/lib/libnetcdf.7.2.0.so
# Requirements
The following packages are required to build netCDF-C using CMake.
@ -152,3 +141,18 @@ or
> cmake [path to source tree] -L - This will show the basic options.
> cmake [path to source tree] -LA - This will show the basic and advanced options.
# Errata
## netCDF 4.3.1-rc1
## netCDF 4.3.0
* When netCDF 4.3.0 was originally released, the file `nc-config.in.cmake` was accidentally excluded. This file can be downloaded [here]. The file should be placed in the root of the netcdf source directory.
[here]: https://www.unidata.ucar.edu/software/netcdf/win_netcdf/nc-config.in.cmake "nc-config.in.cmake"
* When building shared libraries via CMake on Unix/Linux, the resulting files have the soversion 4.3.0. This is a mistake, the soversion should be 7.2.0. This can be rectified post-install by creating a symbolic link from libnetcdf.4.3.0.so to libnetcdf.7.2.0.so. This would be accomplished thusly:
> $ sudo ln -s /usr/local/lib/libnetcdf.4.3.0.so /usr/local/lib/libnetcdf.7.2.0.so