Merge pull request #1234 from apradhana/v9.0.0_rc

Add more highlights to the release documentation.
AcademySoftwareFoundation · Oct 30, 2021 · e012cd4 · e012cd4
2 parents 961b41e + dfb4ed3
commit e012cd4
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 35 deletions.
diff --git a/CHANGES b/CHANGES
@@ -6,11 +6,11 @@ Version 9.0.0 - October 29, 2021
     New features:
     - NanoVDB, which for the first time offers GPU support for static sparse
       volumes in OpenVDB.
+
+    Improvements:
     - Added tools::countActiveLeafVoxels(), tools::countInactiveVoxels(),
       tools::countInactiveLeafVoxels() and tools::activeTiles() to perform
       multi-threaded counting. The Tree methods now use these implementations.
-
-    Improvements:
     - Moved from the deprecated TBB task scheduler to TBB arenas. Various
       methods now respect the TBB arena state they were invoked from.
     - Introduced a new thread/Threading.h header to consolidate calls to
@@ -21,10 +21,10 @@ Version 9.0.0 - October 29, 2021
       hue, saturation and value inputs to RGB values and vice-versa.
     - PointDataGrid conversion can now be performed using 32-bit float arrays.
     - Improved support for size_t grid types on systems where size_t is a
-      unique type
+      unique type.
       [Contributed by Brecht Van Lommel]
     - Add support for dilation in one direction and extending a field in one
-      direction
+      direction in fast sweeping algorithms.
     - Added PNG support to vdb_render which can be enabled with during CMake
       with -DUSE_PNG=ON.
     - Explicit template instantiation has been enabled by default for most of
@@ -39,7 +39,7 @@ Version 9.0.0 - October 29, 2021
       statement.
 
     ABI changes:
-    - Added transient data to the RootNode, InternalNode and LeafNode.
+    - Added transient data to the RootNode, InternalNode, and LeafNode.
 
     API changes:
     - DynamicNodeManager can now set one grain size for threading across leaf nodes
@@ -61,7 +61,7 @@ Version 9.0.0 - October 29, 2021
     - The label for Voxels to Expand is now Expand Voxels to match Houdini.
     - Fix bug to allow VDB LOD SOPs to be chained together.
     - SOP Extrapolate supports dilation in one direction and extending a field
-      in one (domain) direction
+      in one (domain) direction.
     - The default OpenVDB ABI is now 8 for Houdini versions > 18.5.
     - VDB Visualize Tree SOP is now multi-threaded and provides slicing and
       color remapping.
@@ -80,21 +80,21 @@ Version 9.0.0 - October 29, 2021
       generated doxygen.
     - Improved the doxygen deprecation listings, folder layouts and fixes
       issues when using later versions of doxygen.
-    - Build fixes for MinGW on Windows
+    - Build fixes for MinGW on Windows.
       [Contributed by Brecht Sanders]
-    - Added support for OpenEXR 3
+    - Added support for OpenEXR 3.
       [Contributed by Cary Phillips]
     - Added an OPENVDB_NAMESPACE_SUFFIX CMake string option which provides
       the ability to customise the VDB namespace.
     - The Python Module now appends the base directory defined by
       Python_SITELIB to the default install path (typically dist-packages
-      or site-packages)
+      or site-packages).
       [Contributed by Ignacio Vizzo]
     - As of this release, VFX Reference Platform 2019 is no longer supported.
       CMake now issues deprecation warnings for 2020 VFX Reference Platform
       version dependencies.
-    - Build fixes for OpenVDB AX with C++17 and greater
-    - Bumped the new blosc version future minimum to 1.17.0
+    - Build fixes for OpenVDB AX with C++17 and greater.
+    - Bumped the new blosc version future minimum to 1.17.0.
     - OpenEXR is now optional for vdb_render. It can be enabled with
       -DUSE_EXR=ON.
 
@@ -116,12 +116,12 @@ Version 8.2.0 - In development
       hue, saturation and value inputs to RGB values and vice-versa.
     - PointDataGrid conversion can now be performed using 32-bit float arrays.
     - Improved support for size_t grid types on systems where size_t is a
-      unique type
+      unique type.
       [Contributed by Brecht Van Lommel]
     - Minor performance improvements to dilation calls in fast sweeping
-      algorithms
+      algorithms.
     - Add support for dilation in one direction and extending a field in one
-      direction
+      direction in fast sweeping algorithms.
 
     API changes:
     - DynamicNodeManager can now set one grain size for threading across leaf nodes
@@ -140,7 +140,7 @@ Version 8.2.0 - In development
     - The label for Voxels to Expand is now Expand Voxels to match Houdini.
     - Fix bug to allow VDB LOD SOPs to be chained together.
     - SOP Extrapolate supports dilation in one direction and extending a field
-      in one (domain) direction
+      in one (domain) direction.
     - The default OpenVDB ABI is now 8 for Houdini versions > 18.5.
     - VDB Visualize Tree SOP is now multi-threaded and provides slicing and
       color remapping.
@@ -154,15 +154,15 @@ Version 8.2.0 - In development
       generated doxygen.
     - Improved the doxygen deprecation listings, folder layouts and fixes
       issues when using later versions of doxygen.
-    - Build fixes for MinGW on Windows
+    - Build fixes for MinGW on Windows.
       [Contributed by Brecht Sanders]
