Commit Graph

22 Commits

Author SHA1 Message Date
Dennis Heimbigner
30860ce48f fix makefile/cmakelist extra-dist problems 2018-04-13 13:27:43 -06:00
Dennis Heimbigner
ccc70d640b re: esupport MQO-415619
and https://github.com/Unidata/netcdf-c/issues/708

Expand the NC_INMEMORY capabilities to support writing and accessing
the final modified memory.

Three new functions have been added:
nc_open_memio, nc_create_mem, and nc_close_memio.

The following new capabilities were added.
1. nc_open_memio() allows the NC_WRITE mode flag
   so a chunk of memory can be passed in and be modified
2. nc_create_mem() allows the NC_INMEMORY flag to be set
   to cause the created file to be kept in memory.
3. nc_close_mem() allows the final in-memory contents to be
   retrieved at the time the file is closed.
4. A special flag, NC_MEMIO_LOCK, is provided to ensure that
   the provided memory will not be freed or reallocated.

Note the following.
1. If nc_open_memio() is called with NC_WRITE, and NC_MEMIO_LOCK is not set,
   then the netcdf-c library will take control of the incoming memory.
   This means that the original memory block should not be freed
   but the block returned by nc_close_mem() must be freed.
2. If nc_open_memio() is called with NC_WRITE, and NC_MEMIO_LOCK is set,
   then modifications to the original memory may fail if the space available
   is insufficient.

Documentation is provided in the file docs/inmemory.md.
A test case is provided: nc_test/tst_inmemory.c driven by
nc_test/run_inmemory.sh

WARNING: changes were made to the dispatch table for
the close entry. From int (*close)(int) to int (*close)(int,void*).
2018-02-25 21:45:31 -07:00
Dennis Heimbigner
c05c0a69e2 Update docs/internal.dox to
provide a more accurate description
of how to add a new dispatch table.
Also remove dispatch.dox as superfluous.
2017-10-04 13:41:38 -06:00
Ward Fisher
94451d18d8 Adding fan_utils.html. 2016-01-19 16:15:51 -07:00
Ward Fisher
0ef498e6b5 Reworked doxygen so that auth.html is only generated when needed, as I'm sure it was originally intended. Created a specific make target in docs directory, 'oc2-auth', for autotools and cmake. 2015-10-27 18:23:54 -06:00
Ward Fisher
49dfc5beef Updated doxygen to work properly with auth.html. 2015-10-27 17:56:28 -06:00
Ward Fisher
64a42f4f8a Fixing generation of doxygen-based documentation. 2015-10-27 15:32:18 -06:00
Ward Fisher
b26598c833 Merging Jen's new search option for releases into user documentation. 2015-08-17 10:59:32 -06:00
Ward Fisher
44c4390732 Updated generation of auth.md 2015-06-04 14:34:06 -06:00
Ward Fisher
26a157f703 Converted ocauth.html to markdown with Pandoc. 2015-06-03 15:48:14 -06:00
Ward Fisher
76e85a9c76 Working on cleaning up the auth.md file. 2015-06-03 15:15:00 -06:00
dmh
8673e66640 A couple of docs/ .dox files have apparently
been converted to .md.
2015-04-16 16:44:51 -06:00
Ward Fisher
aee5888f76 Updated doxygen pdf target. 2015-03-13 15:02:13 -06:00
Ward Fisher
4958670b0c Added a new .gitignore specific to include/.
Added netcdf_meta.h to user documentation generated by doxygen.
2014-09-18 15:05:08 -06:00
Ward Fisher
32ec10d440 Merged tutorial, user guide back into main documentation to make it easier to reorganize the documentation has a whole. Turned on server-side search for documentation. 2014-09-03 10:21:49 -06:00
Ward Fisher
f07108ec43 Changed several cmake-based messages to use WARNING instead of STATUS. Changed DOXYGEN_LATEX_OUTPUT to DOXYGEN_PDF_OUTPUT to reflect that the latex is processed into pdf as part of the build process. Flagged the ENABLE_DOXYGEN_PDF_OUTPUT option as Experimental. 2014-06-20 17:41:09 -06:00
Ward Fisher
db488b104d Added check for pdflatex when building PDF documentation. Documented new configuration option for CMake in RELEASE_NOTES.md 2014-06-18 15:19:14 -06:00
Ward Fisher
45e41c79f9 Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen. 2014-06-18 14:33:49 -06:00
Ward Fisher
7baaeecb12 A bit of whitespace cleanup, clarification of messages in CMake-based builds. 2014-06-18 13:46:22 -06:00
Ward Fisher
7f812b367e Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements. 2014-06-11 15:51:31 -06:00
Ward Fisher
b65f8ee73d Merged pull request 'make better use of GNUInstallDirs' contributed by nschloe, https://github.com/Unidata/netcdf-c/pull/57 2014-05-21 15:15:56 -06:00
Ward Fisher
05aaa4b376 Renamed man4 directory to docs. 2014-05-21 14:40:39 -06:00