mirror of
https://github.com/Unidata/netcdf-c.git
synced 2025-01-06 15:34:44 +08:00
ccc70d640b
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*).
66 lines
2.1 KiB
Makefile
66 lines
2.1 KiB
Makefile
## This is a automake file, part of Unidata's netCDF package.
|
|
# Copyright 2005-2011, see the COPYRIGHT file for more information.
|
|
# This file builds the netcdf documentation.
|
|
|
|
|
|
# These files will be included with the dist.
|
|
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 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:
|
|
|
|
# To build documentation you must have M4 in their path.
|
|
M4=m4
|
|
|
|
SUBDIRS = images
|
|
|
|
if BUILD_DOCS
|
|
|
|
# Copy man pages.
|
|
#directory = $(top_srcdir)/docs/man/man3/
|
|
#dist_man_MANS = $(docsdirectory)/man_page_1.3 $(directory)/man_page_2.3
|
|
# $(directory)/man_page_1.3: doxyfile.stamp
|
|
# $(directory)/man_page_2.3: doxyfile.stamp
|
|
|
|
# Note: in order to work with distcheck,
|
|
# the Doxyfile needs to be preprocessed
|
|
# to insert actual location of $(srcdir)
|
|
#BUILT_SOURCES = Doxyfile.tmp
|
|
|
|
#Doxyfile.tmp: Doxyfile
|
|
# sed -e 's|$$[({]rootdir[})]|$(abs_top_srcdir)|g' <Doxyfile > ./Doxyfile.tmp
|
|
|
|
all-local: doxyfile.stamp
|
|
clean-local:
|
|
rm -rf $(top_builddir)/docs/man
|
|
rm -rf $(top_builddir)/docs/html
|
|
rm -rf $(top_builddir)/docs/latex
|
|
endif
|
|
|
|
# Timestamp to prevent rebuilds.
|
|
# We must do this twice. The first time
|
|
# builds the tag files. The second time
|
|
# includes them in the documentation.
|
|
|
|
doxyfile.stamp:
|
|
$(DOXYGEN) Doxyfile \
|
|
cp auth.md obsolete/fan_utils.html html
|
|
|
|
CLEANFILES = doxyfile.stamp html latex man
|
|
|
|
# This builds the docs from source, if necessary, and tars up
|
|
# everything needed for the website. Run this and copy the resulting
|
|
# tarball to the /contents/netcdf/docs directory to update the on-line
|
|
# docs.
|
|
web-tarball: doxyfile.stamp
|
|
cd html; tar cf ../netcdf_docs.tar *
|
|
gzip -f netcdf_docs.tar
|