-    - Added support for OpenEXR 3
+    - Added support for OpenEXR 3.
       [Contributed by Cary Phillips]
     - Added an OPENVDB_NAMESPACE_SUFFIX CMake string option which provides
       the ability to customise the VDB namespace.
     - The Python Module now appends the base directory defined by
       Python_SITELIB to the default install path (typically dist-packages
-      or site-packages)
+      or site-packages).
       [Contributed by Ignacio Vizzo]
 
 

diff --git a/doc/changes.txt b/doc/changes.txt
@@ -17,19 +17,34 @@ preserve ABI compatibility it might be necessary to define the macro
 @par
 <BLOCKQUOTE>
 Official release of NanoVDB, which for the first time offers GPU support for
-static sparse volumes in OpenVDB.
+static sparse volumes in OpenVDB. See the
+<A HREF="https://academysoftwarefoundation.github.io/openvdb/NanoVDB_MainPage.html">documentation</A>
+for details.
+</BLOCKQUOTE>
+
+<BLOCKQUOTE>
+Faster build times from support for explicit template instantiation,
+which is enabled by default for most of the tools.
+</BLOCKQUOTE>
+
+<BLOCKQUOTE>
+Added support for OpenEXR 3. This is contributed by Cary Phillips.
+</BLOCKQUOTE>
+
+<BLOCKQUOTE>
+Added transient data to the RootNode, InternalNode, and LeafNode.
 </BLOCKQUOTE>
 
 @par
 New features:
 - NanoVDB, which for the first time offers GPU support for static sparse volumes
   in OpenVDB.
-- Added tools::countActiveLeafVoxels(), tools::countInactiveVoxels(),
-  tools::countInactiveLeafVoxels() and tools::activeTiles() to perform
-  multi-threaded counting. The Tree methods now use these implementations.
 
 @par
 Improvements:
+- Added tools::countActiveLeafVoxels(), tools::countInactiveVoxels(),
+  tools::countInactiveLeafVoxels() and tools::activeTiles() to perform
+  multi-threaded counting. The Tree methods now use these implementations.
 - Moved from the deprecated TBB task scheduler to TBB arenas. Various
   methods now respect the TBB arena state they were invoked from.
 - Introduced a new thread/Threading.h header to consolidate calls to
@@ -40,10 +55,10 @@ Improvements:
   hue, saturation and value inputs to RGB values and vice-versa.
 - PointDataGrid conversion can now be performed using 32-bit float arrays.
 - Improved support for size_t grid types on systems where size_t is a unique
-  type
+  type.
   [Contributed by Brecht Van Lommel]
 - Add support for dilation in one direction and extending a field in one
-  direction
+  direction in fast sweeping algorithms.
 - Added PNG support to vdb_render which can be enabled with during CMake with
   -DUSE_PNG=ON.
 - Explicit template instantiation has been enabled by default for most of the
@@ -58,7 +73,7 @@ Bug Fixes:
 
 @par
 ABI changes:
-- Added transient data to the RootNode, InternalNode and LeafNode.
+- Added transient data to the RootNode, InternalNode, and LeafNode.
 
 @par
 API changes:
@@ -102,20 +117,20 @@ Build:
   generated doxygen.
 - Improved the doxygen deprecation listings, folder layouts and fixes
   issues when using later versions of doxygen.
-- Build fixes for MinGW on Windows
+- Build fixes for MinGW on Windows.
   [Contributed by Brecht Sanders]
-- Added support for OpenEXR 3
+- Added support for OpenEXR 3.
   [Contributed by Cary Phillips]
 - Added an OPENVDB_NAMESPACE_SUFFIX CMake string option which provides the
   ability to customise the VDB namespace.
 - The Python Module now appends the base directory defined by Python_SITELIB
-  to the default install path (typically dist-packages or site-packages)
+  to the default install path (typically dist-packages or site-packages).
   [Contributed by Ignacio Vizzo]
 - As of this release, VFX Reference Platform 2019 is no longer supported.
   CMake now issues deprecation warnings for 2020 VFX Reference Platform
   version dependencies.
-- Build fixes for OpenVDB AX with C++17 and greater
-- Bumped the new blosc version future minimum to 1.17.0
+- Build fixes for OpenVDB AX with C++17 and greater.
+- Bumped the new blosc version future minimum to 1.17.0.
 - OpenEXR is now optional for vdb_render. It can be enabled with
   -DUSE_EXR=ON.
 
@@ -142,10 +157,10 @@ Improvements:
   hue, saturation and value inputs to RGB values and vice-versa.
 - PointDataGrid conversion can now be performed using 32-bit float arrays.
 - Improved support for size_t grid types on systems where size_t is a unique
-  type
+  type.
   [Contributed by Brecht Van Lommel]
 - Add support for dilation in one direction and extending a field in one
-  direction
+  direction in fast sweeping algorithms.
 
 @par
 API changes:
@@ -181,14 +196,14 @@ Build:
   generated doxygen.
 - Improved the doxygen deprecation listings, folder layouts and fixes
   issues when using later versions of doxygen.
-- Build fixes for MinGW on Windows
+- Build fixes for MinGW on Windows.
   [Contributed by Brecht Sanders]
-- Added support for OpenEXR 3
+- Added support for OpenEXR 3.
   [Contributed by Cary Phillips]
 - Added an OPENVDB_NAMESPACE_SUFFIX CMake string option which provides the
   ability to customise the VDB namespace.
 - The Python Module now appends the base directory defined by Python_SITELIB
-  to the default install path (typically dist-packages or site-packages)
+  to the default install path (typically dist-packages or site-packages).
   [Contributed by Ignacio Vizzo]