mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-21 08:39:46 +08:00
49737888ca
## Improvements to S3 Documentation * Create a new document *quickstart_paths.md* that give a summary of the legal path formats used by netcdf-c. This includes both file paths and URL paths. * Modify *nczarr.md* to remove most of the S3 related text. * Move the S3 text from *nczarr.md* to a new document *cloud.md*. * Add some S3-related text to the *byterange.md* document. Hopefully, this will make it easier for users to find the information they want. ## Rebuild NCZarr Testing In order to avoid problems with running make check in parallel, two changes were made: 1. The *nczarr_test* test system was rebuilt. Now, for each test. any generated files are kept in a test-specific directory, isolated from all other test executions. 2. Similarly, since the S3 test bucket is shared, any generated S3 objects are isolated using a test-specific key path. ## Other S3 Related Changes * Add code to ensure that files created on S3 are reclaimed at end of testing. * Used the bash "trap" command to ensure S3 cleanup even if the test fails. * Cleanup the S3 related configure.ac flag set since S3 is used in several places. So now one should use the option *--enable-s3* instead of *--enable-nczarr-s3*, although the latter is still kept as a deprecated alias for the former. * Get some of the github actions yml to work with S3; required fixing various test scripts adding a secret to access the Unidata S3 bucket. * Cleanup S3 portion of libnetcdf.settings.in and netcdf_meta.h.in and test_common.in. * Merge partial S3 support into dhttp.c. * Create an experimental s3 access library especially for use with Windows. It is enabled by using the options *--enable-s3-internal* (automake) or *-DENABLE_S3_INTERNAL=ON* (CMake). Also add a unit-test for it. * Move some definitions from ncrc.h to ncs3sdk.h ## Other Changes * Provide a default implementation of strlcpy and move this and similar defaults into *dmissing.c*.
70 lines
2.3 KiB
Makefile
70 lines
2.3 KiB
Makefile
## 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.
|
|
|
|
# These files will be included with the dist.
|
|
EXTRA_DIST = netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html \
|
|
mainpage.dox tutorial.dox architecture.dox internal.md \
|
|
windows-binaries.md dispatch.md building-with-cmake.md CMakeLists.txt groups.dox \
|
|
notes.md install-fortran.md credits.md auth.md filters.md \
|
|
obsolete/fan_utils.html indexing.dox inmemory.md FAQ.md \
|
|
known_problems.md COPYRIGHT.md inmeminternal.dox testserver.dox \
|
|
byterange.md nczarr.md quantize.md all-error-codes.md \
|
|
quickstart_paths.md cloud.md
|
|
|
|
# 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
|
|
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
|
|
|
|
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.
|
|
# UPDATE Nov 12, 2021: docs now published to Unidata artifacts server.
|
|
web-tarball: doxyfile.stamp
|
|
cd html; tar cf ../netcdf_docs.tar *
|
|
gzip -f netcdf_docs.tar
|