Expand the NC_INMEMORY capabilities

RELEASE_NOTES.md

@@ -7,6 +7,7 @@ This file contains a high-level description of this package's evolution. Release
 
 ## 4.7.0 - TBD
 
+* [Enhancement] Expanded the capabilities of `NC_INMEMORY` to support writing and accessing the final modified memory.  See [GitHub #879](https://github.com/Unidata/netcdf-c/pull/879) for more information.
 * [Enhancement] Made CDF5 support enabled by default.  See [Github #931](https://github.com/Unidata/netcdf-c/issues/931) for more information.
 
 

cf

@@ -106,20 +106,18 @@ FLAGS="$FLAGS --enable-extreme-numbers"
 #FLAGS="$FLAGS --disable-testsets"
 #FLAGS="$FLAGS --disable-dap-remote-tests"
 #FLAGS="$FLAGS --enable-dap-auth-tests" -- requires a new remotetest server
-FLAGS="$FLAGS --enable-doxygen --enable-internal-docs"
+#FLAGS="$FLAGS --enable-doxygen --enable-internal-docs"
 FLAGS="$FLAGS --enable-logging"
 #FLAGS="$FLAGS --disable-diskless"
 #FLAGS="$FLAGS --enable-mmap"
 #FLAGS="$FLAGS --with-udunits"
 #FLAGS="$FLAGS --with-libcf"
-#valgrind => not shared
-#FLAGS="$FLAGS --enable-valgrind-tests"
 #FLAGS="$FLAGS --enable-jna"
 #FLAGS="$FLAGS --disable-properties-attribute"
 #FLAGS="$FLAGS --disable-silent-rules"
 #FLAGS="$FLAGS --with-testservers=remotestserver.localhost:8083"
 #FLAGS="$FLAGS --disable-filter-testing"
-#FLAGS="$FLAGS --enable-metadata-perf"
+FLAGS="$FLAGS --enable-metadata-perf"
 
 if test "x$PAR4" != x1 ; then
 FLAGS="$FLAGS --disable-parallel4"

cf.cmake

@@ -36,26 +36,40 @@ FLAGS="-DCMAKE_PREFIX_PATH=c:/tools/nccmake"
 fi
 FLAGS="$FLAGS -DCMAKE_INSTALL_PREFIX=/tmp/netcdf"
 
-if test "x$DAP" = x ; then FLAGS="$FLAGS -DENABLE_DAP=false"; fi
-if test "x$NC4" = x ; then FLAGS="$FLAGS -DENABLE_NETCDF_4=false"; fi
-if test "x$CDF5" != x ; then FLAGS="$FLAGS -DENABLE_CDF5=true"; fi
-if test "x$HDF4" != x ; then FLAGS="$FLAGS -DENABLE_HDF4=true"; fi
-FLAGS="$FLAGS -DENABLE_CONVERSION_WARNINGS=false"
+if test "x$DAP" = x ; then
+FLAGS="$FLAGS -DENABLE_DAP=false"
+fi
+if test "x$NC4" = x ; then
+FLAGS="$FLAGS -DENABLE_NETCDF_4=false"
+fi
+if test "x$CDF5" != x ; then
+FLAGS="$FLAGS -DENABLE_CDF5=true"
+fi
+if test "x$HDF4" != x ; then
+FLAGS="$FLAGS -DENABLE_HDF4=true"
+fi
+
+# Enables
 FLAGS="$FLAGS -DENABLE_DAP_REMOTE_TESTS=true"
-FLAGS="$FLAGS -DENABLE_TESTS=true"
-FLAGS="$FLAGS -DENABLE_EXAMPLES=false"
-FLAGS="$FLAGS -DENABLE_DYNAMIC_LOADING=false"
-FLAGS="$FLAGS -DENABLE_WINSOCK2=false"
+FLAGS="$FLAGS -DENABLE_LOGGING=true"
+#FLAGS="$FLAGS -DENABLE_DOXYGEN=true -DENABLE_INTERNAL_DOCS=true"
 #FLAGS="$FLAGS -DENABLE_LARGE_FILE_TESTS=true"
 FLAGS="$FLAGS -DENABLE_FILTER_TESTING=true"
 
+# Disables
+FLAGS="$FLAGS -DENABLE_EXAMPLES=false"
+FLAGS="$FLAGS -DENABLE_CONVERSION_WARNINGS=false"
+#FLAGS="$FLAGS -DENABLE_TESTS=false"
+#FLAGS="$FLAGS -DENABLE_DISKLESS=false"
+
 rm -fr build
 mkdir build
 cd build
 
 NCLIB=`pwd`
 
 if test "x$VS" != x ; then
+
 # Visual Studio
 CFG="Release"
 NCLIB="${NCLIB}/liblib"

configure.ac

@@ -786,7 +786,7 @@ fi
 
 # Setup the diskless and mmap conditionals
 if test "x$enable_diskless" = xyes ; then
-  AC_DEFINE([USE_DISKLESS], [1], [if true, include NC_DISKLESS code])
+  AC_DEFINE([USE_DISKLESS], [1], [if true, include NC_DISKLESS and NC_INMEMORY code])
   if test "x$enable_mmap" = xyes; then
     AC_DEFINE([USE_MMAP], [1], [if true, use mmap for in-memory files])
   fi

docs/CMakeLists.txt

@@ -74,6 +74,16 @@ IF(ENABLE_DOXYGEN)
 
 ENDIF(ENABLE_DOXYGEN)
 
-SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST} CMakeLists.txt Makefile.am netcdf.m4 DoxygenLayout.xml Doxyfile.in Doxyfile.guide.in footer.html mainpage.dox tutorial.dox guide.dox types.dox notes.md cdl.dox architecture.dox internal.dox install-fortran.dox Doxyfile.in.cmake windows-binaries.md building-with-cmake.md install.md)
+# Should match list in Makefile.am
+SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST}
+netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html
+mainpage.dox tutorial.dox guide.dox types.dox cdl.dox
+architecture.dox internal.dox windows-binaries.md
+building-with-cmake.md CMakeLists.txt groups.dox install.md notes.md
+install-fortran.md all-error-codes.md credits.md auth.md
+obsolete/fan_utils.html bestpractices.md filters.md indexing.md
+inmemory.md DAP4.dox OPeNDAP.dox attribute_conventions.md FAQ.md
+file_format_specifications.md known_problems.md
+COPYRIGHT.dox)
 
 ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")

