mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-27 08:49:16 +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*.
102 lines
3.8 KiB
CMake
102 lines
3.8 KiB
CMake
# 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.
|
|
|
|
#####
|
|
# Build doxygen documentation, if need be.
|
|
#####
|
|
IF(ENABLE_DOXYGEN)
|
|
# The following is redundant but does not hurt anything.
|
|
|
|
FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.html ${CMAKE_CURRENT_SOURCE_DIR}/images ${CMAKE_CURRENT_SOURCE_DIR}/*.doc ${CMAKE_CURRENT_SOURCE_DIR}/*.xml ${CMAKE_CURRENT_SOURCE_DIR}/*.m4 ${CMAKE_CURRENT_SOURCE_DIR}/*.texi ${CMAKE_SOURCE_DIR}/oc2/auth.html.in)
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
|
|
|
|
# Set abs_top_srcdir to work with the autotools
|
|
# doxyfile template.
|
|
SET(abs_top_srcdir ${CMAKE_SOURCE_DIR})
|
|
SET(abs_builddir ${CMAKE_CURRENT_BINARY_DIR})
|
|
|
|
# Create general and guide doxyfiles.
|
|
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
|
|
|
# Create auth.html with some sed commands.
|
|
ADD_CUSTOM_TARGET(oc2_auth ALL
|
|
|
|
COMMAND cat ${CMAKE_SOURCE_DIR}/oc2/auth.html.in | sed -e "/<OC>/d" | sed -e "s|^<NC>||" | sed -e "s|zz|netcdf|g" -e "s|ZZ|netCDF|g" | sed -e "/stylesheet/r${CMAKE_SOURCE_DIR}/oc2/oc.css" -e "/stylesheet/d" > ${CMAKE_CURRENT_SOURCE_DIR}/auth.html
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
VERBATIM
|
|
)
|
|
|
|
# Generate User Documentation
|
|
ADD_CUSTOM_TARGET(doc_all ALL
|
|
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/obsolete/fan_utils.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating API Documentation" VERBATIM
|
|
)
|
|
|
|
|
|
|
|
# If ENABLE_DOXYGEN_LATEX_OUTPUT is true, automatically build
|
|
# the PDF files.
|
|
IF(ENABLE_DOXYGEN_PDF_OUTPUT)
|
|
# Process 'main' netcdf documentation.
|
|
FIND_PROGRAM(NC_MAKE NAMES make)
|
|
FIND_PROGRAM(NC_PDFLATEX NAMES pdflatex)
|
|
IF(NOT NC_MAKE OR NOT NC_PDFLATEX)
|
|
MESSAGE(WARNING "Unable to locate 'make' and/or 'pdflatex' program. Unable to build pdf documentation.")
|
|
ELSE()
|
|
ADD_CUSTOM_TARGET(doc_all_pdf ALL
|
|
make
|
|
COMMAND mv refman.pdf ../netcdf.pdf
|
|
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/latex_main"
|
|
COMMENT "Building NetCDF PDF Documentation" VERBATIM
|
|
)
|
|
|
|
INSTALL(FILES "${CMAKE_CURRENT_BINARY_DIR}/netcdf.pdf"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-guide.pdf"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-tutorial.pdf"
|
|
DESTINATION "${CMAKE_INSTALL_DOCDIR}/pdf"
|
|
|
|
COMPONENT documentation)
|
|
|
|
ENDIF()
|
|
|
|
ENDIF()
|
|
|
|
|
|
# Copy the image files used by markdown documentation
|
|
# manually.
|
|
FILE(GLOB IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/images/*.jpg
|
|
${CMAKE_CURRENT_BINARY_DIR}/images/*.png)
|
|
|
|
FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html)
|
|
|
|
INSTALL(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/"
|
|
DESTINATION "${CMAKE_INSTALL_DOCDIR}/html"
|
|
COMPONENT documentation)
|
|
|
|
ENDIF(ENABLE_DOXYGEN)
|
|
|
|
# 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
|
|
architecture.dox internal.dox windows-binaries.md
|
|
building-with-cmake.md CMakeLists.txt groups.dox install.md notes.md
|
|
install-fortran.md credits.md auth.md
|
|
obsolete/fan_utils.html bestpractices.md filters.md indexing.md
|
|
inmemory.md DAP2.dox FAQ.md
|
|
known_problems.md
|
|
COPYRIGHT.dox user_defined_formats.md DAP4.md DAP4.dox
|
|
testserver.dox byterange.md filters.md nczarr.md auth.md quantize.md
|
|
quickstart_paths.md cloud.md)
|
|
|
|
ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")
|