netcdf-c/docs/Makefile.am

71 lines
2.2 KiB
Makefile
Raw Normal View History

2010-06-03 21:24:43 +08:00
## This is a automake file, part of Unidata's netCDF package.
# Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014,
# 2015, 2016, 2017, 2018
# University Corporation for Atmospheric Research/Unidata.
# See netcdf-c/COPYRIGHT file for more info.
2010-06-03 21:24:43 +08:00
# These files will be included with the dist.
2017-11-15 02:50:58 +08:00
EXTRA_DIST = netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html \
2020-02-08 04:47:45 +08:00
mainpage.dox tutorial.dox cdl.dox \
2017-11-15 02:50:58 +08:00
architecture.dox internal.dox windows-binaries.md \
building-with-cmake.md CMakeLists.txt groups.dox notes.md \
2017-11-15 02:50:58 +08:00
install-fortran.md all-error-codes.md credits.md auth.md \
obsolete/fan_utils.html indexing.dox \
inmemory.md attribute_conventions.md FAQ.md \
2018-12-08 06:27:40 +08:00
file_format_specifications.md known_problems.md COPYRIGHT.md \
inmeminternal.dox \
Provide byte-range reading of remote datasets re: issue https://github.com/Unidata/netcdf-c/issues/1251 Assume that you have the URL to a remote dataset which is a normal netcdf-3 or netcdf-4 file. This PR allows the netcdf-c to read that dataset's contents as a netcdf file using HTTP byte ranges if the remote server supports byte-range access. Originally, this PR was set up to access Amazon S3 objects, but it can also access other remote datasets such as those provided by a Thredds server via the HTTPServer access protocol. It may also work for other kinds of servers. Note that this is not intended as a true production capability because, as is known, this kind of access to can be quite slow. In addition, the byte-range IO drivers do not currently do any sort of optimization or caching. An additional goal here is to gain some experience with the Amazon S3 REST protocol. This architecture and its use documented in the file docs/byterange.dox. There are currently two test cases: 1. nc_test/tst_s3raw.c - this does a simple open, check format, close cycle for a remote netcdf-3 file and a remote netcdf-4 file. 2. nc_test/test_s3raw.sh - this uses ncdump to investigate some remote datasets. This PR also incorporates significantly changed model inference code (see the superceded PR https://github.com/Unidata/netcdf-c/pull/1259). 1. It centralizes the code that infers the dispatcher. 2. It adds support for byte-range URLs Other changes: 1. NC_HDF5_finalize was not being properly called by nc_finalize(). 2. Fix minor bug in ncgen3.l 3. fix memory leak in nc4info.c 4. add code to walk the .daprc triples and to replace protocol= fragment tag with a more general mode= tag. Final Note: Th inference code is still way too complicated. We need to move to the validfile() model used by netcdf Java, where each dispatcher is asked if it can process the file. This decentralizes the inference code. This will be done after all the major new dispatchers (PIO, Zarr, etc) have been implemented.
2019-01-02 09:27:36 +08:00
testserver.dox byterange.dox
2010-06-03 21:24:43 +08:00
# Turn off parallel builds in this directory.
.NOTPARALLEL:
# To build documentation you must have M4 in their path.
2018-06-06 01:30:59 +08:00
M4 = m4
2010-06-03 21:24:43 +08:00
SUBDIRS = images
2010-06-03 21:24:43 +08:00
if BUILD_DOCS
2010-06-03 21:24:43 +08:00
# Copy man pages.
#directory = $(top_srcdir)/docs/man/man3/
2014-05-22 04:40:39 +08:00
#dist_man_MANS = $(docsdirectory)/man_page_1.3 $(directory)/man_page_2.3
2011-07-21 05:39:14 +08:00
# $(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:
2014-05-22 04:40:39 +08:00
rm -rf $(top_builddir)/docs/man
rm -rf $(top_builddir)/docs/html
rm -rf $(top_builddir)/docs/latex
2018-06-06 01:30:59 +08:00
rm -rf $(top_builddir)/docs/latex_main
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
2018-06-06 01:30:59 +08:00
CLEANFILES = doxyfile.stamp
# 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
2012-01-03 01:31:23 +08:00
cd html; tar cf ../netcdf_docs.tar *
gzip -f netcdf_docs.tar