docs/Doxyfile.in

@@ -757,7 +757,9 @@ INPUT = \
     @abs_top_srcdir@/docs/DAP4.dox \
     @abs_top_srcdir@/docs/attribute_conventions.md \
     @abs_top_srcdir@/docs/file_format_specifications.md \
-    @abs_top_srcdir@/docs/tutorial.dox \
+    @abs_top_srcdir@/docs/auth.md \
+    @abs_top_srcdir@/docs/filters.md \
+    @abs_top_srcdir@/docs/inmemory.md \
     @abs_top_srcdir@/docs/notes.md \
     @abs_top_srcdir@/docs/auth.md \
     @abs_top_srcdir@/docs/filters.md \
@@ -767,6 +769,7 @@ INPUT = \
     @abs_top_srcdir@/docs/COPYRIGHT.dox \
     @abs_top_srcdir@/docs/credits.md \
     @abs_top_srcdir@/docs/bestpractices.md \
+    @abs_top_srcdir@/docs/tutorial.dox \
     @abs_top_srcdir@/include/netcdf.h \
     @abs_top_srcdir@/include/netcdf_mem.h \
     @abs_top_srcdir@/include/netcdf_par.h \

docs/Makefile.am

@@ -9,7 +9,10 @@ mainpage.dox tutorial.dox guide.dox types.dox cdl.dox			\
 architecture.dox internal.dox windows-binaries.md			\
 building-with-cmake.md CMakeLists.txt groups.dox install.md notes.md	\
 install-fortran.md all-error-codes.md credits.md auth.md		\
-obsolete/fan_utils.html bestpractices.md filters.md indexing.dox
+obsolete/fan_utils.html bestpractices.md filters.md indexing.dox         \
+inmemory.md DAP4.dox OPeNDAP.dox attribute_conventions.md FAQ.md        \
+file_format_specifications.md known_problems.md                         \
+COPYRIGHT.dox
 
 # Turn off parallel builds in this directory.
 .NOTPARALLEL:

docs/auth.md

@@ -512,9 +512,10 @@ what you changed to the author so this document can be updated.
     done
     exit
 
-## Provenance
+## Point of Contact
 
 __Author__: Dennis Heimbigner<br>
+__Email__: dmh at ucar dot edu
 __Initial Version__: 11/21/2014<br>
 __Last Revised__: 08/24/2017
 

docs/filters.md

@@ -1,8 +1,8 @@
-Filter Support in netCDF-4 (Enhanced)
+NetCDF-4 Filter Support
 ============================
 <!-- double header is needed to workaround doxygen bug -->
 
-Filter Support in netCDF-4 (Enhanced) {#compress}
+NetCDF-4 Filter Support {#compress}
 =================================
 
 [TOC]
@@ -434,19 +434,19 @@ Test for Machine Endianness
 static const unsigned char b[4] = {0x0,0x0,0x0,0x1}; /* value 1 in big-endian*/
 int endianness = (1 == *(unsigned int*)b); /* 1=>big 0=>little endian
 ````
+References {#References}
+========================
 
-Provenance
+1. https://support.hdfgroup.org/HDF5/doc/Advanced/DynamicallyLoadedFilters/HDF5DynamicallyLoadedFilters.pdf
+2. https://support.hdfgroup.org/HDF5/doc/TechNotes/TechNote-HDF5-CompressionTroubleshooting.pdf
+3. https://portal.hdfgroup.org/display/support/Contributions#Contributions-filters
+4. https://support.hdfgroup.org/services/contributions.html#filters
+
+Point of Contact
 ================
 
 __Author__: Dennis Heimbigner<br>
 __Email__: dmh at ucar dot edu
 __Initial Version__: 1/10/2018<br>
 __Last Revised__: 2/5/2018
 
-References {#References}
-==========
-
-1. https://support.hdfgroup.org/HDF5/doc/Advanced/DynamicallyLoadedFilters/HDF5DynamicallyLoadedFilters.pdf
-2. https://support.hdfgroup.org/HDF5/doc/TechNotes/TechNote-HDF5-CompressionTroubleshooting.pdf
-3. https://portal.hdfgroup.org/display/support/Contributions#Contributions-filters
-4. https://support.hdfgroup.org/services/contributions.html#filters