Merge pull request #313 from ax3l/doc-changelog040

Version: 0.4.0-alpha
openPMD · Aug 27, 2018 · e82516c · e82516c
2 parents 2ae60d7 + 9941e7e
commit e82516c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 17 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,28 +3,31 @@
 Changelog
 =========
 
-0.3.2-alpha
+0.4.0-alpha
 -----------
-**Date:** TBA
+**Date:** 2018-08-27
 
-[Title]
+Improved output handling
 
-[Summary]
+Refactored and hardened for ``fileBased`` output.
+Records are not flushed before the ambiguity between scalar and vector records are resolved.
+Trying to write globally zero-extent records will throw gracefully instead of leading to undefined behavior in backends.
 
 Changes to "0.3.1-alpha"
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 Features
 """"""""
 
-- Do not assume Record structure prematurely #297
+- do not assume record structure prematurely #297
+- throw in (global) zero-extent dataset creation and write #309
 
 Bug Fixes
 """""""""
 
-- ADIOS1 fileBased IO #297
+- ADIOS1 ``fileBased`` IO #297
 - ADIOS2 stub header #302
-- Name sanitization in ADIOS1 and HDF5 backends #310
+- name sanitization in ADIOS1 and HDF5 backends #310
 
 Other
 """""
@@ -36,14 +39,15 @@ Other
  - clang-tidy support
  - include-what-you-use support #291 export headers #300
  - OSX High Sierra support #301
- - Individual cache per build # 303
- - Readable build names # 308
+ - individual cache per build # 303
+ - readable build names #308
 - remove superfluous whitespaces #292
 - readme: openPMD is for scientific data #294
-- override implies virtual #293
+- ``override`` implies ``virtual`` #293
 - spack load: ``-r`` #298
 - default constructors and destructors #304
 - string pass-by-value #305
+- test cases with 0-sized reads & writes #135
 
 
 0.3.1-alpha

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,7 +2,7 @@
 #
 cmake_minimum_required(VERSION 3.10.0)
 
-project(openPMD VERSION 0.3.1) # LANGUAGES CXX
+project(openPMD VERSION 0.4.0) # LANGUAGES CXX
 
 # the openPMD "markup"/"schema" standard version
 set(openPMD_STANDARD_VERSION 1.1.0)

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -78,9 +78,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.3.2'
+version = u'0.4.0'
 # The full version, including alpha/beta/rc tags.
-release = u'0.3.2-dev'
+release = u'0.4.0-alpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -38,7 +38,7 @@ The supported version of the `openPMD standard <https://github.com/openPMD/openP
 ======================= ===================================
 openPMD-api version supported openPMD standard versions
 ======================= ===================================
-``0.1.0-0.3.1`` (alpha) ``1.0.0-1.1.0``
+``0.1.0-0.4.0`` (alpha) ``1.0.0-1.1.0``
 ``1.0.0+`` ``1.0.1-1.1.0`` (not released yet)
 ``2.0.0+`` ``2.0.0+`` (not released yet)
 ======================= ===================================

diff --git a/include/openPMD/version.hpp b/include/openPMD/version.hpp
@@ -22,9 +22,9 @@
 
 // version of the openPMD-api library
 #define OPENPMDAPI_VERSION_MAJOR 0
-#define OPENPMDAPI_VERSION_MINOR 3
-#define OPENPMDAPI_VERSION_PATCH 2
-#define OPENPMDAPI_VERSION_LABEL "dev"
+#define OPENPMDAPI_VERSION_MINOR 4
+#define OPENPMDAPI_VERSION_PATCH 0
+#define OPENPMDAPI_VERSION_LABEL "alpha"
 
 // maximum supported version of the openPMD standard (read & write)
 #define OPENPMD_STANDARD_MAJOR 1