mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2024-12-27 08:49:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
310e743b55
netcdf-c/docs/CMakeLists.txt

98 lines
3.8 KiB
CMake
Raw Normal View History

Updating files to refer to the top-level COPYRIGHT file.
2018-12-05 06:52:43 +08:00
# 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.
2012-08-18 05:41:20 +08:00
#####
# Build doxygen documentation, if need be.
#####
Removed redundant BUILD_DOCS CMake variable.
2014-05-22 04:13:23 +08:00
IF(ENABLE_DOXYGEN)
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
# The following is redundant but does not hurt anything.
Fixed netcdf-c issue #30 (on github) related to cmake-generated nc-config script. Initial split of Guide from rest of documentation. Using 'tagfiles' to cross-reference from one documentation set to the other works, but then it drags all of the 'external' related pages into the index of the other. Modified visability of the external groups and pages. Adding proper section names to 'Example' sections, to avoid Doxygen warnings. Initial split of Guide from rest of documentation. Using 'tagfiles' to cross-reference from one documentation set to the other works, but then it drags all of the 'external' related pages into the index of the other. Modified visability of the external groups and pages. Adding proper section names to 'Example' sections, to avoid Doxygen warnings. Reorganizing documentation into two separate doxygen projects. Moved .texi documents into an old directory. Pulled the tutorial document into a separate document, similar to the guide document. Turned on treeview
2014-03-09 08:39:09 +08:00
Fixing generation of doxygen-based documentation.
2015-10-28 05:32:18 +08:00
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)
Removed redundant BUILD_DOCS CMake variable.
2014-05-22 04:13:23 +08:00
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
A bit of whitespace cleanup, clarification of messages in CMake-based builds.
2014-06-19 03:46:22 +08:00
# Set abs_top_srcdir to work with the autotools
Removed redundant BUILD_DOCS CMake variable.
2014-05-22 04:13:23 +08:00
# doxyfile template.
SET(abs_top_srcdir ${CMAKE_SOURCE_DIR})
SET(abs_builddir ${CMAKE_CURRENT_BINARY_DIR})
A bit of whitespace cleanup, clarification of messages in CMake-based builds.
2014-06-19 03:46:22 +08:00
Removed redundant BUILD_DOCS CMake variable.
2014-05-22 04:13:23 +08:00
# Create general and guide doxyfiles.
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
Updated doxygen to work properly with auth.html.
2015-10-28 07:56:28 +08:00
# Generate User Documentation
ADD_CUSTOM_TARGET(doc_all ALL
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
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-28 08:23:54 +08:00
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
Adding fan_utils.html.
2016-01-20 07:15:51 +08:00
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/obsolete/fan_utils.html ${CMAKE_CURRENT_BINARY_DIR}/html
Fixing generation of doxygen-based documentation.
2015-10-28 05:32:18 +08:00
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
Updated doxygen to work properly with auth.html.
2015-10-28 07:56:28 +08:00
COMMENT "Generating API Documentation" VERBATIM)
Converted ocauth.html to markdown with Pandoc.
2015-06-04 05:48:14 +08:00
Updated doxygen to work properly with auth.html.
2015-10-28 07:56:28 +08:00
# Create auth.html with some sed commands.
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-28 08:23:54 +08:00
ADD_CUSTOM_TARGET(oc2-auth
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
Fixing generation of doxygen-based documentation.
2015-10-28 05:32:18 +08:00
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
Working on cleaning up the auth.md file.
2015-06-04 05:15:00 +08:00
VERBATIM
)
Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen.
2014-06-19 04:33:49 +08:00
# If ENABLE_DOXYGEN_LATEX_OUTPUT is true, automatically build
# the PDF files.
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-21 07:41:09 +08:00
IF(ENABLE_DOXYGEN_PDF_OUTPUT)
Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen.
2014-06-19 04:33:49 +08:00
# Process 'main' netcdf documentation.
FIND_PROGRAM(NC_MAKE NAMES make)
Added check for pdflatex when building PDF documentation. Documented new configuration option for CMake in RELEASE_NOTES.md
2014-06-19 05:19:14 +08:00
FIND_PROGRAM(NC_PDFLATEX NAMES pdflatex)
IF(NOT NC_MAKE OR NOT NC_PDFLATEX)
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-21 07:41:09 +08:00
MESSAGE(WARNING "Unable to locate 'make' and/or 'pdflatex' program. Unable to build pdf documentation.")
Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen.
2014-06-19 04:33:49 +08:00
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
)
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-21 07:41:09 +08:00
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"
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-28 08:23:54 +08:00
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-21 07:41:09 +08:00
COMPONENT documentation)
Added check for pdflatex when building PDF documentation. Documented new configuration option for CMake in RELEASE_NOTES.md
2014-06-19 05:19:14 +08:00
Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen.
2014-06-19 04:33:49 +08:00
ENDIF()
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-21 07:41:09 +08:00
Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen.
2014-06-19 04:33:49 +08:00
ENDIF()
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
# Copy the image files used by markdown documentation
Merged pull request 'make better use of GNUInstallDirs' contributed by nschloe, https://github.com/Unidata/netcdf-c/pull/57
2014-05-22 05:15:56 +08:00
# manually.
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
FILE(GLOB IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/images/*.jpg
Merged pull request 'make better use of GNUInstallDirs' contributed by nschloe, https://github.com/Unidata/netcdf-c/pull/57
2014-05-22 05:15:56 +08:00
${CMAKE_CURRENT_BINARY_DIR}/images/*.png)
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html)
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-21 07:41:09 +08:00
INSTALL(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/"
DESTINATION "${CMAKE_INSTALL_DOCDIR}/html"
Merged pull request 'make better use of GNUInstallDirs' contributed by nschloe, https://github.com/Unidata/netcdf-c/pull/57
2014-05-22 05:15:56 +08:00
COMPONENT documentation)
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
Merged pull request 'make better use of GNUInstallDirs' contributed by nschloe, https://github.com/Unidata/netcdf-c/pull/57
2014-05-22 05:15:56 +08:00
ENDIF(ENABLE_DOXYGEN)
2012-08-18 05:41:20 +08:00
fix makefile/cmakelist extra-dist problems
2018-04-14 03:27:43 +08:00
# Should match list in Makefile.am
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-26 12:45:31 +08:00
SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST}
fix makefile/cmakelist extra-dist problems
2018-04-14 03:27:43 +08:00
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 indexing.md
Modify DAP2 and DAP4 to optionally allow Fillvalue/Variable mismatch re: issue https://github.com/Unidata/netcdf-c/issues/1151 Modify DAP2 and DAP4 code to handle case when _FillValue type is not same as the parent variable type. Specifically: 1. Define a parameter [fillmismatch] to allow this mismatch; default is to disallow. 2. If allowed, forcibly change the type of the _FillValue to match the parent variable. 3. If allowed Convert the values to match new type 4. Generate a log message 5. if not allowed, then fail Implementing this required some changes to ncdap_test/dapcvt.c Also added test cases. Minor Unrelated Changes: 1. There were a number of warnings about e.g. assigning a const char* to a char*. Fix these 2. In nccopy.1, replace .NP with .IP "n" (re PR https://github.com/Unidata/netcdf-c/pull/1144) 3. fix minor error in ncdump/ocprint
2018-10-02 05:51:43 +08:00
inmemory.md DAP2.dox attribute_conventions.md FAQ.md
fix makefile/cmakelist extra-dist problems
2018-04-14 03:27:43 +08:00
file_format_specifications.md known_problems.md
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
COPYRIGHT.dox user_defined_formats.md DAP4.md DAP4.dox
Significantly Improve Amazon S3 Cloud Storage Support ## S3 Related Fixes * Add comprehensive support for specifying AWS profiles to provide access credentials. * Parse the files "~/.aws/config" and "~/.aws/credentials to provide credentials for the HDF5 ROS3 driver and to locate default region. * Add a function to obtain the currently active S3 credentials. The search rules are defined in docs/nczarr.md. * Provide documentation for the new features. * Modify the struct NCauth (in include/ncauth.h) to replace specific S3 credentials with a profile name. * Add a unit test to test the operation of profile and credentials management. * Add support for URLS of the form "s3://<bucket>/<key>"; this requires obtaining a default region. * Allows the specification of profile and/or region in a URL of the form "#mode=nczarr,...&aws.region=...&aws.profile=..." ## Misc. Fixes * Move the ezxml code to libdispatch so that it can be used both by DAP4 and nczarr. * Modify nclist to provide a deep clone operation. * Modify ncuri to provide a deep clone operation. * Modify the .rc file format to allow the specification of a path to be tested when looking for an entry in the .rc file. * Ensure that the NC_rcload function is called. * Modify nchttp to support setting request headers.
2021-09-28 08:36:33 +08:00
testserver.dox byterange.dox filters.md nczarr.md auth.md)
Added initial 'make dist', 'make distcheck' support to CMake-based builds.
2013-06-04 00:42:04 +08:00
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-12 05:51:31 +08:00
ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")
Reference in New Issue Copy Permalink