From 05676d1abe6014326abd342d54dab5fca632b10c Mon Sep 17 00:00:00 2001 From: Scot Breitenfeld Date: Tue, 31 Mar 2026 18:01:54 -0500 Subject: [PATCH] Consolidate documentation under docs/ directory (#6310) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Consolidate documentation under doc/ directory Move user-facing guides from release_docs/ and doxygen/ into a single doc/ root. release_docs/ now holds only release artifacts (changelogs, history, release process, maintainer info). - git mv release_docs/INSTALL*.md, USING_*.md, README_HPC.md, BuildSystemNotes.md, AutotoolsToCMakeOptions.md, HDF5_Library_2.0.0_Migration_Guide.md → doc/ - git mv doxygen/ → doc/doxygen/ - Update CMakeLists.txt: HDF5_DOXYGEN_DIR and add_subdirectory path - Update CMakeInstallation.cmake: all install paths for moved files - Update bin/make_vers: hardcoded doxygen/ path substitution - Update doc/doxygen/CMakeLists.txt: EXAMPLES_DIRECTORY and comments - Update README.md, CONTRIBUTING.md, SECURITY.md, config/README.md, release_docs/RELEASE_PROCESS.md: links to moved files - Update doxygen .dox files: release_docs/ URLs for moved guides - Rewrite release_docs/README.md for narrowed scope * Add HDF5_DOCS_DIR variable for doc/ root path Introduce HDF5_DOCS_DIR = \${HDF5_SOURCE_DIR}/doc so that CMakeInstallation.cmake and future callers reference the doc/ directory symbolically rather than by hardcoded path. HDF5_DOXYGEN_DIR is now derived from HDF5_DOCS_DIR. --- .github/workflows/call-workflows.yml | 4 +- .github/workflows/cve.yml | 4 +- .github/workflows/freebsd.yml | 4 +- .github/workflows/hdfeos5.yml | 4 +- .github/workflows/netcdf.yml | 4 +- .github/workflows/openbsd.yml | 4 +- CMakeInstallation.cmake | 18 +-- CMakeLists.txt | 5 +- CONTRIBUTING.md | 6 +- README.md | 26 ++-- SECURITY.md | 2 +- bin/make_vers | 4 +- config/README.md | 14 +- .../AutotoolsToCMakeOptions.md | 2 +- {release_docs => docs}/BuildSystemNotes.md | 0 .../HDF5_Library_2.0.0_Migration_Guide.md | 0 {release_docs => docs}/INSTALL.md | 4 +- {release_docs => docs}/INSTALL_CMake.md | 0 {release_docs => docs}/INSTALL_Cygwin.md | 0 {release_docs => docs}/INSTALL_Filters.md | 0 {release_docs => docs}/INSTALL_S3.md | 4 +- {release_docs => docs}/INSTALL_Windows.md | 0 {release_docs => docs}/README_HPC.md | 0 .../USING_CMake_Examples.md | 0 {release_docs => docs}/USING_HDF5_CMake.md | 0 {release_docs => docs}/USING_HDF5_VS.md | 0 {doxygen => docs/doxygen}/CMakeLists.txt | 6 +- {doxygen => docs/doxygen}/Doxyfile.in | 0 .../doxygen}/H5version_doxygen.cmake | 0 {doxygen => docs/doxygen}/aliases | 0 {doxygen => docs/doxygen}/dox/APIVersions.dox | 0 {doxygen => docs/doxygen}/dox/About.dox | 0 {doxygen => docs/doxygen}/dox/AppDbgging.dox | 0 .../doxygen}/dox/CollectiveCalls.dox | 0 .../doxygen}/dox/CollectiveMetadataIO.dox | 0 {doxygen => docs/doxygen}/dox/Cookbook.dox | 0 .../doxygen}/dox/CopyingCommited.dox | 0 {doxygen => docs/doxygen}/dox/CppAPIIntro.dox | 2 +- {doxygen => docs/doxygen}/dox/DDLBNF110.dox | 0 {doxygen => docs/doxygen}/dox/DDLBNF112.dox | 0 {doxygen => docs/doxygen}/dox/DDLBNF114.dox | 0 {doxygen => docs/doxygen}/dox/DDLBNF200.dox | 0 .../doxygen}/dox/DSChunkingIssues.dox | 0 {doxygen => docs/doxygen}/dox/ExamplesAPI.dox | 0 {doxygen => docs/doxygen}/dox/FTS.dox | 0 .../doxygen}/dox/FileFormatDisc.dox | 0 .../doxygen}/dox/FileFormatSpec.dox | 0 ...FreeingMemoryAllocatedByTheHdf5Library.dox | 0 .../doxygen}/dox/GettingStarted.dox | 0 {doxygen => docs/doxygen}/dox/Glossary.dox | 0 .../doxygen}/dox/H5.format.1.0.dox | 0 .../doxygen}/dox/H5.format.1.1.dox | 0 .../doxygen}/dox/H5.format.2.0.dox | 0 .../doxygen}/dox/H5.format.3.0.dox | 0 .../doxygen}/dox/H5.format.4.0.dox | 0 .../doxygen}/dox/H5AC_cache_config_t.dox | 0 .../dox/HDF5CompressionTroubleshooting.dox | 4 +- ...provingIOPerformanceCompressedDatasets.dox | 0 {doxygen => docs/doxygen}/dox/IOFlow.dox | 0 {doxygen => docs/doxygen}/dox/ImageSpec.dox | 0 {doxygen => docs/doxygen}/dox/IntroHDF5.dox | 0 .../doxygen}/dox/IntroParExamples.dox | 0 .../doxygen}/dox/IntroParHDF5.dox | 0 {doxygen => docs/doxygen}/dox/LearnBasics.dox | 0 .../doxygen}/dox/LearnBasics1.dox | 0 .../doxygen}/dox/LearnBasics2.dox | 0 .../doxygen}/dox/LearnBasics3.dox | 8 +- .../doxygen}/dox/LearnHDFView.dox | 0 .../doxygen}/dox/MetadataCachingInHDF5.dox | 0 .../doxygen}/dox/ModifiedRegionWrites.dox | 0 {doxygen => docs/doxygen}/dox/Overview.dox | 0 .../doxygen}/dox/PredefinedDatatypeTables.dox | 0 {doxygen => docs/doxygen}/dox/RFC.dox | 0 .../doxygen}/dox/ReferenceManual.dox | 0 {doxygen => docs/doxygen}/dox/RelVersion.dox | 0 .../doxygen}/dox/SWMRTechNote.dox | 0 .../doxygen}/dox/Specifications.dox | 0 {doxygen => docs/doxygen}/dox/TableSpec.dox | 0 .../doxygen}/dox/TechnicalNotes.dox | 0 {doxygen => docs/doxygen}/dox/ThreadSafe.dox | 0 {doxygen => docs/doxygen}/dox/Tools.dox | 0 .../doxygen}/dox/TrainingVideos.dox | 0 {doxygen => docs/doxygen}/dox/Unicode.dox | 0 {doxygen => docs/doxygen}/dox/UsersGuide.dox | 0 .../doxygen}/dox/UsingIdentifiers.dox | 0 {doxygen => docs/doxygen}/dox/VDSTechNote.dox | 0 {doxygen => docs/doxygen}/dox/VFLTechNote.dox | 0 .../doxygen}/dox/VOLConnGuide.dox | 0 {doxygen => docs/doxygen}/dox/ViewTools.dox | 0 {doxygen => docs/doxygen}/dox/ViewTools2.dox | 0 .../doxygen}/dox/ViewToolsJPSS.dox | 0 .../doxygen}/dox/api-compat-macros.dox | 0 .../doxygen}/dox/branches-explained.dox | 0 .../doxygen}/dox/chunking_in_hdf5.dox | 0 .../doxygen}/dox/cmake-vols-fetchcontent.dox | 0 .../doxygen}/dox/code-conventions.dox | 0 .../doxygen}/dox/cookbook/Accessibility.c | 0 .../doxygen}/dox/cookbook/Accessibility.dox | 0 .../doxygen}/dox/cookbook/Attributes.c | 0 .../doxygen}/dox/cookbook/Attributes.dox | 0 .../doxygen}/dox/cookbook/Files.c | 0 .../doxygen}/dox/cookbook/Files.dox | 0 .../doxygen}/dox/cookbook/MavenArtifacts.dox | 0 .../doxygen}/dox/cookbook/Performance.dox | 0 .../doxygen}/dox/cookbook/Presets.dox | 2 +- .../doxygen}/dox/file-locking.dox | 0 {doxygen => docs/doxygen}/dox/hdf5_1_10.dox | 0 {doxygen => docs/doxygen}/dox/hdf5_1_12.dox | 0 {doxygen => docs/doxygen}/dox/hdf5_1_14.dox | 2 +- {doxygen => docs/doxygen}/dox/hdf5_1_8.dox | 0 {doxygen => docs/doxygen}/dox/hdf5_2x.dox | 0 .../doxygen}/dox/high_level/extension.dox | 0 .../doxygen}/dox/library-init-shutdown.dox | 0 .../doxygen}/dox/maybe_metadata_reads.dox | 0 .../doxygen}/dox/parallel-compression.dox | 0 .../doxygen}/dox/release_specific_info.dox | 0 {doxygen => docs/doxygen}/dox/rm-template.dox | 0 .../doxygen}/dox/sw_changes_1.10.dox | 0 .../doxygen}/dox/sw_changes_1.12.dox | 0 .../doxygen}/dox/sw_changes_1.14.dox | 0 .../doxygen}/dox/sw_changes_2.x.dox | 0 .../doxygen}/dox/threadsafety-warning.dox | 0 .../doxygen}/doxygen-awesome-tabs.js | 0 {doxygen => docs/doxygen}/doxygen-awesome.css | 0 .../doxygen}/examples/FF-IH_FileGroup.gif | Bin .../doxygen}/examples/FF-IH_FileObject.gif | Bin .../examples/FileFormatSpecChunkDiagram.jpg | Bin .../doxygen}/examples/H5A_examples.c | 0 .../doxygen}/examples/H5DO_examples.c | 0 .../doxygen}/examples/H5D_examples.c | 0 .../doxygen}/examples/H5E_examples.c | 0 .../doxygen}/examples/H5F_examples.c | 0 {doxygen => docs/doxygen}/examples/H5Fclose.c | 0 .../doxygen}/examples/H5Fcreate.c | 0 .../doxygen}/examples/H5G_examples.c | 0 .../doxygen}/examples/H5I_examples.c | 0 .../doxygen}/examples/H5LDget_dset_elmts.c | 0 .../doxygen}/examples/H5LT_examples.c | 0 .../doxygen}/examples/H5L_examples.c | 0 .../doxygen}/examples/H5O_examples.c | 0 .../doxygen}/examples/H5PL_examples.c | 0 .../doxygen}/examples/H5P_examples.c | 0 .../H5Pget_metadata_read_attempts.1.c | 0 .../H5Pget_metadata_read_attempts.2.c | 0 .../H5Pget_metadata_read_attempts.3.c | 0 .../examples/H5Pget_object_flush_cb.c | 0 .../examples/H5Pset_metadata_read_attempts.c | 0 .../examples/H5Pset_object_flush_cb.c | 0 .../doxygen}/examples/H5R_examples.c | 0 .../doxygen}/examples/H5S_examples.c | 0 .../doxygen}/examples/H5TBAget_fill.c | 0 .../doxygen}/examples/H5T_examples.c | 0 .../doxygen}/examples/H5Z_examples.c | 0 .../doxygen}/examples/H5_examples.c | 0 .../doxygen}/examples/PaletteExample1.gif | Bin .../doxygen}/examples/Palettes.fm.anc.gif | Bin .../doxygen}/examples/h5_attribute.c | 0 .../doxygen}/examples/h5_extlink.c | 0 .../doxygen}/examples/hello_hdf5.c | 0 .../doxygen}/examples/menus/core_menu.md | 0 .../doxygen}/examples/menus/fortran_menu.md | 0 .../examples/menus/high_level_menu.md | 0 .../doxygen}/examples/menus/java_menu.md | 0 .../examples/tables/fileDriverLists.dox | 0 .../examples/tables/predefinedDatatypes.dox | 0 .../examples/tables/propertyLists.dox | 0 .../doxygen}/examples/tables/volAPIs.dox | 0 {doxygen => docs/doxygen}/hdf5_footer.html | 0 {doxygen => docs/doxygen}/hdf5_header.html | 0 .../doxygen}/hdf5_navtree_hacks.js | 0 {doxygen => docs/doxygen}/hdf5doxy.css | 0 {doxygen => docs/doxygen}/hdf5doxy_layout.xml | 0 {doxygen => docs/doxygen}/img/Chunk_f1.gif | Bin {doxygen => docs/doxygen}/img/Chunk_f2.gif | Bin {doxygen => docs/doxygen}/img/Chunk_f3.gif | Bin {doxygen => docs/doxygen}/img/Chunk_f4.gif | Bin {doxygen => docs/doxygen}/img/Chunk_f5.gif | Bin {doxygen => docs/doxygen}/img/Chunk_f6.gif | Bin .../doxygen}/img/DOChunks_fig1.png | Bin .../doxygen}/img/DOChunks_fig2.png | Bin {doxygen => docs/doxygen}/img/DataGroup.png | Bin {doxygen => docs/doxygen}/img/Dmodel_fig1.gif | Bin .../doxygen}/img/Dmodel_fig10.gif | Bin .../doxygen}/img/Dmodel_fig11_b.gif | Bin .../doxygen}/img/Dmodel_fig12_a.gif | Bin .../doxygen}/img/Dmodel_fig12_b.gif | Bin .../doxygen}/img/Dmodel_fig14_a.gif | Bin .../doxygen}/img/Dmodel_fig14_b.gif | Bin .../doxygen}/img/Dmodel_fig14_c.gif | Bin .../doxygen}/img/Dmodel_fig14_d.gif | Bin {doxygen => docs/doxygen}/img/Dmodel_fig2.gif | Bin .../doxygen}/img/Dmodel_fig3_a.gif | Bin .../doxygen}/img/Dmodel_fig3_c.gif | Bin .../doxygen}/img/Dmodel_fig4_a.gif | Bin .../doxygen}/img/Dmodel_fig4_b.gif | Bin {doxygen => docs/doxygen}/img/Dmodel_fig5.gif | Bin {doxygen => docs/doxygen}/img/Dmodel_fig6.gif | Bin .../doxygen}/img/Dmodel_fig7_b.gif | Bin {doxygen => docs/doxygen}/img/Dmodel_fig8.gif | Bin {doxygen => docs/doxygen}/img/Dmodel_fig9.gif | Bin .../doxygen}/img/Dsets_NbitFloating1.gif | Bin .../doxygen}/img/Dsets_NbitFloating2.gif | Bin .../doxygen}/img/Dsets_NbitInteger1.gif | Bin .../doxygen}/img/Dsets_NbitInteger2.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig1.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig10.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig11.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig12.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig2.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig3.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig4.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig5.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig6.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig7.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig8.gif | Bin {doxygen => docs/doxygen}/img/Dsets_fig9.gif | Bin .../doxygen}/img/Dspace_CvsF1.gif | Bin .../doxygen}/img/Dspace_CvsF2.gif | Bin .../doxygen}/img/Dspace_CvsF3.gif | Bin .../doxygen}/img/Dspace_CvsF4.gif | Bin .../doxygen}/img/Dspace_combine.gif | Bin .../doxygen}/img/Dspace_complex.gif | Bin .../doxygen}/img/Dspace_features.gif | Bin .../doxygen}/img/Dspace_features_cmpd.gif | Bin {doxygen => docs/doxygen}/img/Dspace_move.gif | Bin .../doxygen}/img/Dspace_point.gif | Bin {doxygen => docs/doxygen}/img/Dspace_read.gif | Bin .../doxygen}/img/Dspace_select.gif | Bin .../doxygen}/img/Dspace_separate.gif | Bin .../doxygen}/img/Dspace_simple.gif | Bin .../doxygen}/img/Dspace_subset.gif | Bin .../doxygen}/img/Dspace_three_datasets.gif | Bin .../doxygen}/img/Dspace_transfer.gif | Bin .../doxygen}/img/Dspace_write1to2.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig1.gif | Bin .../doxygen}/img/Dtypes_fig10.gif | Bin .../doxygen}/img/Dtypes_fig11.gif | Bin .../doxygen}/img/Dtypes_fig12.gif | Bin .../doxygen}/img/Dtypes_fig13a.gif | Bin .../doxygen}/img/Dtypes_fig13b.gif | Bin .../doxygen}/img/Dtypes_fig13c.gif | Bin .../doxygen}/img/Dtypes_fig13d.gif | Bin .../doxygen}/img/Dtypes_fig14.gif | Bin .../doxygen}/img/Dtypes_fig15.gif | Bin .../doxygen}/img/Dtypes_fig16.gif | Bin .../doxygen}/img/Dtypes_fig16a.gif | Bin .../doxygen}/img/Dtypes_fig16b.gif | Bin .../doxygen}/img/Dtypes_fig16c.gif | Bin .../doxygen}/img/Dtypes_fig16d.gif | Bin .../doxygen}/img/Dtypes_fig17a.gif | Bin .../doxygen}/img/Dtypes_fig17b.gif | Bin .../doxygen}/img/Dtypes_fig18.gif | Bin .../doxygen}/img/Dtypes_fig19.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig2.gif | Bin .../doxygen}/img/Dtypes_fig20a.gif | Bin .../doxygen}/img/Dtypes_fig20b.gif | Bin .../doxygen}/img/Dtypes_fig20c.gif | Bin .../doxygen}/img/Dtypes_fig20d.gif | Bin .../doxygen}/img/Dtypes_fig21.gif | Bin .../doxygen}/img/Dtypes_fig22.gif | Bin .../doxygen}/img/Dtypes_fig23.gif | Bin .../doxygen}/img/Dtypes_fig24.gif | Bin .../doxygen}/img/Dtypes_fig25a.gif | Bin .../doxygen}/img/Dtypes_fig25c.gif | Bin .../doxygen}/img/Dtypes_fig26.gif | Bin .../doxygen}/img/Dtypes_fig27.gif | Bin .../doxygen}/img/Dtypes_fig28.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig3.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig4.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig5.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig6.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig7.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig8.gif | Bin {doxygen => docs/doxygen}/img/Dtypes_fig9.gif | Bin .../doxygen}/img/FF-IH_FileGroup.gif | Bin .../doxygen}/img/FF-IH_FileObject.gif | Bin .../img/FileFormatSpecChunkDiagram.jpg | Bin {doxygen => docs/doxygen}/img/Files_fig3.gif | Bin {doxygen => docs/doxygen}/img/Files_fig4.gif | Bin .../doxygen}/img/FortBuildFlow.svg | 0 .../doxygen}/img/FreeingMemory_fig1.png | Bin {doxygen => docs/doxygen}/img/Groups_fig1.gif | Bin .../doxygen}/img/Groups_fig10_a.gif | Bin .../doxygen}/img/Groups_fig10_b.gif | Bin .../doxygen}/img/Groups_fig10_c.gif | Bin .../doxygen}/img/Groups_fig10_d.gif | Bin .../doxygen}/img/Groups_fig11_a.gif | Bin .../doxygen}/img/Groups_fig11_b.gif | Bin .../doxygen}/img/Groups_fig11_c.gif | Bin .../doxygen}/img/Groups_fig11_d.gif | Bin {doxygen => docs/doxygen}/img/Groups_fig2.gif | Bin {doxygen => docs/doxygen}/img/Groups_fig3.gif | Bin {doxygen => docs/doxygen}/img/Groups_fig4.gif | Bin {doxygen => docs/doxygen}/img/Groups_fig5.gif | Bin {doxygen => docs/doxygen}/img/Groups_fig6.gif | Bin .../doxygen}/img/Groups_fig9_a.gif | Bin .../doxygen}/img/Groups_fig9_aa.gif | Bin .../doxygen}/img/Groups_fig9_b.gif | Bin .../doxygen}/img/Groups_fig9_bb.gif | Bin {doxygen => docs/doxygen}/img/H5DS_fig1.png | Bin {doxygen => docs/doxygen}/img/H5DS_fig2.png | Bin {doxygen => docs/doxygen}/img/H5DS_fig3.png | Bin {doxygen => docs/doxygen}/img/H5DS_fig4.png | Bin {doxygen => docs/doxygen}/img/H5DS_fig5.png | Bin {doxygen => docs/doxygen}/img/HDF5.png | Bin {doxygen => docs/doxygen}/img/HDFG-logo.png | Bin {doxygen => docs/doxygen}/img/IOFlow.gif | Bin {doxygen => docs/doxygen}/img/IOFlow2.gif | Bin {doxygen => docs/doxygen}/img/IOFlow3.gif | Bin .../doxygen}/img/LBDsetSubRWProg.png | Bin .../doxygen}/img/PaletteExample1.gif | Bin .../doxygen}/img/Palettes_fm_anc.gif | Bin {doxygen => docs/doxygen}/img/Pmodel_fig2.gif | Bin {doxygen => docs/doxygen}/img/Pmodel_fig3.gif | Bin .../doxygen}/img/Pmodel_fig5_a.gif | Bin .../doxygen}/img/Pmodel_fig5_b.gif | Bin .../doxygen}/img/Pmodel_fig5_c.gif | Bin .../doxygen}/img/Pmodel_fig5_d.gif | Bin .../doxygen}/img/Pmodel_fig5_e.gif | Bin {doxygen => docs/doxygen}/img/Pmodel_fig6.gif | Bin .../doxygen}/img/PropListClassInheritance.gif | Bin .../doxygen}/img/PropListEcosystem.gif | Bin .../doxygen}/img/Shared_Attribute.jpg | Bin .../doxygen}/img/StormDataset.png | Bin .../doxygen}/img/UML_Attribute.jpg | Bin .../doxygen}/img/UML_FileAndProps.gif | Bin {doxygen => docs/doxygen}/img/VFL_Drivers.gif | Bin {doxygen => docs/doxygen}/img/cgns.png | Bin .../doxygen}/img/chunking1and2.png | Bin .../doxygen}/img/chunking3and4.png | Bin {doxygen => docs/doxygen}/img/chunking5.png | Bin {doxygen => docs/doxygen}/img/chunking6.png | Bin {doxygen => docs/doxygen}/img/chunking7.png | Bin {doxygen => docs/doxygen}/img/chunking8.png | Bin {doxygen => docs/doxygen}/img/cmpnddtype.png | Bin {doxygen => docs/doxygen}/img/crtatt.png | Bin {doxygen => docs/doxygen}/img/crtdset.png | Bin {doxygen => docs/doxygen}/img/crtf-pic.png | Bin {doxygen => docs/doxygen}/img/crtgrp.png | Bin {doxygen => docs/doxygen}/img/dataset.png | Bin .../doxygen}/img/datasetwdata.png | Bin {doxygen => docs/doxygen}/img/dataspace.png | Bin {doxygen => docs/doxygen}/img/dataspace1.png | Bin {doxygen => docs/doxygen}/img/datatype.png | Bin .../doxygen}/img/dtypes_fig25b.gif | Bin {doxygen => docs/doxygen}/img/fileobj.png | Bin {doxygen => docs/doxygen}/img/ftv2node.png | Bin {doxygen => docs/doxygen}/img/ftv2pnode.png | Bin {doxygen => docs/doxygen}/img/group.png | Bin .../doxygen}/img/hdfview-anthrstrm-img.png | Bin .../img/hdfview-anthrstrm-sprdsht.png | Bin .../doxygen}/img/hdfview-anthrstrm.png | Bin .../doxygen}/img/hdfview-imgicon.png | Bin .../doxygen}/img/hdfview-imgprop.png | Bin .../doxygen}/img/hdfview-imgsubset.png | Bin .../doxygen}/img/hdfview-newcmpd.png | Bin .../doxygen}/img/hdfview-newimgsubset.png | Bin .../doxygen}/img/hdfview-prop.png | Bin {doxygen => docs/doxygen}/img/hdfview-qf.png | Bin .../doxygen}/img/hdfview-regref.png | Bin .../doxygen}/img/hdfview-regref1.png | Bin .../doxygen}/img/hdfview-regref2.png | Bin .../doxygen}/img/hdfview-regrefval.png | Bin .../doxygen}/img/hdfview-table.png | Bin .../doxygen}/img/hdfview-tree.png | Bin .../doxygen}/img/images_to_copy.dox | 0 .../doxygen}/img/imgLBDsetCreate.gif | Bin .../doxygen}/img/imgLBDsetSubRW11.png | Bin .../doxygen}/img/imgLBDsetSubRW12.png | Bin .../doxygen}/img/imgLBDsetSubRW31.png | Bin .../doxygen}/img/imgLBDsetSubRW32.png | Bin .../doxygen}/img/imgLBDsetSubRW33.png | Bin {doxygen => docs/doxygen}/img/imgLBFile.gif | Bin .../doxygen}/img/imggrpcreate.gif | Bin {doxygen => docs/doxygen}/img/imggrpdsets.gif | Bin {doxygen => docs/doxygen}/img/imggrps.gif | Bin .../img/improve_perf-compress_fig_1.png | Bin .../img/improve_perf-compress_fig_2.png | Bin .../img/improve_perf-compress_fig_3.png | Bin .../img/improve_perf-compress_fig_6.png | Bin .../img/improve_perf-compress_fig_7.png | Bin .../img/improve_perf-compress_fig_8.png | Bin .../img/improve_perf-compress_fig_9.png | Bin {doxygen => docs/doxygen}/img/modregwrite.png | Bin .../doxygen}/img/newgroupimage.png | Bin {doxygen => docs/doxygen}/img/noattrs.png | Bin {doxygen => docs/doxygen}/img/pchunk_figa.gif | Bin {doxygen => docs/doxygen}/img/pchunk_figb.gif | Bin {doxygen => docs/doxygen}/img/pchunk_figc.gif | Bin {doxygen => docs/doxygen}/img/pchunk_figd.gif | Bin .../doxygen}/img/pcont_hy_figa.gif | Bin .../doxygen}/img/pcont_hy_figb.gif | Bin .../doxygen}/img/pcont_hy_figc.gif | Bin .../doxygen}/img/pcont_hy_figd.gif | Bin {doxygen => docs/doxygen}/img/pimplayer.gif | Bin {doxygen => docs/doxygen}/img/ppatt_figa.gif | Bin {doxygen => docs/doxygen}/img/ppatt_figb.gif | Bin {doxygen => docs/doxygen}/img/ppatt_figc.gif | Bin {doxygen => docs/doxygen}/img/ppatt_figd.gif | Bin {doxygen => docs/doxygen}/img/preg_figa.gif | Bin {doxygen => docs/doxygen}/img/preg_figb.gif | Bin {doxygen => docs/doxygen}/img/preg_figc.gif | Bin {doxygen => docs/doxygen}/img/preg_figd.gif | Bin {doxygen => docs/doxygen}/img/properties.png | Bin .../doxygen}/img/scarletletter.png | Bin {doxygen => docs/doxygen}/img/showasimage.png | Bin {doxygen => docs/doxygen}/img/storm.png | Bin .../doxygen}/img/trunk_branches.jpg | Bin {doxygen => docs/doxygen}/img/tutr-lochk.png | Bin {doxygen => docs/doxygen}/img/tutr-lochks.png | Bin {doxygen => docs/doxygen}/img/tutr-locons.png | Bin {doxygen => docs/doxygen}/img/tutr-lodset.png | Bin {doxygen => docs/doxygen}/img/tutr-swmr1.png | Bin {doxygen => docs/doxygen}/img/tutr-swmr2.png | Bin {doxygen => docs/doxygen}/img/tutr-swmr3.png | Bin {doxygen => docs/doxygen}/img/tutrvds-ex.png | Bin {doxygen => docs/doxygen}/img/tutrvds-map.png | Bin .../doxygen}/img/tutrvds-multimgs.png | Bin .../doxygen}/img/tutrvds-snglimg.png | Bin .../doxygen}/img/vol_architecture.png | Bin .../doxygen}/img/writeLgNumDsets.png | Bin release_docs/CHANGELOG.md | 7 + release_docs/README.md | 128 ++++-------------- release_docs/RELEASE_PROCESS.md | 6 +- 424 files changed, 107 insertions(+), 167 deletions(-) rename {release_docs => docs}/AutotoolsToCMakeOptions.md (98%) rename {release_docs => docs}/BuildSystemNotes.md (100%) rename {release_docs => docs}/HDF5_Library_2.0.0_Migration_Guide.md (100%) rename {release_docs => docs}/INSTALL.md (96%) rename {release_docs => docs}/INSTALL_CMake.md (100%) rename {release_docs => docs}/INSTALL_Cygwin.md (100%) rename {release_docs => docs}/INSTALL_Filters.md (100%) rename {release_docs => docs}/INSTALL_S3.md (97%) rename {release_docs => docs}/INSTALL_Windows.md (100%) rename {release_docs => docs}/README_HPC.md (100%) rename {release_docs => docs}/USING_CMake_Examples.md (100%) rename {release_docs => docs}/USING_HDF5_CMake.md (100%) rename {release_docs => docs}/USING_HDF5_VS.md (100%) rename {doxygen => docs/doxygen}/CMakeLists.txt (94%) rename {doxygen => docs/doxygen}/Doxyfile.in (100%) rename {doxygen => docs/doxygen}/H5version_doxygen.cmake (100%) rename {doxygen => docs/doxygen}/aliases (100%) rename {doxygen => docs/doxygen}/dox/APIVersions.dox (100%) rename {doxygen => docs/doxygen}/dox/About.dox (100%) rename {doxygen => docs/doxygen}/dox/AppDbgging.dox (100%) rename {doxygen => docs/doxygen}/dox/CollectiveCalls.dox (100%) rename {doxygen => docs/doxygen}/dox/CollectiveMetadataIO.dox (100%) rename {doxygen => docs/doxygen}/dox/Cookbook.dox (100%) rename {doxygen => docs/doxygen}/dox/CopyingCommited.dox (100%) rename {doxygen => docs/doxygen}/dox/CppAPIIntro.dox (89%) rename {doxygen => docs/doxygen}/dox/DDLBNF110.dox (100%) rename {doxygen => docs/doxygen}/dox/DDLBNF112.dox (100%) rename {doxygen => docs/doxygen}/dox/DDLBNF114.dox (100%) rename {doxygen => docs/doxygen}/dox/DDLBNF200.dox (100%) rename {doxygen => docs/doxygen}/dox/DSChunkingIssues.dox (100%) rename {doxygen => docs/doxygen}/dox/ExamplesAPI.dox (100%) rename {doxygen => docs/doxygen}/dox/FTS.dox (100%) rename {doxygen => docs/doxygen}/dox/FileFormatDisc.dox (100%) rename {doxygen => docs/doxygen}/dox/FileFormatSpec.dox (100%) rename {doxygen => docs/doxygen}/dox/FreeingMemoryAllocatedByTheHdf5Library.dox (100%) rename {doxygen => docs/doxygen}/dox/GettingStarted.dox (100%) rename {doxygen => docs/doxygen}/dox/Glossary.dox (100%) rename {doxygen => docs/doxygen}/dox/H5.format.1.0.dox (100%) rename {doxygen => docs/doxygen}/dox/H5.format.1.1.dox (100%) rename {doxygen => docs/doxygen}/dox/H5.format.2.0.dox (100%) rename {doxygen => docs/doxygen}/dox/H5.format.3.0.dox (100%) rename {doxygen => docs/doxygen}/dox/H5.format.4.0.dox (100%) rename {doxygen => docs/doxygen}/dox/H5AC_cache_config_t.dox (100%) rename {doxygen => docs/doxygen}/dox/HDF5CompressionTroubleshooting.dox (99%) rename {doxygen => docs/doxygen}/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox (100%) rename {doxygen => docs/doxygen}/dox/IOFlow.dox (100%) rename {doxygen => docs/doxygen}/dox/ImageSpec.dox (100%) rename {doxygen => docs/doxygen}/dox/IntroHDF5.dox (100%) rename {doxygen => docs/doxygen}/dox/IntroParExamples.dox (100%) rename {doxygen => docs/doxygen}/dox/IntroParHDF5.dox (100%) rename {doxygen => docs/doxygen}/dox/LearnBasics.dox (100%) rename {doxygen => docs/doxygen}/dox/LearnBasics1.dox (100%) rename {doxygen => docs/doxygen}/dox/LearnBasics2.dox (100%) rename {doxygen => docs/doxygen}/dox/LearnBasics3.dox (98%) rename {doxygen => docs/doxygen}/dox/LearnHDFView.dox (100%) rename {doxygen => docs/doxygen}/dox/MetadataCachingInHDF5.dox (100%) rename {doxygen => docs/doxygen}/dox/ModifiedRegionWrites.dox (100%) rename {doxygen => docs/doxygen}/dox/Overview.dox (100%) rename {doxygen => docs/doxygen}/dox/PredefinedDatatypeTables.dox (100%) rename {doxygen => docs/doxygen}/dox/RFC.dox (100%) rename {doxygen => docs/doxygen}/dox/ReferenceManual.dox (100%) rename {doxygen => docs/doxygen}/dox/RelVersion.dox (100%) rename {doxygen => docs/doxygen}/dox/SWMRTechNote.dox (100%) rename {doxygen => docs/doxygen}/dox/Specifications.dox (100%) rename {doxygen => docs/doxygen}/dox/TableSpec.dox (100%) rename {doxygen => docs/doxygen}/dox/TechnicalNotes.dox (100%) rename {doxygen => docs/doxygen}/dox/ThreadSafe.dox (100%) rename {doxygen => docs/doxygen}/dox/Tools.dox (100%) rename {doxygen => docs/doxygen}/dox/TrainingVideos.dox (100%) rename {doxygen => docs/doxygen}/dox/Unicode.dox (100%) rename {doxygen => docs/doxygen}/dox/UsersGuide.dox (100%) rename {doxygen => docs/doxygen}/dox/UsingIdentifiers.dox (100%) rename {doxygen => docs/doxygen}/dox/VDSTechNote.dox (100%) rename {doxygen => docs/doxygen}/dox/VFLTechNote.dox (100%) rename {doxygen => docs/doxygen}/dox/VOLConnGuide.dox (100%) rename {doxygen => docs/doxygen}/dox/ViewTools.dox (100%) rename {doxygen => docs/doxygen}/dox/ViewTools2.dox (100%) rename {doxygen => docs/doxygen}/dox/ViewToolsJPSS.dox (100%) rename {doxygen => docs/doxygen}/dox/api-compat-macros.dox (100%) rename {doxygen => docs/doxygen}/dox/branches-explained.dox (100%) rename {doxygen => docs/doxygen}/dox/chunking_in_hdf5.dox (100%) rename {doxygen => docs/doxygen}/dox/cmake-vols-fetchcontent.dox (100%) rename {doxygen => docs/doxygen}/dox/code-conventions.dox (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Accessibility.c (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Accessibility.dox (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Attributes.c (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Attributes.dox (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Files.c (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Files.dox (100%) rename {doxygen => docs/doxygen}/dox/cookbook/MavenArtifacts.dox (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Performance.dox (100%) rename {doxygen => docs/doxygen}/dox/cookbook/Presets.dox (99%) rename {doxygen => docs/doxygen}/dox/file-locking.dox (100%) rename {doxygen => docs/doxygen}/dox/hdf5_1_10.dox (100%) rename {doxygen => docs/doxygen}/dox/hdf5_1_12.dox (100%) rename {doxygen => docs/doxygen}/dox/hdf5_1_14.dox (98%) rename {doxygen => docs/doxygen}/dox/hdf5_1_8.dox (100%) rename {doxygen => docs/doxygen}/dox/hdf5_2x.dox (100%) rename {doxygen => docs/doxygen}/dox/high_level/extension.dox (100%) rename {doxygen => docs/doxygen}/dox/library-init-shutdown.dox (100%) rename {doxygen => docs/doxygen}/dox/maybe_metadata_reads.dox (100%) rename {doxygen => docs/doxygen}/dox/parallel-compression.dox (100%) rename {doxygen => docs/doxygen}/dox/release_specific_info.dox (100%) rename {doxygen => docs/doxygen}/dox/rm-template.dox (100%) rename {doxygen => docs/doxygen}/dox/sw_changes_1.10.dox (100%) rename {doxygen => docs/doxygen}/dox/sw_changes_1.12.dox (100%) rename {doxygen => docs/doxygen}/dox/sw_changes_1.14.dox (100%) rename {doxygen => docs/doxygen}/dox/sw_changes_2.x.dox (100%) rename {doxygen => docs/doxygen}/dox/threadsafety-warning.dox (100%) rename {doxygen => docs/doxygen}/doxygen-awesome-tabs.js (100%) rename {doxygen => docs/doxygen}/doxygen-awesome.css (100%) rename {doxygen => docs/doxygen}/examples/FF-IH_FileGroup.gif (100%) rename {doxygen => docs/doxygen}/examples/FF-IH_FileObject.gif (100%) rename {doxygen => docs/doxygen}/examples/FileFormatSpecChunkDiagram.jpg (100%) rename {doxygen => docs/doxygen}/examples/H5A_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5DO_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5D_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5E_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5F_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5Fclose.c (100%) rename {doxygen => docs/doxygen}/examples/H5Fcreate.c (100%) rename {doxygen => docs/doxygen}/examples/H5G_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5I_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5LDget_dset_elmts.c (100%) rename {doxygen => docs/doxygen}/examples/H5LT_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5L_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5O_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5PL_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5P_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5Pget_metadata_read_attempts.1.c (100%) rename {doxygen => docs/doxygen}/examples/H5Pget_metadata_read_attempts.2.c (100%) rename {doxygen => docs/doxygen}/examples/H5Pget_metadata_read_attempts.3.c (100%) rename {doxygen => docs/doxygen}/examples/H5Pget_object_flush_cb.c (100%) rename {doxygen => docs/doxygen}/examples/H5Pset_metadata_read_attempts.c (100%) rename {doxygen => docs/doxygen}/examples/H5Pset_object_flush_cb.c (100%) rename {doxygen => docs/doxygen}/examples/H5R_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5S_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5TBAget_fill.c (100%) rename {doxygen => docs/doxygen}/examples/H5T_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5Z_examples.c (100%) rename {doxygen => docs/doxygen}/examples/H5_examples.c (100%) rename {doxygen => docs/doxygen}/examples/PaletteExample1.gif (100%) rename {doxygen => docs/doxygen}/examples/Palettes.fm.anc.gif (100%) rename {doxygen => docs/doxygen}/examples/h5_attribute.c (100%) rename {doxygen => docs/doxygen}/examples/h5_extlink.c (100%) rename {doxygen => docs/doxygen}/examples/hello_hdf5.c (100%) rename {doxygen => docs/doxygen}/examples/menus/core_menu.md (100%) rename {doxygen => docs/doxygen}/examples/menus/fortran_menu.md (100%) rename {doxygen => docs/doxygen}/examples/menus/high_level_menu.md (100%) rename {doxygen => docs/doxygen}/examples/menus/java_menu.md (100%) rename {doxygen => docs/doxygen}/examples/tables/fileDriverLists.dox (100%) rename {doxygen => docs/doxygen}/examples/tables/predefinedDatatypes.dox (100%) rename {doxygen => docs/doxygen}/examples/tables/propertyLists.dox (100%) rename {doxygen => docs/doxygen}/examples/tables/volAPIs.dox (100%) rename {doxygen => docs/doxygen}/hdf5_footer.html (100%) rename {doxygen => docs/doxygen}/hdf5_header.html (100%) rename {doxygen => docs/doxygen}/hdf5_navtree_hacks.js (100%) rename {doxygen => docs/doxygen}/hdf5doxy.css (100%) rename {doxygen => docs/doxygen}/hdf5doxy_layout.xml (100%) rename {doxygen => docs/doxygen}/img/Chunk_f1.gif (100%) rename {doxygen => docs/doxygen}/img/Chunk_f2.gif (100%) rename {doxygen => docs/doxygen}/img/Chunk_f3.gif (100%) rename {doxygen => docs/doxygen}/img/Chunk_f4.gif (100%) rename {doxygen => docs/doxygen}/img/Chunk_f5.gif (100%) rename {doxygen => docs/doxygen}/img/Chunk_f6.gif (100%) rename {doxygen => docs/doxygen}/img/DOChunks_fig1.png (100%) rename {doxygen => docs/doxygen}/img/DOChunks_fig2.png (100%) rename {doxygen => docs/doxygen}/img/DataGroup.png (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig1.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig10.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig11_b.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig12_a.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig12_b.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig14_a.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig14_b.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig14_c.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig14_d.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig2.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig3_a.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig3_c.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig4_a.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig4_b.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig5.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig6.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig7_b.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig8.gif (100%) rename {doxygen => docs/doxygen}/img/Dmodel_fig9.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_NbitFloating1.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_NbitFloating2.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_NbitInteger1.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_NbitInteger2.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig1.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig10.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig11.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig12.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig2.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig3.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig4.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig5.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig6.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig7.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig8.gif (100%) rename {doxygen => docs/doxygen}/img/Dsets_fig9.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_CvsF1.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_CvsF2.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_CvsF3.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_CvsF4.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_combine.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_complex.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_features.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_features_cmpd.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_move.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_point.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_read.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_select.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_separate.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_simple.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_subset.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_three_datasets.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_transfer.gif (100%) rename {doxygen => docs/doxygen}/img/Dspace_write1to2.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig1.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig10.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig11.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig12.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig13a.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig13b.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig13c.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig13d.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig14.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig15.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig16.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig16a.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig16b.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig16c.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig16d.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig17a.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig17b.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig18.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig19.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig2.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig20a.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig20b.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig20c.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig20d.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig21.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig22.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig23.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig24.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig25a.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig25c.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig26.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig27.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig28.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig3.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig4.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig5.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig6.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig7.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig8.gif (100%) rename {doxygen => docs/doxygen}/img/Dtypes_fig9.gif (100%) rename {doxygen => docs/doxygen}/img/FF-IH_FileGroup.gif (100%) rename {doxygen => docs/doxygen}/img/FF-IH_FileObject.gif (100%) rename {doxygen => docs/doxygen}/img/FileFormatSpecChunkDiagram.jpg (100%) rename {doxygen => docs/doxygen}/img/Files_fig3.gif (100%) rename {doxygen => docs/doxygen}/img/Files_fig4.gif (100%) rename {doxygen => docs/doxygen}/img/FortBuildFlow.svg (100%) rename {doxygen => docs/doxygen}/img/FreeingMemory_fig1.png (100%) rename {doxygen => docs/doxygen}/img/Groups_fig1.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig10_a.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig10_b.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig10_c.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig10_d.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig11_a.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig11_b.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig11_c.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig11_d.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig2.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig3.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig4.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig5.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig6.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig9_a.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig9_aa.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig9_b.gif (100%) rename {doxygen => docs/doxygen}/img/Groups_fig9_bb.gif (100%) rename {doxygen => docs/doxygen}/img/H5DS_fig1.png (100%) rename {doxygen => docs/doxygen}/img/H5DS_fig2.png (100%) rename {doxygen => docs/doxygen}/img/H5DS_fig3.png (100%) rename {doxygen => docs/doxygen}/img/H5DS_fig4.png (100%) rename {doxygen => docs/doxygen}/img/H5DS_fig5.png (100%) rename {doxygen => docs/doxygen}/img/HDF5.png (100%) rename {doxygen => docs/doxygen}/img/HDFG-logo.png (100%) rename {doxygen => docs/doxygen}/img/IOFlow.gif (100%) rename {doxygen => docs/doxygen}/img/IOFlow2.gif (100%) rename {doxygen => docs/doxygen}/img/IOFlow3.gif (100%) rename {doxygen => docs/doxygen}/img/LBDsetSubRWProg.png (100%) rename {doxygen => docs/doxygen}/img/PaletteExample1.gif (100%) rename {doxygen => docs/doxygen}/img/Palettes_fm_anc.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig2.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig3.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig5_a.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig5_b.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig5_c.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig5_d.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig5_e.gif (100%) rename {doxygen => docs/doxygen}/img/Pmodel_fig6.gif (100%) rename {doxygen => docs/doxygen}/img/PropListClassInheritance.gif (100%) rename {doxygen => docs/doxygen}/img/PropListEcosystem.gif (100%) rename {doxygen => docs/doxygen}/img/Shared_Attribute.jpg (100%) rename {doxygen => docs/doxygen}/img/StormDataset.png (100%) rename {doxygen => docs/doxygen}/img/UML_Attribute.jpg (100%) rename {doxygen => docs/doxygen}/img/UML_FileAndProps.gif (100%) rename {doxygen => docs/doxygen}/img/VFL_Drivers.gif (100%) rename {doxygen => docs/doxygen}/img/cgns.png (100%) rename {doxygen => docs/doxygen}/img/chunking1and2.png (100%) rename {doxygen => docs/doxygen}/img/chunking3and4.png (100%) rename {doxygen => docs/doxygen}/img/chunking5.png (100%) rename {doxygen => docs/doxygen}/img/chunking6.png (100%) rename {doxygen => docs/doxygen}/img/chunking7.png (100%) rename {doxygen => docs/doxygen}/img/chunking8.png (100%) rename {doxygen => docs/doxygen}/img/cmpnddtype.png (100%) rename {doxygen => docs/doxygen}/img/crtatt.png (100%) rename {doxygen => docs/doxygen}/img/crtdset.png (100%) rename {doxygen => docs/doxygen}/img/crtf-pic.png (100%) rename {doxygen => docs/doxygen}/img/crtgrp.png (100%) rename {doxygen => docs/doxygen}/img/dataset.png (100%) rename {doxygen => docs/doxygen}/img/datasetwdata.png (100%) rename {doxygen => docs/doxygen}/img/dataspace.png (100%) rename {doxygen => docs/doxygen}/img/dataspace1.png (100%) rename {doxygen => docs/doxygen}/img/datatype.png (100%) rename {doxygen => docs/doxygen}/img/dtypes_fig25b.gif (100%) rename {doxygen => docs/doxygen}/img/fileobj.png (100%) rename {doxygen => docs/doxygen}/img/ftv2node.png (100%) rename {doxygen => docs/doxygen}/img/ftv2pnode.png (100%) rename {doxygen => docs/doxygen}/img/group.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-anthrstrm-img.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-anthrstrm-sprdsht.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-anthrstrm.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-imgicon.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-imgprop.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-imgsubset.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-newcmpd.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-newimgsubset.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-prop.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-qf.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-regref.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-regref1.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-regref2.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-regrefval.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-table.png (100%) rename {doxygen => docs/doxygen}/img/hdfview-tree.png (100%) rename {doxygen => docs/doxygen}/img/images_to_copy.dox (100%) rename {doxygen => docs/doxygen}/img/imgLBDsetCreate.gif (100%) rename {doxygen => docs/doxygen}/img/imgLBDsetSubRW11.png (100%) rename {doxygen => docs/doxygen}/img/imgLBDsetSubRW12.png (100%) rename {doxygen => docs/doxygen}/img/imgLBDsetSubRW31.png (100%) rename {doxygen => docs/doxygen}/img/imgLBDsetSubRW32.png (100%) rename {doxygen => docs/doxygen}/img/imgLBDsetSubRW33.png (100%) rename {doxygen => docs/doxygen}/img/imgLBFile.gif (100%) rename {doxygen => docs/doxygen}/img/imggrpcreate.gif (100%) rename {doxygen => docs/doxygen}/img/imggrpdsets.gif (100%) rename {doxygen => docs/doxygen}/img/imggrps.gif (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_1.png (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_2.png (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_3.png (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_6.png (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_7.png (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_8.png (100%) rename {doxygen => docs/doxygen}/img/improve_perf-compress_fig_9.png (100%) rename {doxygen => docs/doxygen}/img/modregwrite.png (100%) rename {doxygen => docs/doxygen}/img/newgroupimage.png (100%) rename {doxygen => docs/doxygen}/img/noattrs.png (100%) rename {doxygen => docs/doxygen}/img/pchunk_figa.gif (100%) rename {doxygen => docs/doxygen}/img/pchunk_figb.gif (100%) rename {doxygen => docs/doxygen}/img/pchunk_figc.gif (100%) rename {doxygen => docs/doxygen}/img/pchunk_figd.gif (100%) rename {doxygen => docs/doxygen}/img/pcont_hy_figa.gif (100%) rename {doxygen => docs/doxygen}/img/pcont_hy_figb.gif (100%) rename {doxygen => docs/doxygen}/img/pcont_hy_figc.gif (100%) rename {doxygen => docs/doxygen}/img/pcont_hy_figd.gif (100%) rename {doxygen => docs/doxygen}/img/pimplayer.gif (100%) rename {doxygen => docs/doxygen}/img/ppatt_figa.gif (100%) rename {doxygen => docs/doxygen}/img/ppatt_figb.gif (100%) rename {doxygen => docs/doxygen}/img/ppatt_figc.gif (100%) rename {doxygen => docs/doxygen}/img/ppatt_figd.gif (100%) rename {doxygen => docs/doxygen}/img/preg_figa.gif (100%) rename {doxygen => docs/doxygen}/img/preg_figb.gif (100%) rename {doxygen => docs/doxygen}/img/preg_figc.gif (100%) rename {doxygen => docs/doxygen}/img/preg_figd.gif (100%) rename {doxygen => docs/doxygen}/img/properties.png (100%) rename {doxygen => docs/doxygen}/img/scarletletter.png (100%) rename {doxygen => docs/doxygen}/img/showasimage.png (100%) rename {doxygen => docs/doxygen}/img/storm.png (100%) rename {doxygen => docs/doxygen}/img/trunk_branches.jpg (100%) rename {doxygen => docs/doxygen}/img/tutr-lochk.png (100%) rename {doxygen => docs/doxygen}/img/tutr-lochks.png (100%) rename {doxygen => docs/doxygen}/img/tutr-locons.png (100%) rename {doxygen => docs/doxygen}/img/tutr-lodset.png (100%) rename {doxygen => docs/doxygen}/img/tutr-swmr1.png (100%) rename {doxygen => docs/doxygen}/img/tutr-swmr2.png (100%) rename {doxygen => docs/doxygen}/img/tutr-swmr3.png (100%) rename {doxygen => docs/doxygen}/img/tutrvds-ex.png (100%) rename {doxygen => docs/doxygen}/img/tutrvds-map.png (100%) rename {doxygen => docs/doxygen}/img/tutrvds-multimgs.png (100%) rename {doxygen => docs/doxygen}/img/tutrvds-snglimg.png (100%) rename {doxygen => docs/doxygen}/img/vol_architecture.png (100%) rename {doxygen => docs/doxygen}/img/writeLgNumDsets.png (100%) diff --git a/.github/workflows/call-workflows.yml b/.github/workflows/call-workflows.yml index ac164e88dd6..eb6206de601 100644 --- a/.github/workflows/call-workflows.yml +++ b/.github/workflows/call-workflows.yml @@ -7,7 +7,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' @@ -17,7 +17,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' diff --git a/.github/workflows/cve.yml b/.github/workflows/cve.yml index 2c4424be154..c7737d06cec 100644 --- a/.github/workflows/cve.yml +++ b/.github/workflows/cve.yml @@ -7,7 +7,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' @@ -17,7 +17,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' diff --git a/.github/workflows/freebsd.yml b/.github/workflows/freebsd.yml index d9e3b345897..c15c610d9b3 100644 --- a/.github/workflows/freebsd.yml +++ b/.github/workflows/freebsd.yml @@ -7,7 +7,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' @@ -17,7 +17,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' diff --git a/.github/workflows/hdfeos5.yml b/.github/workflows/hdfeos5.yml index 546387e56e0..c8fd9de509d 100644 --- a/.github/workflows/hdfeos5.yml +++ b/.github/workflows/hdfeos5.yml @@ -7,7 +7,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' @@ -17,7 +17,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' diff --git a/.github/workflows/netcdf.yml b/.github/workflows/netcdf.yml index 7ae900768b1..6760d7688e2 100644 --- a/.github/workflows/netcdf.yml +++ b/.github/workflows/netcdf.yml @@ -7,7 +7,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' @@ -17,7 +17,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' diff --git a/.github/workflows/openbsd.yml b/.github/workflows/openbsd.yml index 02da4e85d0c..42f66b7fcd6 100644 --- a/.github/workflows/openbsd.yml +++ b/.github/workflows/openbsd.yml @@ -7,7 +7,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' @@ -17,7 +17,7 @@ on: paths-ignore: - '.github/CODEOWNERS' - '.github/FUNDING.yml' - - 'doc/**' + - 'docs/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - 'LICENSE**' diff --git a/CMakeInstallation.cmake b/CMakeInstallation.cmake index 2cc87e16a27..69118d0730b 100644 --- a/CMakeInstallation.cmake +++ b/CMakeInstallation.cmake @@ -232,7 +232,7 @@ if (HDF5_PACK_EXAMPLES) ) install ( FILES - ${HDF5_SOURCE_DIR}/release_docs/USING_CMake_Examples.md + ${HDF5_DOCS_DIR}/USING_CMake_Examples.md DESTINATION ${HDF5_INSTALL_DATA_DIR} COMPONENT hdfdocuments ) @@ -271,40 +271,40 @@ if (NOT HDF5_EXTERNALLY_CONFIGURED) DESTINATION ${HDF5_INSTALL_DATA_DIR} COMPONENT hdfdocuments ) - if (EXISTS "${HDF5_SOURCE_DIR}/release_docs" AND IS_DIRECTORY "${HDF5_SOURCE_DIR}/release_docs") + if (EXISTS "${HDF5_DOCS_DIR}" AND IS_DIRECTORY "${HDF5_DOCS_DIR}") set (release_files - ${HDF5_SOURCE_DIR}/release_docs/USING_HDF5_CMake.md + ${HDF5_DOCS_DIR}/USING_HDF5_CMake.md ${HDF5_SOURCE_DIR}/release_docs/CHANGELOG.md ) if (WIN32) set (release_files ${release_files} - ${HDF5_SOURCE_DIR}/release_docs/USING_HDF5_VS.md + ${HDF5_DOCS_DIR}/USING_HDF5_VS.md ) endif () if (HDF5_PACK_INSTALL_DOCS) set (release_files ${release_files} - ${HDF5_SOURCE_DIR}/release_docs/INSTALL_CMake.md + ${HDF5_DOCS_DIR}/INSTALL_CMake.md ${HDF5_SOURCE_DIR}/release_docs/HISTORY-1_8.txt - ${HDF5_SOURCE_DIR}/release_docs/INSTALL + ${HDF5_DOCS_DIR}/INSTALL.md ) if (WIN32) set (release_files ${release_files} - ${HDF5_SOURCE_DIR}/release_docs/INSTALL_Windows.md + ${HDF5_DOCS_DIR}/INSTALL_Windows.md ) endif () if (CYGWIN) set (release_files ${release_files} - ${HDF5_SOURCE_DIR}/release_docs/INSTALL_Cygwin.md + ${HDF5_DOCS_DIR}/INSTALL_Cygwin.md ) endif () if (HDF5_ENABLE_PARALLEL) set (release_files ${release_files} - ${HDF5_SOURCE_DIR}/release_docs/README_HPC.md + ${HDF5_DOCS_DIR}/README_HPC.md ) endif () endif () diff --git a/CMakeLists.txt b/CMakeLists.txt index dea8830204b..0ca18e72d4d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -328,7 +328,8 @@ set (HDF5_JAVA_JSRC_DIR ${HDF5_SOURCE_DIR}/java/jsrc) set (HDF5_JAVA_LOGGING_JAR ${HDF5_SOURCE_DIR}/java/lib/slf4j-api-2.0.16.jar) set (HDF5_JAVA_LOGGING_NOP_JAR ${HDF5_SOURCE_DIR}/java/lib/ext/slf4j-nop-2.0.16.jar) set (HDF5_JAVA_LOGGING_SIMPLE_JAR ${HDF5_SOURCE_DIR}/java/lib/ext/slf4j-simple-2.0.16.jar) -set (HDF5_DOXYGEN_DIR ${HDF5_SOURCE_DIR}/doxygen) +set (HDF5_DOCS_DIR ${HDF5_SOURCE_DIR}/docs) +set (HDF5_DOXYGEN_DIR ${HDF5_DOCS_DIR}/doxygen) set (HDF5_SRC_INCLUDE_DIRS ${HDF5_SRC_DIR}) @@ -1169,7 +1170,7 @@ if (HDF5_BUILD_DOC AND EXISTS "${HDF5_DOXYGEN_DIR}" AND IS_DIRECTORY "${HDF5_DOX # the case where Doxygen is not found or HDF5_BUILD_DOC is OFF. add_custom_target (doxygen) - add_subdirectory (doxygen) + add_subdirectory (docs/doxygen) else () message (WARNING "Doxygen needs to be installed to generate the doxygen documentation") endif () diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83b80e3e5c5..a6dd6e86c83 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,8 +145,8 @@ Here's where to find things in the source tree: * **`java/`**: JNI/Java language wrapper * **`bin/`**: Build scripts and miscellaneous tools * **`config/`**: Configuration files for CMake -* **`doxygen/`**: Doxygen build files and documentation -* **`release_docs/`**: Install instructions and release notes +* **`docs/`**: User guides, installation instructions, and Doxygen API documentation +* **`release_docs/`**: Changelogs, version history, and release process * **`utils/`**: Small utility programs --- @@ -245,7 +245,7 @@ Use HDF5's internal memory management instead of direct `malloc`/`free`: - Update documentation as needed. 4. **Build and test thoroughly** - - Follow build instructions in `release_docs/INSTALL*` files. + - Follow build instructions in `docs/INSTALL*` files. - Ensure all tests pass. 5. **Submit a pull request (PR)** diff --git a/README.md b/README.md index ca70710c7d7..b1e9f55e617 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,11 @@ tools, and services at [The HDF Group's website](https://www.hdfgroup.org/). ## Quick Start -- **New to HDF5?** Start with the [INSTALL.md](release_docs/INSTALL.md) guide for compilation and installation instructions. +- **New to HDF5?** Start with the [INSTALL.md](docs/INSTALL.md) guide for compilation and installation instructions. -- **Ready to build?** See [INSTALL_CMake.md](release_docs/INSTALL_CMake.md) for CMake-based builds. +- **Ready to build?** See [INSTALL_CMake.md](docs/INSTALL_CMake.md) for CMake-based builds. -- **Running on HPC?** Check out [README_HPC.md](release_docs/README_HPC.md) for parallel HDF5 configuration. +- **Running on HPC?** Check out [README_HPC.md](docs/README_HPC.md) for parallel HDF5 configuration. ## Table of Contents @@ -56,17 +56,17 @@ to the features and updates included in this release of the library. ### Platform-Specific Guides -Several files in the [release_docs/][u4] directory provide platform-specific details: +Several files in the [docs/][u4] directory provide platform-specific details: | File | Description | |------|-------------| -| [INSTALL](release_docs/INSTALL.md) | General compilation and installation instructions (start here) | -| [INSTALL_CMake.md](release_docs/INSTALL_CMake.md) | Building with CMake | -| [README_HPC.md](release_docs/README_HPC.md) | Building and configuring Parallel HDF5 on HPC systems | -| [INSTALL_Windows.md](release_docs/INSTALL_Windows.md) | Windows installation | -| [INSTALL_Cygwin.md](release_docs/INSTALL_Cygwin.md) | Cygwin installation | -| [USING_HDF5_CMake.md](release_docs/USING_HDF5_CMake.md) | Building HDF5 applications with CMake | -| [USING_CMake_Examples.md](release_docs/USING_CMake_Examples.md) | Building and testing HDF5 examples with CMake | +| [INSTALL](docs/INSTALL.md) | General compilation and installation instructions (start here) | +| [INSTALL_CMake.md](docs/INSTALL_CMake.md) | Building with CMake | +| [README_HPC.md](docs/README_HPC.md) | Building and configuring Parallel HDF5 on HPC systems | +| [INSTALL_Windows.md](docs/INSTALL_Windows.md) | Windows installation | +| [INSTALL_Cygwin.md](docs/INSTALL_Cygwin.md) | Cygwin installation | +| [USING_HDF5_CMake.md](docs/USING_HDF5_CMake.md) | Building HDF5 applications with CMake | +| [USING_CMake_Examples.md](docs/USING_CMake_Examples.md) | Building and testing HDF5 examples with CMake | ## Help and Support @@ -173,5 +173,5 @@ If you use HDF5 in your research, please cite it. This repository includes a [`C [u1]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/CHANGELOG.md [u2]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/img/release-schedule.png -[u3]: https://github.com/HDFGroup/hdf5/blob/develop/doxygen/img/HDF5.png -[u4]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs +[u3]: https://github.com/HDFGroup/hdf5/blob/develop/docs/doxygen/img/HDF5.png +[u4]: https://github.com/HDFGroup/hdf5/blob/develop/docs diff --git a/SECURITY.md b/SECURITY.md index 2a774a39dac..475f73b5e7a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -95,7 +95,7 @@ HDF5-specific practices: - **Artifact Verification:** All binaries and source tarballs on [GitHub Releases](https://github.com/HDFGroup/hdf5/releases) include SHA-256 checksums. Users should verify downloaded artifacts against these checksums. - **SBOM:** We provide CycloneDX SBOM fragments for core, tools, and plugins where applicable. - **Fuzzing:** Continuous fuzzing of HDF5 file parsing and API entry points via OSS-Fuzz. -- **Build from Source:** General build instructions are available in [release_docs/INSTALL](release_docs/INSTALL). +- **Build from Source:** General build instructions are available in [docs/INSTALL.md](docs/INSTALL.md). --- diff --git a/bin/make_vers b/bin/make_vers index 888520edfb7..05c28a41ede 100755 --- a/bin/make_vers +++ b/bin/make_vers @@ -487,7 +487,7 @@ sub create_doxygen_cmake ($) { # Output to doxygen directory (relative to src/) my $doxygen_dir = $prefix; - $doxygen_dir =~ s/src\/?$/doxygen\//; # Replace "src/" with "doxygen/" + $doxygen_dir =~ s/src\/?$/docs\/doxygen\//; # Replace "src/" with "docs/doxygen/" # Create doxygen directory if it doesn't exist if ($doxygen_dir ne "" && ! -d $doxygen_dir) { @@ -549,7 +549,7 @@ for $file (@ARGV) { # Create header files print "Generating 'H5version.h'\n"; create_public($prefix); - print "Generating 'doxygen/H5version_doxygen.cmake'\n"; + print "Generating 'docs/doxygen/H5version_doxygen.cmake'\n"; create_doxygen_cmake($prefix); } diff --git a/config/README.md b/config/README.md index c54709ae800..30d3b0a30b7 100644 --- a/config/README.md +++ b/config/README.md @@ -21,11 +21,11 @@ This directory contains a few important things: * Example install scripts (in `examples`) * Installation support files (in `install`) -CMake is documented in the following in the root's `release_docs` folder files: +CMake is documented in the following files in the `docs/` directory: -* [INSTALL.md](../release_docs/INSTALL.md) -* [INSTALL_CMake.md](../release_docs/INSTALL_CMake.md) -* [USING_HDF5_CMake.md](../release_docs/USING_HDF5_CMake.md) -* [USING_HDF5_VS.md](../release_docs/USING_HDF5_VS.md) -* [INSTALL_Windows.md](../release_docs/INSTALL_Windows.md) -* [USING_CMake_Examples.md](../release_docs/USING_CMake_Examples.md) +* [INSTALL.md](../docs/INSTALL.md) +* [INSTALL_CMake.md](../docs/INSTALL_CMake.md) +* [USING_HDF5_CMake.md](../docs/USING_HDF5_CMake.md) +* [USING_HDF5_VS.md](../docs/USING_HDF5_VS.md) +* [INSTALL_Windows.md](../docs/INSTALL_Windows.md) +* [USING_CMake_Examples.md](../docs/USING_CMake_Examples.md) diff --git a/release_docs/AutotoolsToCMakeOptions.md b/docs/AutotoolsToCMakeOptions.md similarity index 98% rename from release_docs/AutotoolsToCMakeOptions.md rename to docs/AutotoolsToCMakeOptions.md index 7d8ba660d04..59a675fe6e4 100644 --- a/release_docs/AutotoolsToCMakeOptions.md +++ b/docs/AutotoolsToCMakeOptions.md @@ -20,7 +20,7 @@ CMake builds include a number of CMake specific files for support of CMake's fin ## Introduction The table below shows the equivalent CMake build options that match those from Autotools. See the -[release_docs/INSTALL_CMake.md](./INSTALL_CMake.md) file for more information on the CMake build system and options. +[INSTALL_CMake.md](./INSTALL_CMake.md) file for more information on the CMake build system and options. ## Autotools to CMake Options | Autotools Build Options | CMake Build Options | Notes | diff --git a/release_docs/BuildSystemNotes.md b/docs/BuildSystemNotes.md similarity index 100% rename from release_docs/BuildSystemNotes.md rename to docs/BuildSystemNotes.md diff --git a/release_docs/HDF5_Library_2.0.0_Migration_Guide.md b/docs/HDF5_Library_2.0.0_Migration_Guide.md similarity index 100% rename from release_docs/HDF5_Library_2.0.0_Migration_Guide.md rename to docs/HDF5_Library_2.0.0_Migration_Guide.md diff --git a/release_docs/INSTALL.md b/docs/INSTALL.md similarity index 96% rename from release_docs/INSTALL.md rename to docs/INSTALL.md index 246c566809e..16a3d71b866 100644 --- a/release_docs/INSTALL.md +++ b/docs/INSTALL.md @@ -58,7 +58,7 @@ The HDF Group provides source code and pre-compiled binaries from the HDF5 GitHu ### 3.1. Build and Install HDF5 Libraries and Tools with CMake -See the [release_docs/INSTALL_CMake.md](./INSTALL_CMake.md) file for detailed instructions. +See the [INSTALL_CMake.md](./INSTALL_CMake.md) file for detailed instructions. ## 4. Quick Start Presets @@ -91,7 +91,7 @@ The above example will create a `build` folder in the source parent directory, w ### 4.3. Customization -See the HDF5 documentation for more on presets, especially the presets section in the [release_docs/INSTALL_CMake.md](./INSTALL_CMake.md) file. +See the HDF5 documentation for more on presets, especially the presets section in the [INSTALL_CMake.md](./INSTALL_CMake.md) file. ### 4.4. See Also diff --git a/release_docs/INSTALL_CMake.md b/docs/INSTALL_CMake.md similarity index 100% rename from release_docs/INSTALL_CMake.md rename to docs/INSTALL_CMake.md diff --git a/release_docs/INSTALL_Cygwin.md b/docs/INSTALL_Cygwin.md similarity index 100% rename from release_docs/INSTALL_Cygwin.md rename to docs/INSTALL_Cygwin.md diff --git a/release_docs/INSTALL_Filters.md b/docs/INSTALL_Filters.md similarity index 100% rename from release_docs/INSTALL_Filters.md rename to docs/INSTALL_Filters.md diff --git a/release_docs/INSTALL_S3.md b/docs/INSTALL_S3.md similarity index 97% rename from release_docs/INSTALL_S3.md rename to docs/INSTALL_S3.md index 643cc9138de..d35a5262691 100644 --- a/release_docs/INSTALL_S3.md +++ b/docs/INSTALL_S3.md @@ -17,7 +17,7 @@ ## I. Preconditions -* Refer to [release_docs/INSTALL.md](./INSTALL.md) for preconditions and instructions for building HDF5. +* Refer to [INSTALL.md](./INSTALL.md) for preconditions and instructions for building HDF5. --- @@ -148,7 +148,7 @@ If the `aws-c-s3` library is installed to a non-standard location, the environme CMAKE_PREFIX_PATH= cmake -DHDF5_ENABLE_ROS3_VFD=ON .. ``` -Refer to [release_docs/INSTALL_CMake.md](./INSTALL_CMake.md) for more general instructions on building HDF5 with CMake. +Refer to [INSTALL_CMake.md](./INSTALL_CMake.md) for more general instructions on building HDF5 with CMake. --- diff --git a/release_docs/INSTALL_Windows.md b/docs/INSTALL_Windows.md similarity index 100% rename from release_docs/INSTALL_Windows.md rename to docs/INSTALL_Windows.md diff --git a/release_docs/README_HPC.md b/docs/README_HPC.md similarity index 100% rename from release_docs/README_HPC.md rename to docs/README_HPC.md diff --git a/release_docs/USING_CMake_Examples.md b/docs/USING_CMake_Examples.md similarity index 100% rename from release_docs/USING_CMake_Examples.md rename to docs/USING_CMake_Examples.md diff --git a/release_docs/USING_HDF5_CMake.md b/docs/USING_HDF5_CMake.md similarity index 100% rename from release_docs/USING_HDF5_CMake.md rename to docs/USING_HDF5_CMake.md diff --git a/release_docs/USING_HDF5_VS.md b/docs/USING_HDF5_VS.md similarity index 100% rename from release_docs/USING_HDF5_VS.md rename to docs/USING_HDF5_VS.md diff --git a/doxygen/CMakeLists.txt b/docs/doxygen/CMakeLists.txt similarity index 94% rename from doxygen/CMakeLists.txt rename to docs/doxygen/CMakeLists.txt index a365b8681ff..413be945b47 100644 --- a/doxygen/CMakeLists.txt +++ b/docs/doxygen/CMakeLists.txt @@ -20,7 +20,7 @@ if (DOXYGEN_FOUND) set (DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES) set (DOXYGEN_MACRO_EXPANSION YES) set (DOXYGEN_OUTPUT_DIRECTORY ${HDF5_BINARY_DIR}/hdf5lib_docs) - set (DOXYGEN_EXAMPLES_DIRECTORY "${HDF5_DOXYGEN_DIR}/dox/cookbook ${HDF5_DOXYGEN_DIR}/examples ${HDF5_SRC_DIR} ${HDF5_SOURCE_DIR}/release_docs ${HDF5_TEST_SRC_DIR}") + set (DOXYGEN_EXAMPLES_DIRECTORY "${HDF5_DOXYGEN_DIR}/dox/cookbook ${HDF5_DOXYGEN_DIR}/examples ${HDF5_SRC_DIR} ${HDF5_SOURCE_DIR}/docs ${HDF5_TEST_SRC_DIR}") set (DOXYGEN_LAYOUT_FILE ${HDF5_DOXYGEN_DIR}/hdf5doxy_layout.xml) set (DOXYGEN_HTML_HEADER ${HDF5_DOXYGEN_DIR}/hdf5_header.html) set (DOXYGEN_HTML_FOOTER ${HDF5_DOXYGEN_DIR}/hdf5_footer.html) @@ -39,7 +39,7 @@ if (DOXYGEN_FOUND) # get associated with the same underlying function. # # The versioned API macros are auto-generated from src/H5vers.txt by the - # bin/make_vers script, which creates doxygen/H5version_doxygen.cmake. + # bin/make_vers script, which creates docs/doxygen/H5version_doxygen.cmake. # This ensures the Doxygen configuration stays synchronized with the # actual default versions defined in src/H5version.h. set (_doxygen_predefined_entries @@ -55,7 +55,7 @@ if (DOXYGEN_FOUND) "H5std_string=std::string" "H5G_link_t=H5L_type_t" ) - # Load auto-generated versioned API macros from doxygen/H5version_doxygen.cmake + # Load auto-generated versioned API macros from docs/doxygen/H5version_doxygen.cmake include(${HDF5_DOXYGEN_DIR}/H5version_doxygen.cmake) list (JOIN _doxygen_predefined_entries " " DOXYGEN_PREDEFINED) set (DOXYGEN_WARN_AS_ERROR ${HDF5_DOXY_WARNINGS}) diff --git a/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in similarity index 100% rename from doxygen/Doxyfile.in rename to docs/doxygen/Doxyfile.in diff --git a/doxygen/H5version_doxygen.cmake b/docs/doxygen/H5version_doxygen.cmake similarity index 100% rename from doxygen/H5version_doxygen.cmake rename to docs/doxygen/H5version_doxygen.cmake diff --git a/doxygen/aliases b/docs/doxygen/aliases similarity index 100% rename from doxygen/aliases rename to docs/doxygen/aliases diff --git a/doxygen/dox/APIVersions.dox b/docs/doxygen/dox/APIVersions.dox similarity index 100% rename from doxygen/dox/APIVersions.dox rename to docs/doxygen/dox/APIVersions.dox diff --git a/doxygen/dox/About.dox b/docs/doxygen/dox/About.dox similarity index 100% rename from doxygen/dox/About.dox rename to docs/doxygen/dox/About.dox diff --git a/doxygen/dox/AppDbgging.dox b/docs/doxygen/dox/AppDbgging.dox similarity index 100% rename from doxygen/dox/AppDbgging.dox rename to docs/doxygen/dox/AppDbgging.dox diff --git a/doxygen/dox/CollectiveCalls.dox b/docs/doxygen/dox/CollectiveCalls.dox similarity index 100% rename from doxygen/dox/CollectiveCalls.dox rename to docs/doxygen/dox/CollectiveCalls.dox diff --git a/doxygen/dox/CollectiveMetadataIO.dox b/docs/doxygen/dox/CollectiveMetadataIO.dox similarity index 100% rename from doxygen/dox/CollectiveMetadataIO.dox rename to docs/doxygen/dox/CollectiveMetadataIO.dox diff --git a/doxygen/dox/Cookbook.dox b/docs/doxygen/dox/Cookbook.dox similarity index 100% rename from doxygen/dox/Cookbook.dox rename to docs/doxygen/dox/Cookbook.dox diff --git a/doxygen/dox/CopyingCommited.dox b/docs/doxygen/dox/CopyingCommited.dox similarity index 100% rename from doxygen/dox/CopyingCommited.dox rename to docs/doxygen/dox/CopyingCommited.dox diff --git a/doxygen/dox/CppAPIIntro.dox b/docs/doxygen/dox/CppAPIIntro.dox similarity index 89% rename from doxygen/dox/CppAPIIntro.dox rename to docs/doxygen/dox/CppAPIIntro.dox index 02dd1855786..18d29245074 100644 --- a/doxygen/dox/CppAPIIntro.dox +++ b/docs/doxygen/dox/CppAPIIntro.dox @@ -46,7 +46,7 @@ See the \ref LBExamples for additional examples. \subsection cpp_building Building Applications -Please refer to the release_docs/INSTALL_CMake.md file under the top directory of the HDF5 source code or INSTALL_CMake.md on GitHub for information about installing, building, and testing the C++ API. +Please refer to the docs/INSTALL_CMake.md file under the top directory of the HDF5 source code or INSTALL_CMake.md on GitHub for information about installing, building, and testing the C++ API.
diff --git a/doxygen/dox/DDLBNF110.dox b/docs/doxygen/dox/DDLBNF110.dox similarity index 100% rename from doxygen/dox/DDLBNF110.dox rename to docs/doxygen/dox/DDLBNF110.dox diff --git a/doxygen/dox/DDLBNF112.dox b/docs/doxygen/dox/DDLBNF112.dox similarity index 100% rename from doxygen/dox/DDLBNF112.dox rename to docs/doxygen/dox/DDLBNF112.dox diff --git a/doxygen/dox/DDLBNF114.dox b/docs/doxygen/dox/DDLBNF114.dox similarity index 100% rename from doxygen/dox/DDLBNF114.dox rename to docs/doxygen/dox/DDLBNF114.dox diff --git a/doxygen/dox/DDLBNF200.dox b/docs/doxygen/dox/DDLBNF200.dox similarity index 100% rename from doxygen/dox/DDLBNF200.dox rename to docs/doxygen/dox/DDLBNF200.dox diff --git a/doxygen/dox/DSChunkingIssues.dox b/docs/doxygen/dox/DSChunkingIssues.dox similarity index 100% rename from doxygen/dox/DSChunkingIssues.dox rename to docs/doxygen/dox/DSChunkingIssues.dox diff --git a/doxygen/dox/ExamplesAPI.dox b/docs/doxygen/dox/ExamplesAPI.dox similarity index 100% rename from doxygen/dox/ExamplesAPI.dox rename to docs/doxygen/dox/ExamplesAPI.dox diff --git a/doxygen/dox/FTS.dox b/docs/doxygen/dox/FTS.dox similarity index 100% rename from doxygen/dox/FTS.dox rename to docs/doxygen/dox/FTS.dox diff --git a/doxygen/dox/FileFormatDisc.dox b/docs/doxygen/dox/FileFormatDisc.dox similarity index 100% rename from doxygen/dox/FileFormatDisc.dox rename to docs/doxygen/dox/FileFormatDisc.dox diff --git a/doxygen/dox/FileFormatSpec.dox b/docs/doxygen/dox/FileFormatSpec.dox similarity index 100% rename from doxygen/dox/FileFormatSpec.dox rename to docs/doxygen/dox/FileFormatSpec.dox diff --git a/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox b/docs/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox similarity index 100% rename from doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox rename to docs/doxygen/dox/FreeingMemoryAllocatedByTheHdf5Library.dox diff --git a/doxygen/dox/GettingStarted.dox b/docs/doxygen/dox/GettingStarted.dox similarity index 100% rename from doxygen/dox/GettingStarted.dox rename to docs/doxygen/dox/GettingStarted.dox diff --git a/doxygen/dox/Glossary.dox b/docs/doxygen/dox/Glossary.dox similarity index 100% rename from doxygen/dox/Glossary.dox rename to docs/doxygen/dox/Glossary.dox diff --git a/doxygen/dox/H5.format.1.0.dox b/docs/doxygen/dox/H5.format.1.0.dox similarity index 100% rename from doxygen/dox/H5.format.1.0.dox rename to docs/doxygen/dox/H5.format.1.0.dox diff --git a/doxygen/dox/H5.format.1.1.dox b/docs/doxygen/dox/H5.format.1.1.dox similarity index 100% rename from doxygen/dox/H5.format.1.1.dox rename to docs/doxygen/dox/H5.format.1.1.dox diff --git a/doxygen/dox/H5.format.2.0.dox b/docs/doxygen/dox/H5.format.2.0.dox similarity index 100% rename from doxygen/dox/H5.format.2.0.dox rename to docs/doxygen/dox/H5.format.2.0.dox diff --git a/doxygen/dox/H5.format.3.0.dox b/docs/doxygen/dox/H5.format.3.0.dox similarity index 100% rename from doxygen/dox/H5.format.3.0.dox rename to docs/doxygen/dox/H5.format.3.0.dox diff --git a/doxygen/dox/H5.format.4.0.dox b/docs/doxygen/dox/H5.format.4.0.dox similarity index 100% rename from doxygen/dox/H5.format.4.0.dox rename to docs/doxygen/dox/H5.format.4.0.dox diff --git a/doxygen/dox/H5AC_cache_config_t.dox b/docs/doxygen/dox/H5AC_cache_config_t.dox similarity index 100% rename from doxygen/dox/H5AC_cache_config_t.dox rename to docs/doxygen/dox/H5AC_cache_config_t.dox diff --git a/doxygen/dox/HDF5CompressionTroubleshooting.dox b/docs/doxygen/dox/HDF5CompressionTroubleshooting.dox similarity index 99% rename from doxygen/dox/HDF5CompressionTroubleshooting.dox rename to docs/doxygen/dox/HDF5CompressionTroubleshooting.dox index 150ad2004bf..84ddc6b464b 100644 --- a/doxygen/dox/HDF5CompressionTroubleshooting.dox +++ b/docs/doxygen/dox/HDF5CompressionTroubleshooting.dox @@ -83,8 +83,8 @@ With CMake both libraries have to be explicitly enabled. The source code distrib Users can overwrite the defaults by using -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF -DHDF5_ENABLE_ZLIB_SUPPORT:BOOL=OFF with the “cmake –C” command. See the -INSTALL_CMake.md file -under the release_docs directory in the HDF5 source distribution. +INSTALL_CMake.md file +under the docs directory in the HDF5 source distribution. If compression is not requested or found at configuration time, the compression method is not registered with the library and cannot be applied when data is written or read. For example, the diff --git a/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox b/docs/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox similarity index 100% rename from doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox rename to docs/doxygen/dox/HDF5ImprovingIOPerformanceCompressedDatasets.dox diff --git a/doxygen/dox/IOFlow.dox b/docs/doxygen/dox/IOFlow.dox similarity index 100% rename from doxygen/dox/IOFlow.dox rename to docs/doxygen/dox/IOFlow.dox diff --git a/doxygen/dox/ImageSpec.dox b/docs/doxygen/dox/ImageSpec.dox similarity index 100% rename from doxygen/dox/ImageSpec.dox rename to docs/doxygen/dox/ImageSpec.dox diff --git a/doxygen/dox/IntroHDF5.dox b/docs/doxygen/dox/IntroHDF5.dox similarity index 100% rename from doxygen/dox/IntroHDF5.dox rename to docs/doxygen/dox/IntroHDF5.dox diff --git a/doxygen/dox/IntroParExamples.dox b/docs/doxygen/dox/IntroParExamples.dox similarity index 100% rename from doxygen/dox/IntroParExamples.dox rename to docs/doxygen/dox/IntroParExamples.dox diff --git a/doxygen/dox/IntroParHDF5.dox b/docs/doxygen/dox/IntroParHDF5.dox similarity index 100% rename from doxygen/dox/IntroParHDF5.dox rename to docs/doxygen/dox/IntroParHDF5.dox diff --git a/doxygen/dox/LearnBasics.dox b/docs/doxygen/dox/LearnBasics.dox similarity index 100% rename from doxygen/dox/LearnBasics.dox rename to docs/doxygen/dox/LearnBasics.dox diff --git a/doxygen/dox/LearnBasics1.dox b/docs/doxygen/dox/LearnBasics1.dox similarity index 100% rename from doxygen/dox/LearnBasics1.dox rename to docs/doxygen/dox/LearnBasics1.dox diff --git a/doxygen/dox/LearnBasics2.dox b/docs/doxygen/dox/LearnBasics2.dox similarity index 100% rename from doxygen/dox/LearnBasics2.dox rename to docs/doxygen/dox/LearnBasics2.dox diff --git a/doxygen/dox/LearnBasics3.dox b/docs/doxygen/dox/LearnBasics3.dox similarity index 98% rename from doxygen/dox/LearnBasics3.dox rename to docs/doxygen/dox/LearnBasics3.dox index 4d7874996e7..ef408fec42d 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/docs/doxygen/dox/LearnBasics3.dox @@ -777,7 +777,7 @@ if the library was built with C++ and Fortran.

USING_HDF5_CMake.md:

-See USING_CMake_Examples.md. +See USING_CMake_Examples.md. \section secLBCompilingVS Using Visual Studio @@ -972,7 +972,7 @@ or on WINDOWS you may need to add the path to the bin folder to PATH. \section secLBCompilingCMake Compiling an Application with CMake \subsection subsecLBCompilingCMakeScripts CMake Scripts for Building Applications -See Using CMake to Build Applications to build applications with different languages and options. +See Using CMake to Build Applications to build applications with different languages and options. For a more complete script (and to help resolve issues) see the script provided with the HDF5 Examples project. @@ -980,7 +980,7 @@ For a more complete script (and to help resolve issues) see the script provided The installed HDF5 can be verified by compiling the HDF5 Examples project, included with the CMake built HDF5 binaries in the share folder or you can go to the HDF5 Examples in the HDF5 github repository. -Go into the share directory and follow the instructions in Using CMake to Build Examples to build the examples. +Go into the share directory and follow the instructions in Using CMake to Build Examples to build the examples. In general, users must first set the HDF5_ROOT environment variable to the installed location of the CMake configuration files for HDF5. @@ -998,7 +998,7 @@ For example, on Linux the following path might be set: \subsection subsecLBCompilingCMakeTroubless Troubleshooting CMake

How do you use find_package with HDF5?

To use find_package you will first need to make sure that HDF5_ROOT is set correctly. For setting this -environment variable see the Preconditions in the USING_HDF5_CMake.md file in the share directory. +environment variable see the Preconditions in the USING_HDF5_CMake.md file in the share directory. See the CMakeLists.txt file provided with these examples for how to use find_package with HDF5. diff --git a/doxygen/dox/LearnHDFView.dox b/docs/doxygen/dox/LearnHDFView.dox similarity index 100% rename from doxygen/dox/LearnHDFView.dox rename to docs/doxygen/dox/LearnHDFView.dox diff --git a/doxygen/dox/MetadataCachingInHDF5.dox b/docs/doxygen/dox/MetadataCachingInHDF5.dox similarity index 100% rename from doxygen/dox/MetadataCachingInHDF5.dox rename to docs/doxygen/dox/MetadataCachingInHDF5.dox diff --git a/doxygen/dox/ModifiedRegionWrites.dox b/docs/doxygen/dox/ModifiedRegionWrites.dox similarity index 100% rename from doxygen/dox/ModifiedRegionWrites.dox rename to docs/doxygen/dox/ModifiedRegionWrites.dox diff --git a/doxygen/dox/Overview.dox b/docs/doxygen/dox/Overview.dox similarity index 100% rename from doxygen/dox/Overview.dox rename to docs/doxygen/dox/Overview.dox diff --git a/doxygen/dox/PredefinedDatatypeTables.dox b/docs/doxygen/dox/PredefinedDatatypeTables.dox similarity index 100% rename from doxygen/dox/PredefinedDatatypeTables.dox rename to docs/doxygen/dox/PredefinedDatatypeTables.dox diff --git a/doxygen/dox/RFC.dox b/docs/doxygen/dox/RFC.dox similarity index 100% rename from doxygen/dox/RFC.dox rename to docs/doxygen/dox/RFC.dox diff --git a/doxygen/dox/ReferenceManual.dox b/docs/doxygen/dox/ReferenceManual.dox similarity index 100% rename from doxygen/dox/ReferenceManual.dox rename to docs/doxygen/dox/ReferenceManual.dox diff --git a/doxygen/dox/RelVersion.dox b/docs/doxygen/dox/RelVersion.dox similarity index 100% rename from doxygen/dox/RelVersion.dox rename to docs/doxygen/dox/RelVersion.dox diff --git a/doxygen/dox/SWMRTechNote.dox b/docs/doxygen/dox/SWMRTechNote.dox similarity index 100% rename from doxygen/dox/SWMRTechNote.dox rename to docs/doxygen/dox/SWMRTechNote.dox diff --git a/doxygen/dox/Specifications.dox b/docs/doxygen/dox/Specifications.dox similarity index 100% rename from doxygen/dox/Specifications.dox rename to docs/doxygen/dox/Specifications.dox diff --git a/doxygen/dox/TableSpec.dox b/docs/doxygen/dox/TableSpec.dox similarity index 100% rename from doxygen/dox/TableSpec.dox rename to docs/doxygen/dox/TableSpec.dox diff --git a/doxygen/dox/TechnicalNotes.dox b/docs/doxygen/dox/TechnicalNotes.dox similarity index 100% rename from doxygen/dox/TechnicalNotes.dox rename to docs/doxygen/dox/TechnicalNotes.dox diff --git a/doxygen/dox/ThreadSafe.dox b/docs/doxygen/dox/ThreadSafe.dox similarity index 100% rename from doxygen/dox/ThreadSafe.dox rename to docs/doxygen/dox/ThreadSafe.dox diff --git a/doxygen/dox/Tools.dox b/docs/doxygen/dox/Tools.dox similarity index 100% rename from doxygen/dox/Tools.dox rename to docs/doxygen/dox/Tools.dox diff --git a/doxygen/dox/TrainingVideos.dox b/docs/doxygen/dox/TrainingVideos.dox similarity index 100% rename from doxygen/dox/TrainingVideos.dox rename to docs/doxygen/dox/TrainingVideos.dox diff --git a/doxygen/dox/Unicode.dox b/docs/doxygen/dox/Unicode.dox similarity index 100% rename from doxygen/dox/Unicode.dox rename to docs/doxygen/dox/Unicode.dox diff --git a/doxygen/dox/UsersGuide.dox b/docs/doxygen/dox/UsersGuide.dox similarity index 100% rename from doxygen/dox/UsersGuide.dox rename to docs/doxygen/dox/UsersGuide.dox diff --git a/doxygen/dox/UsingIdentifiers.dox b/docs/doxygen/dox/UsingIdentifiers.dox similarity index 100% rename from doxygen/dox/UsingIdentifiers.dox rename to docs/doxygen/dox/UsingIdentifiers.dox diff --git a/doxygen/dox/VDSTechNote.dox b/docs/doxygen/dox/VDSTechNote.dox similarity index 100% rename from doxygen/dox/VDSTechNote.dox rename to docs/doxygen/dox/VDSTechNote.dox diff --git a/doxygen/dox/VFLTechNote.dox b/docs/doxygen/dox/VFLTechNote.dox similarity index 100% rename from doxygen/dox/VFLTechNote.dox rename to docs/doxygen/dox/VFLTechNote.dox diff --git a/doxygen/dox/VOLConnGuide.dox b/docs/doxygen/dox/VOLConnGuide.dox similarity index 100% rename from doxygen/dox/VOLConnGuide.dox rename to docs/doxygen/dox/VOLConnGuide.dox diff --git a/doxygen/dox/ViewTools.dox b/docs/doxygen/dox/ViewTools.dox similarity index 100% rename from doxygen/dox/ViewTools.dox rename to docs/doxygen/dox/ViewTools.dox diff --git a/doxygen/dox/ViewTools2.dox b/docs/doxygen/dox/ViewTools2.dox similarity index 100% rename from doxygen/dox/ViewTools2.dox rename to docs/doxygen/dox/ViewTools2.dox diff --git a/doxygen/dox/ViewToolsJPSS.dox b/docs/doxygen/dox/ViewToolsJPSS.dox similarity index 100% rename from doxygen/dox/ViewToolsJPSS.dox rename to docs/doxygen/dox/ViewToolsJPSS.dox diff --git a/doxygen/dox/api-compat-macros.dox b/docs/doxygen/dox/api-compat-macros.dox similarity index 100% rename from doxygen/dox/api-compat-macros.dox rename to docs/doxygen/dox/api-compat-macros.dox diff --git a/doxygen/dox/branches-explained.dox b/docs/doxygen/dox/branches-explained.dox similarity index 100% rename from doxygen/dox/branches-explained.dox rename to docs/doxygen/dox/branches-explained.dox diff --git a/doxygen/dox/chunking_in_hdf5.dox b/docs/doxygen/dox/chunking_in_hdf5.dox similarity index 100% rename from doxygen/dox/chunking_in_hdf5.dox rename to docs/doxygen/dox/chunking_in_hdf5.dox diff --git a/doxygen/dox/cmake-vols-fetchcontent.dox b/docs/doxygen/dox/cmake-vols-fetchcontent.dox similarity index 100% rename from doxygen/dox/cmake-vols-fetchcontent.dox rename to docs/doxygen/dox/cmake-vols-fetchcontent.dox diff --git a/doxygen/dox/code-conventions.dox b/docs/doxygen/dox/code-conventions.dox similarity index 100% rename from doxygen/dox/code-conventions.dox rename to docs/doxygen/dox/code-conventions.dox diff --git a/doxygen/dox/cookbook/Accessibility.c b/docs/doxygen/dox/cookbook/Accessibility.c similarity index 100% rename from doxygen/dox/cookbook/Accessibility.c rename to docs/doxygen/dox/cookbook/Accessibility.c diff --git a/doxygen/dox/cookbook/Accessibility.dox b/docs/doxygen/dox/cookbook/Accessibility.dox similarity index 100% rename from doxygen/dox/cookbook/Accessibility.dox rename to docs/doxygen/dox/cookbook/Accessibility.dox diff --git a/doxygen/dox/cookbook/Attributes.c b/docs/doxygen/dox/cookbook/Attributes.c similarity index 100% rename from doxygen/dox/cookbook/Attributes.c rename to docs/doxygen/dox/cookbook/Attributes.c diff --git a/doxygen/dox/cookbook/Attributes.dox b/docs/doxygen/dox/cookbook/Attributes.dox similarity index 100% rename from doxygen/dox/cookbook/Attributes.dox rename to docs/doxygen/dox/cookbook/Attributes.dox diff --git a/doxygen/dox/cookbook/Files.c b/docs/doxygen/dox/cookbook/Files.c similarity index 100% rename from doxygen/dox/cookbook/Files.c rename to docs/doxygen/dox/cookbook/Files.c diff --git a/doxygen/dox/cookbook/Files.dox b/docs/doxygen/dox/cookbook/Files.dox similarity index 100% rename from doxygen/dox/cookbook/Files.dox rename to docs/doxygen/dox/cookbook/Files.dox diff --git a/doxygen/dox/cookbook/MavenArtifacts.dox b/docs/doxygen/dox/cookbook/MavenArtifacts.dox similarity index 100% rename from doxygen/dox/cookbook/MavenArtifacts.dox rename to docs/doxygen/dox/cookbook/MavenArtifacts.dox diff --git a/doxygen/dox/cookbook/Performance.dox b/docs/doxygen/dox/cookbook/Performance.dox similarity index 100% rename from doxygen/dox/cookbook/Performance.dox rename to docs/doxygen/dox/cookbook/Performance.dox diff --git a/doxygen/dox/cookbook/Presets.dox b/docs/doxygen/dox/cookbook/Presets.dox similarity index 99% rename from doxygen/dox/cookbook/Presets.dox rename to docs/doxygen/dox/cookbook/Presets.dox index 9c2c613a0fa..f6153611a4e 100644 --- a/doxygen/dox/cookbook/Presets.dox +++ b/docs/doxygen/dox/cookbook/Presets.dox @@ -582,7 +582,7 @@ ctest -R "JUnitFFM" -V \par See Also \li \ref subsec_maven_artifacts for using pre-built Maven artifacts -\li release_docs/INSTALL_CMake.md Section XIII for Java FFM testing details +\li docs/INSTALL_CMake.md Section XIII for Java FFM testing details \li release_docs/README.md for comprehensive Java documentation \li HDF5Examples/JAVA for Java example programs diff --git a/doxygen/dox/file-locking.dox b/docs/doxygen/dox/file-locking.dox similarity index 100% rename from doxygen/dox/file-locking.dox rename to docs/doxygen/dox/file-locking.dox diff --git a/doxygen/dox/hdf5_1_10.dox b/docs/doxygen/dox/hdf5_1_10.dox similarity index 100% rename from doxygen/dox/hdf5_1_10.dox rename to docs/doxygen/dox/hdf5_1_10.dox diff --git a/doxygen/dox/hdf5_1_12.dox b/docs/doxygen/dox/hdf5_1_12.dox similarity index 100% rename from doxygen/dox/hdf5_1_12.dox rename to docs/doxygen/dox/hdf5_1_12.dox diff --git a/doxygen/dox/hdf5_1_14.dox b/docs/doxygen/dox/hdf5_1_14.dox similarity index 98% rename from doxygen/dox/hdf5_1_14.dox rename to docs/doxygen/dox/hdf5_1_14.dox index 5c846770b18..2a67d8faca1 100644 --- a/doxygen/dox/hdf5_1_14.dox +++ b/docs/doxygen/dox/hdf5_1_14.dox @@ -83,7 +83,7 @@ ABI/API compatibility reports between 1.14.6 and 1.14.5 [tar file](https://\RELU Source code and binaries are available at: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6 -Please refer to [Build instructions](https://\SRCURL/release_docs/INSTALL) for building with either CMake or Autotools. +For detailed information on how to build, please refer to the [build instructions](https://\SRCURL/docs/INSTALL.md). \subsection subsec_obtain_method_114 Methods to obtain (gz file) diff --git a/doxygen/dox/hdf5_1_8.dox b/docs/doxygen/dox/hdf5_1_8.dox similarity index 100% rename from doxygen/dox/hdf5_1_8.dox rename to docs/doxygen/dox/hdf5_1_8.dox diff --git a/doxygen/dox/hdf5_2x.dox b/docs/doxygen/dox/hdf5_2x.dox similarity index 100% rename from doxygen/dox/hdf5_2x.dox rename to docs/doxygen/dox/hdf5_2x.dox diff --git a/doxygen/dox/high_level/extension.dox b/docs/doxygen/dox/high_level/extension.dox similarity index 100% rename from doxygen/dox/high_level/extension.dox rename to docs/doxygen/dox/high_level/extension.dox diff --git a/doxygen/dox/library-init-shutdown.dox b/docs/doxygen/dox/library-init-shutdown.dox similarity index 100% rename from doxygen/dox/library-init-shutdown.dox rename to docs/doxygen/dox/library-init-shutdown.dox diff --git a/doxygen/dox/maybe_metadata_reads.dox b/docs/doxygen/dox/maybe_metadata_reads.dox similarity index 100% rename from doxygen/dox/maybe_metadata_reads.dox rename to docs/doxygen/dox/maybe_metadata_reads.dox diff --git a/doxygen/dox/parallel-compression.dox b/docs/doxygen/dox/parallel-compression.dox similarity index 100% rename from doxygen/dox/parallel-compression.dox rename to docs/doxygen/dox/parallel-compression.dox diff --git a/doxygen/dox/release_specific_info.dox b/docs/doxygen/dox/release_specific_info.dox similarity index 100% rename from doxygen/dox/release_specific_info.dox rename to docs/doxygen/dox/release_specific_info.dox diff --git a/doxygen/dox/rm-template.dox b/docs/doxygen/dox/rm-template.dox similarity index 100% rename from doxygen/dox/rm-template.dox rename to docs/doxygen/dox/rm-template.dox diff --git a/doxygen/dox/sw_changes_1.10.dox b/docs/doxygen/dox/sw_changes_1.10.dox similarity index 100% rename from doxygen/dox/sw_changes_1.10.dox rename to docs/doxygen/dox/sw_changes_1.10.dox diff --git a/doxygen/dox/sw_changes_1.12.dox b/docs/doxygen/dox/sw_changes_1.12.dox similarity index 100% rename from doxygen/dox/sw_changes_1.12.dox rename to docs/doxygen/dox/sw_changes_1.12.dox diff --git a/doxygen/dox/sw_changes_1.14.dox b/docs/doxygen/dox/sw_changes_1.14.dox similarity index 100% rename from doxygen/dox/sw_changes_1.14.dox rename to docs/doxygen/dox/sw_changes_1.14.dox diff --git a/doxygen/dox/sw_changes_2.x.dox b/docs/doxygen/dox/sw_changes_2.x.dox similarity index 100% rename from doxygen/dox/sw_changes_2.x.dox rename to docs/doxygen/dox/sw_changes_2.x.dox diff --git a/doxygen/dox/threadsafety-warning.dox b/docs/doxygen/dox/threadsafety-warning.dox similarity index 100% rename from doxygen/dox/threadsafety-warning.dox rename to docs/doxygen/dox/threadsafety-warning.dox diff --git a/doxygen/doxygen-awesome-tabs.js b/docs/doxygen/doxygen-awesome-tabs.js similarity index 100% rename from doxygen/doxygen-awesome-tabs.js rename to docs/doxygen/doxygen-awesome-tabs.js diff --git a/doxygen/doxygen-awesome.css b/docs/doxygen/doxygen-awesome.css similarity index 100% rename from doxygen/doxygen-awesome.css rename to docs/doxygen/doxygen-awesome.css diff --git a/doxygen/examples/FF-IH_FileGroup.gif b/docs/doxygen/examples/FF-IH_FileGroup.gif similarity index 100% rename from doxygen/examples/FF-IH_FileGroup.gif rename to docs/doxygen/examples/FF-IH_FileGroup.gif diff --git a/doxygen/examples/FF-IH_FileObject.gif b/docs/doxygen/examples/FF-IH_FileObject.gif similarity index 100% rename from doxygen/examples/FF-IH_FileObject.gif rename to docs/doxygen/examples/FF-IH_FileObject.gif diff --git a/doxygen/examples/FileFormatSpecChunkDiagram.jpg b/docs/doxygen/examples/FileFormatSpecChunkDiagram.jpg similarity index 100% rename from doxygen/examples/FileFormatSpecChunkDiagram.jpg rename to docs/doxygen/examples/FileFormatSpecChunkDiagram.jpg diff --git a/doxygen/examples/H5A_examples.c b/docs/doxygen/examples/H5A_examples.c similarity index 100% rename from doxygen/examples/H5A_examples.c rename to docs/doxygen/examples/H5A_examples.c diff --git a/doxygen/examples/H5DO_examples.c b/docs/doxygen/examples/H5DO_examples.c similarity index 100% rename from doxygen/examples/H5DO_examples.c rename to docs/doxygen/examples/H5DO_examples.c diff --git a/doxygen/examples/H5D_examples.c b/docs/doxygen/examples/H5D_examples.c similarity index 100% rename from doxygen/examples/H5D_examples.c rename to docs/doxygen/examples/H5D_examples.c diff --git a/doxygen/examples/H5E_examples.c b/docs/doxygen/examples/H5E_examples.c similarity index 100% rename from doxygen/examples/H5E_examples.c rename to docs/doxygen/examples/H5E_examples.c diff --git a/doxygen/examples/H5F_examples.c b/docs/doxygen/examples/H5F_examples.c similarity index 100% rename from doxygen/examples/H5F_examples.c rename to docs/doxygen/examples/H5F_examples.c diff --git a/doxygen/examples/H5Fclose.c b/docs/doxygen/examples/H5Fclose.c similarity index 100% rename from doxygen/examples/H5Fclose.c rename to docs/doxygen/examples/H5Fclose.c diff --git a/doxygen/examples/H5Fcreate.c b/docs/doxygen/examples/H5Fcreate.c similarity index 100% rename from doxygen/examples/H5Fcreate.c rename to docs/doxygen/examples/H5Fcreate.c diff --git a/doxygen/examples/H5G_examples.c b/docs/doxygen/examples/H5G_examples.c similarity index 100% rename from doxygen/examples/H5G_examples.c rename to docs/doxygen/examples/H5G_examples.c diff --git a/doxygen/examples/H5I_examples.c b/docs/doxygen/examples/H5I_examples.c similarity index 100% rename from doxygen/examples/H5I_examples.c rename to docs/doxygen/examples/H5I_examples.c diff --git a/doxygen/examples/H5LDget_dset_elmts.c b/docs/doxygen/examples/H5LDget_dset_elmts.c similarity index 100% rename from doxygen/examples/H5LDget_dset_elmts.c rename to docs/doxygen/examples/H5LDget_dset_elmts.c diff --git a/doxygen/examples/H5LT_examples.c b/docs/doxygen/examples/H5LT_examples.c similarity index 100% rename from doxygen/examples/H5LT_examples.c rename to docs/doxygen/examples/H5LT_examples.c diff --git a/doxygen/examples/H5L_examples.c b/docs/doxygen/examples/H5L_examples.c similarity index 100% rename from doxygen/examples/H5L_examples.c rename to docs/doxygen/examples/H5L_examples.c diff --git a/doxygen/examples/H5O_examples.c b/docs/doxygen/examples/H5O_examples.c similarity index 100% rename from doxygen/examples/H5O_examples.c rename to docs/doxygen/examples/H5O_examples.c diff --git a/doxygen/examples/H5PL_examples.c b/docs/doxygen/examples/H5PL_examples.c similarity index 100% rename from doxygen/examples/H5PL_examples.c rename to docs/doxygen/examples/H5PL_examples.c diff --git a/doxygen/examples/H5P_examples.c b/docs/doxygen/examples/H5P_examples.c similarity index 100% rename from doxygen/examples/H5P_examples.c rename to docs/doxygen/examples/H5P_examples.c diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.1.c b/docs/doxygen/examples/H5Pget_metadata_read_attempts.1.c similarity index 100% rename from doxygen/examples/H5Pget_metadata_read_attempts.1.c rename to docs/doxygen/examples/H5Pget_metadata_read_attempts.1.c diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.2.c b/docs/doxygen/examples/H5Pget_metadata_read_attempts.2.c similarity index 100% rename from doxygen/examples/H5Pget_metadata_read_attempts.2.c rename to docs/doxygen/examples/H5Pget_metadata_read_attempts.2.c diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.3.c b/docs/doxygen/examples/H5Pget_metadata_read_attempts.3.c similarity index 100% rename from doxygen/examples/H5Pget_metadata_read_attempts.3.c rename to docs/doxygen/examples/H5Pget_metadata_read_attempts.3.c diff --git a/doxygen/examples/H5Pget_object_flush_cb.c b/docs/doxygen/examples/H5Pget_object_flush_cb.c similarity index 100% rename from doxygen/examples/H5Pget_object_flush_cb.c rename to docs/doxygen/examples/H5Pget_object_flush_cb.c diff --git a/doxygen/examples/H5Pset_metadata_read_attempts.c b/docs/doxygen/examples/H5Pset_metadata_read_attempts.c similarity index 100% rename from doxygen/examples/H5Pset_metadata_read_attempts.c rename to docs/doxygen/examples/H5Pset_metadata_read_attempts.c diff --git a/doxygen/examples/H5Pset_object_flush_cb.c b/docs/doxygen/examples/H5Pset_object_flush_cb.c similarity index 100% rename from doxygen/examples/H5Pset_object_flush_cb.c rename to docs/doxygen/examples/H5Pset_object_flush_cb.c diff --git a/doxygen/examples/H5R_examples.c b/docs/doxygen/examples/H5R_examples.c similarity index 100% rename from doxygen/examples/H5R_examples.c rename to docs/doxygen/examples/H5R_examples.c diff --git a/doxygen/examples/H5S_examples.c b/docs/doxygen/examples/H5S_examples.c similarity index 100% rename from doxygen/examples/H5S_examples.c rename to docs/doxygen/examples/H5S_examples.c diff --git a/doxygen/examples/H5TBAget_fill.c b/docs/doxygen/examples/H5TBAget_fill.c similarity index 100% rename from doxygen/examples/H5TBAget_fill.c rename to docs/doxygen/examples/H5TBAget_fill.c diff --git a/doxygen/examples/H5T_examples.c b/docs/doxygen/examples/H5T_examples.c similarity index 100% rename from doxygen/examples/H5T_examples.c rename to docs/doxygen/examples/H5T_examples.c diff --git a/doxygen/examples/H5Z_examples.c b/docs/doxygen/examples/H5Z_examples.c similarity index 100% rename from doxygen/examples/H5Z_examples.c rename to docs/doxygen/examples/H5Z_examples.c diff --git a/doxygen/examples/H5_examples.c b/docs/doxygen/examples/H5_examples.c similarity index 100% rename from doxygen/examples/H5_examples.c rename to docs/doxygen/examples/H5_examples.c diff --git a/doxygen/examples/PaletteExample1.gif b/docs/doxygen/examples/PaletteExample1.gif similarity index 100% rename from doxygen/examples/PaletteExample1.gif rename to docs/doxygen/examples/PaletteExample1.gif diff --git a/doxygen/examples/Palettes.fm.anc.gif b/docs/doxygen/examples/Palettes.fm.anc.gif similarity index 100% rename from doxygen/examples/Palettes.fm.anc.gif rename to docs/doxygen/examples/Palettes.fm.anc.gif diff --git a/doxygen/examples/h5_attribute.c b/docs/doxygen/examples/h5_attribute.c similarity index 100% rename from doxygen/examples/h5_attribute.c rename to docs/doxygen/examples/h5_attribute.c diff --git a/doxygen/examples/h5_extlink.c b/docs/doxygen/examples/h5_extlink.c similarity index 100% rename from doxygen/examples/h5_extlink.c rename to docs/doxygen/examples/h5_extlink.c diff --git a/doxygen/examples/hello_hdf5.c b/docs/doxygen/examples/hello_hdf5.c similarity index 100% rename from doxygen/examples/hello_hdf5.c rename to docs/doxygen/examples/hello_hdf5.c diff --git a/doxygen/examples/menus/core_menu.md b/docs/doxygen/examples/menus/core_menu.md similarity index 100% rename from doxygen/examples/menus/core_menu.md rename to docs/doxygen/examples/menus/core_menu.md diff --git a/doxygen/examples/menus/fortran_menu.md b/docs/doxygen/examples/menus/fortran_menu.md similarity index 100% rename from doxygen/examples/menus/fortran_menu.md rename to docs/doxygen/examples/menus/fortran_menu.md diff --git a/doxygen/examples/menus/high_level_menu.md b/docs/doxygen/examples/menus/high_level_menu.md similarity index 100% rename from doxygen/examples/menus/high_level_menu.md rename to docs/doxygen/examples/menus/high_level_menu.md diff --git a/doxygen/examples/menus/java_menu.md b/docs/doxygen/examples/menus/java_menu.md similarity index 100% rename from doxygen/examples/menus/java_menu.md rename to docs/doxygen/examples/menus/java_menu.md diff --git a/doxygen/examples/tables/fileDriverLists.dox b/docs/doxygen/examples/tables/fileDriverLists.dox similarity index 100% rename from doxygen/examples/tables/fileDriverLists.dox rename to docs/doxygen/examples/tables/fileDriverLists.dox diff --git a/doxygen/examples/tables/predefinedDatatypes.dox b/docs/doxygen/examples/tables/predefinedDatatypes.dox similarity index 100% rename from doxygen/examples/tables/predefinedDatatypes.dox rename to docs/doxygen/examples/tables/predefinedDatatypes.dox diff --git a/doxygen/examples/tables/propertyLists.dox b/docs/doxygen/examples/tables/propertyLists.dox similarity index 100% rename from doxygen/examples/tables/propertyLists.dox rename to docs/doxygen/examples/tables/propertyLists.dox diff --git a/doxygen/examples/tables/volAPIs.dox b/docs/doxygen/examples/tables/volAPIs.dox similarity index 100% rename from doxygen/examples/tables/volAPIs.dox rename to docs/doxygen/examples/tables/volAPIs.dox diff --git a/doxygen/hdf5_footer.html b/docs/doxygen/hdf5_footer.html similarity index 100% rename from doxygen/hdf5_footer.html rename to docs/doxygen/hdf5_footer.html diff --git a/doxygen/hdf5_header.html b/docs/doxygen/hdf5_header.html similarity index 100% rename from doxygen/hdf5_header.html rename to docs/doxygen/hdf5_header.html diff --git a/doxygen/hdf5_navtree_hacks.js b/docs/doxygen/hdf5_navtree_hacks.js similarity index 100% rename from doxygen/hdf5_navtree_hacks.js rename to docs/doxygen/hdf5_navtree_hacks.js diff --git a/doxygen/hdf5doxy.css b/docs/doxygen/hdf5doxy.css similarity index 100% rename from doxygen/hdf5doxy.css rename to docs/doxygen/hdf5doxy.css diff --git a/doxygen/hdf5doxy_layout.xml b/docs/doxygen/hdf5doxy_layout.xml similarity index 100% rename from doxygen/hdf5doxy_layout.xml rename to docs/doxygen/hdf5doxy_layout.xml diff --git a/doxygen/img/Chunk_f1.gif b/docs/doxygen/img/Chunk_f1.gif similarity index 100% rename from doxygen/img/Chunk_f1.gif rename to docs/doxygen/img/Chunk_f1.gif diff --git a/doxygen/img/Chunk_f2.gif b/docs/doxygen/img/Chunk_f2.gif similarity index 100% rename from doxygen/img/Chunk_f2.gif rename to docs/doxygen/img/Chunk_f2.gif diff --git a/doxygen/img/Chunk_f3.gif b/docs/doxygen/img/Chunk_f3.gif similarity index 100% rename from doxygen/img/Chunk_f3.gif rename to docs/doxygen/img/Chunk_f3.gif diff --git a/doxygen/img/Chunk_f4.gif b/docs/doxygen/img/Chunk_f4.gif similarity index 100% rename from doxygen/img/Chunk_f4.gif rename to docs/doxygen/img/Chunk_f4.gif diff --git a/doxygen/img/Chunk_f5.gif b/docs/doxygen/img/Chunk_f5.gif similarity index 100% rename from doxygen/img/Chunk_f5.gif rename to docs/doxygen/img/Chunk_f5.gif diff --git a/doxygen/img/Chunk_f6.gif b/docs/doxygen/img/Chunk_f6.gif similarity index 100% rename from doxygen/img/Chunk_f6.gif rename to docs/doxygen/img/Chunk_f6.gif diff --git a/doxygen/img/DOChunks_fig1.png b/docs/doxygen/img/DOChunks_fig1.png similarity index 100% rename from doxygen/img/DOChunks_fig1.png rename to docs/doxygen/img/DOChunks_fig1.png diff --git a/doxygen/img/DOChunks_fig2.png b/docs/doxygen/img/DOChunks_fig2.png similarity index 100% rename from doxygen/img/DOChunks_fig2.png rename to docs/doxygen/img/DOChunks_fig2.png diff --git a/doxygen/img/DataGroup.png b/docs/doxygen/img/DataGroup.png similarity index 100% rename from doxygen/img/DataGroup.png rename to docs/doxygen/img/DataGroup.png diff --git a/doxygen/img/Dmodel_fig1.gif b/docs/doxygen/img/Dmodel_fig1.gif similarity index 100% rename from doxygen/img/Dmodel_fig1.gif rename to docs/doxygen/img/Dmodel_fig1.gif diff --git a/doxygen/img/Dmodel_fig10.gif b/docs/doxygen/img/Dmodel_fig10.gif similarity index 100% rename from doxygen/img/Dmodel_fig10.gif rename to docs/doxygen/img/Dmodel_fig10.gif diff --git a/doxygen/img/Dmodel_fig11_b.gif b/docs/doxygen/img/Dmodel_fig11_b.gif similarity index 100% rename from doxygen/img/Dmodel_fig11_b.gif rename to docs/doxygen/img/Dmodel_fig11_b.gif diff --git a/doxygen/img/Dmodel_fig12_a.gif b/docs/doxygen/img/Dmodel_fig12_a.gif similarity index 100% rename from doxygen/img/Dmodel_fig12_a.gif rename to docs/doxygen/img/Dmodel_fig12_a.gif diff --git a/doxygen/img/Dmodel_fig12_b.gif b/docs/doxygen/img/Dmodel_fig12_b.gif similarity index 100% rename from doxygen/img/Dmodel_fig12_b.gif rename to docs/doxygen/img/Dmodel_fig12_b.gif diff --git a/doxygen/img/Dmodel_fig14_a.gif b/docs/doxygen/img/Dmodel_fig14_a.gif similarity index 100% rename from doxygen/img/Dmodel_fig14_a.gif rename to docs/doxygen/img/Dmodel_fig14_a.gif diff --git a/doxygen/img/Dmodel_fig14_b.gif b/docs/doxygen/img/Dmodel_fig14_b.gif similarity index 100% rename from doxygen/img/Dmodel_fig14_b.gif rename to docs/doxygen/img/Dmodel_fig14_b.gif diff --git a/doxygen/img/Dmodel_fig14_c.gif b/docs/doxygen/img/Dmodel_fig14_c.gif similarity index 100% rename from doxygen/img/Dmodel_fig14_c.gif rename to docs/doxygen/img/Dmodel_fig14_c.gif diff --git a/doxygen/img/Dmodel_fig14_d.gif b/docs/doxygen/img/Dmodel_fig14_d.gif similarity index 100% rename from doxygen/img/Dmodel_fig14_d.gif rename to docs/doxygen/img/Dmodel_fig14_d.gif diff --git a/doxygen/img/Dmodel_fig2.gif b/docs/doxygen/img/Dmodel_fig2.gif similarity index 100% rename from doxygen/img/Dmodel_fig2.gif rename to docs/doxygen/img/Dmodel_fig2.gif diff --git a/doxygen/img/Dmodel_fig3_a.gif b/docs/doxygen/img/Dmodel_fig3_a.gif similarity index 100% rename from doxygen/img/Dmodel_fig3_a.gif rename to docs/doxygen/img/Dmodel_fig3_a.gif diff --git a/doxygen/img/Dmodel_fig3_c.gif b/docs/doxygen/img/Dmodel_fig3_c.gif similarity index 100% rename from doxygen/img/Dmodel_fig3_c.gif rename to docs/doxygen/img/Dmodel_fig3_c.gif diff --git a/doxygen/img/Dmodel_fig4_a.gif b/docs/doxygen/img/Dmodel_fig4_a.gif similarity index 100% rename from doxygen/img/Dmodel_fig4_a.gif rename to docs/doxygen/img/Dmodel_fig4_a.gif diff --git a/doxygen/img/Dmodel_fig4_b.gif b/docs/doxygen/img/Dmodel_fig4_b.gif similarity index 100% rename from doxygen/img/Dmodel_fig4_b.gif rename to docs/doxygen/img/Dmodel_fig4_b.gif diff --git a/doxygen/img/Dmodel_fig5.gif b/docs/doxygen/img/Dmodel_fig5.gif similarity index 100% rename from doxygen/img/Dmodel_fig5.gif rename to docs/doxygen/img/Dmodel_fig5.gif diff --git a/doxygen/img/Dmodel_fig6.gif b/docs/doxygen/img/Dmodel_fig6.gif similarity index 100% rename from doxygen/img/Dmodel_fig6.gif rename to docs/doxygen/img/Dmodel_fig6.gif diff --git a/doxygen/img/Dmodel_fig7_b.gif b/docs/doxygen/img/Dmodel_fig7_b.gif similarity index 100% rename from doxygen/img/Dmodel_fig7_b.gif rename to docs/doxygen/img/Dmodel_fig7_b.gif diff --git a/doxygen/img/Dmodel_fig8.gif b/docs/doxygen/img/Dmodel_fig8.gif similarity index 100% rename from doxygen/img/Dmodel_fig8.gif rename to docs/doxygen/img/Dmodel_fig8.gif diff --git a/doxygen/img/Dmodel_fig9.gif b/docs/doxygen/img/Dmodel_fig9.gif similarity index 100% rename from doxygen/img/Dmodel_fig9.gif rename to docs/doxygen/img/Dmodel_fig9.gif diff --git a/doxygen/img/Dsets_NbitFloating1.gif b/docs/doxygen/img/Dsets_NbitFloating1.gif similarity index 100% rename from doxygen/img/Dsets_NbitFloating1.gif rename to docs/doxygen/img/Dsets_NbitFloating1.gif diff --git a/doxygen/img/Dsets_NbitFloating2.gif b/docs/doxygen/img/Dsets_NbitFloating2.gif similarity index 100% rename from doxygen/img/Dsets_NbitFloating2.gif rename to docs/doxygen/img/Dsets_NbitFloating2.gif diff --git a/doxygen/img/Dsets_NbitInteger1.gif b/docs/doxygen/img/Dsets_NbitInteger1.gif similarity index 100% rename from doxygen/img/Dsets_NbitInteger1.gif rename to docs/doxygen/img/Dsets_NbitInteger1.gif diff --git a/doxygen/img/Dsets_NbitInteger2.gif b/docs/doxygen/img/Dsets_NbitInteger2.gif similarity index 100% rename from doxygen/img/Dsets_NbitInteger2.gif rename to docs/doxygen/img/Dsets_NbitInteger2.gif diff --git a/doxygen/img/Dsets_fig1.gif b/docs/doxygen/img/Dsets_fig1.gif similarity index 100% rename from doxygen/img/Dsets_fig1.gif rename to docs/doxygen/img/Dsets_fig1.gif diff --git a/doxygen/img/Dsets_fig10.gif b/docs/doxygen/img/Dsets_fig10.gif similarity index 100% rename from doxygen/img/Dsets_fig10.gif rename to docs/doxygen/img/Dsets_fig10.gif diff --git a/doxygen/img/Dsets_fig11.gif b/docs/doxygen/img/Dsets_fig11.gif similarity index 100% rename from doxygen/img/Dsets_fig11.gif rename to docs/doxygen/img/Dsets_fig11.gif diff --git a/doxygen/img/Dsets_fig12.gif b/docs/doxygen/img/Dsets_fig12.gif similarity index 100% rename from doxygen/img/Dsets_fig12.gif rename to docs/doxygen/img/Dsets_fig12.gif diff --git a/doxygen/img/Dsets_fig2.gif b/docs/doxygen/img/Dsets_fig2.gif similarity index 100% rename from doxygen/img/Dsets_fig2.gif rename to docs/doxygen/img/Dsets_fig2.gif diff --git a/doxygen/img/Dsets_fig3.gif b/docs/doxygen/img/Dsets_fig3.gif similarity index 100% rename from doxygen/img/Dsets_fig3.gif rename to docs/doxygen/img/Dsets_fig3.gif diff --git a/doxygen/img/Dsets_fig4.gif b/docs/doxygen/img/Dsets_fig4.gif similarity index 100% rename from doxygen/img/Dsets_fig4.gif rename to docs/doxygen/img/Dsets_fig4.gif diff --git a/doxygen/img/Dsets_fig5.gif b/docs/doxygen/img/Dsets_fig5.gif similarity index 100% rename from doxygen/img/Dsets_fig5.gif rename to docs/doxygen/img/Dsets_fig5.gif diff --git a/doxygen/img/Dsets_fig6.gif b/docs/doxygen/img/Dsets_fig6.gif similarity index 100% rename from doxygen/img/Dsets_fig6.gif rename to docs/doxygen/img/Dsets_fig6.gif diff --git a/doxygen/img/Dsets_fig7.gif b/docs/doxygen/img/Dsets_fig7.gif similarity index 100% rename from doxygen/img/Dsets_fig7.gif rename to docs/doxygen/img/Dsets_fig7.gif diff --git a/doxygen/img/Dsets_fig8.gif b/docs/doxygen/img/Dsets_fig8.gif similarity index 100% rename from doxygen/img/Dsets_fig8.gif rename to docs/doxygen/img/Dsets_fig8.gif diff --git a/doxygen/img/Dsets_fig9.gif b/docs/doxygen/img/Dsets_fig9.gif similarity index 100% rename from doxygen/img/Dsets_fig9.gif rename to docs/doxygen/img/Dsets_fig9.gif diff --git a/doxygen/img/Dspace_CvsF1.gif b/docs/doxygen/img/Dspace_CvsF1.gif similarity index 100% rename from doxygen/img/Dspace_CvsF1.gif rename to docs/doxygen/img/Dspace_CvsF1.gif diff --git a/doxygen/img/Dspace_CvsF2.gif b/docs/doxygen/img/Dspace_CvsF2.gif similarity index 100% rename from doxygen/img/Dspace_CvsF2.gif rename to docs/doxygen/img/Dspace_CvsF2.gif diff --git a/doxygen/img/Dspace_CvsF3.gif b/docs/doxygen/img/Dspace_CvsF3.gif similarity index 100% rename from doxygen/img/Dspace_CvsF3.gif rename to docs/doxygen/img/Dspace_CvsF3.gif diff --git a/doxygen/img/Dspace_CvsF4.gif b/docs/doxygen/img/Dspace_CvsF4.gif similarity index 100% rename from doxygen/img/Dspace_CvsF4.gif rename to docs/doxygen/img/Dspace_CvsF4.gif diff --git a/doxygen/img/Dspace_combine.gif b/docs/doxygen/img/Dspace_combine.gif similarity index 100% rename from doxygen/img/Dspace_combine.gif rename to docs/doxygen/img/Dspace_combine.gif diff --git a/doxygen/img/Dspace_complex.gif b/docs/doxygen/img/Dspace_complex.gif similarity index 100% rename from doxygen/img/Dspace_complex.gif rename to docs/doxygen/img/Dspace_complex.gif diff --git a/doxygen/img/Dspace_features.gif b/docs/doxygen/img/Dspace_features.gif similarity index 100% rename from doxygen/img/Dspace_features.gif rename to docs/doxygen/img/Dspace_features.gif diff --git a/doxygen/img/Dspace_features_cmpd.gif b/docs/doxygen/img/Dspace_features_cmpd.gif similarity index 100% rename from doxygen/img/Dspace_features_cmpd.gif rename to docs/doxygen/img/Dspace_features_cmpd.gif diff --git a/doxygen/img/Dspace_move.gif b/docs/doxygen/img/Dspace_move.gif similarity index 100% rename from doxygen/img/Dspace_move.gif rename to docs/doxygen/img/Dspace_move.gif diff --git a/doxygen/img/Dspace_point.gif b/docs/doxygen/img/Dspace_point.gif similarity index 100% rename from doxygen/img/Dspace_point.gif rename to docs/doxygen/img/Dspace_point.gif diff --git a/doxygen/img/Dspace_read.gif b/docs/doxygen/img/Dspace_read.gif similarity index 100% rename from doxygen/img/Dspace_read.gif rename to docs/doxygen/img/Dspace_read.gif diff --git a/doxygen/img/Dspace_select.gif b/docs/doxygen/img/Dspace_select.gif similarity index 100% rename from doxygen/img/Dspace_select.gif rename to docs/doxygen/img/Dspace_select.gif diff --git a/doxygen/img/Dspace_separate.gif b/docs/doxygen/img/Dspace_separate.gif similarity index 100% rename from doxygen/img/Dspace_separate.gif rename to docs/doxygen/img/Dspace_separate.gif diff --git a/doxygen/img/Dspace_simple.gif b/docs/doxygen/img/Dspace_simple.gif similarity index 100% rename from doxygen/img/Dspace_simple.gif rename to docs/doxygen/img/Dspace_simple.gif diff --git a/doxygen/img/Dspace_subset.gif b/docs/doxygen/img/Dspace_subset.gif similarity index 100% rename from doxygen/img/Dspace_subset.gif rename to docs/doxygen/img/Dspace_subset.gif diff --git a/doxygen/img/Dspace_three_datasets.gif b/docs/doxygen/img/Dspace_three_datasets.gif similarity index 100% rename from doxygen/img/Dspace_three_datasets.gif rename to docs/doxygen/img/Dspace_three_datasets.gif diff --git a/doxygen/img/Dspace_transfer.gif b/docs/doxygen/img/Dspace_transfer.gif similarity index 100% rename from doxygen/img/Dspace_transfer.gif rename to docs/doxygen/img/Dspace_transfer.gif diff --git a/doxygen/img/Dspace_write1to2.gif b/docs/doxygen/img/Dspace_write1to2.gif similarity index 100% rename from doxygen/img/Dspace_write1to2.gif rename to docs/doxygen/img/Dspace_write1to2.gif diff --git a/doxygen/img/Dtypes_fig1.gif b/docs/doxygen/img/Dtypes_fig1.gif similarity index 100% rename from doxygen/img/Dtypes_fig1.gif rename to docs/doxygen/img/Dtypes_fig1.gif diff --git a/doxygen/img/Dtypes_fig10.gif b/docs/doxygen/img/Dtypes_fig10.gif similarity index 100% rename from doxygen/img/Dtypes_fig10.gif rename to docs/doxygen/img/Dtypes_fig10.gif diff --git a/doxygen/img/Dtypes_fig11.gif b/docs/doxygen/img/Dtypes_fig11.gif similarity index 100% rename from doxygen/img/Dtypes_fig11.gif rename to docs/doxygen/img/Dtypes_fig11.gif diff --git a/doxygen/img/Dtypes_fig12.gif b/docs/doxygen/img/Dtypes_fig12.gif similarity index 100% rename from doxygen/img/Dtypes_fig12.gif rename to docs/doxygen/img/Dtypes_fig12.gif diff --git a/doxygen/img/Dtypes_fig13a.gif b/docs/doxygen/img/Dtypes_fig13a.gif similarity index 100% rename from doxygen/img/Dtypes_fig13a.gif rename to docs/doxygen/img/Dtypes_fig13a.gif diff --git a/doxygen/img/Dtypes_fig13b.gif b/docs/doxygen/img/Dtypes_fig13b.gif similarity index 100% rename from doxygen/img/Dtypes_fig13b.gif rename to docs/doxygen/img/Dtypes_fig13b.gif diff --git a/doxygen/img/Dtypes_fig13c.gif b/docs/doxygen/img/Dtypes_fig13c.gif similarity index 100% rename from doxygen/img/Dtypes_fig13c.gif rename to docs/doxygen/img/Dtypes_fig13c.gif diff --git a/doxygen/img/Dtypes_fig13d.gif b/docs/doxygen/img/Dtypes_fig13d.gif similarity index 100% rename from doxygen/img/Dtypes_fig13d.gif rename to docs/doxygen/img/Dtypes_fig13d.gif diff --git a/doxygen/img/Dtypes_fig14.gif b/docs/doxygen/img/Dtypes_fig14.gif similarity index 100% rename from doxygen/img/Dtypes_fig14.gif rename to docs/doxygen/img/Dtypes_fig14.gif diff --git a/doxygen/img/Dtypes_fig15.gif b/docs/doxygen/img/Dtypes_fig15.gif similarity index 100% rename from doxygen/img/Dtypes_fig15.gif rename to docs/doxygen/img/Dtypes_fig15.gif diff --git a/doxygen/img/Dtypes_fig16.gif b/docs/doxygen/img/Dtypes_fig16.gif similarity index 100% rename from doxygen/img/Dtypes_fig16.gif rename to docs/doxygen/img/Dtypes_fig16.gif diff --git a/doxygen/img/Dtypes_fig16a.gif b/docs/doxygen/img/Dtypes_fig16a.gif similarity index 100% rename from doxygen/img/Dtypes_fig16a.gif rename to docs/doxygen/img/Dtypes_fig16a.gif diff --git a/doxygen/img/Dtypes_fig16b.gif b/docs/doxygen/img/Dtypes_fig16b.gif similarity index 100% rename from doxygen/img/Dtypes_fig16b.gif rename to docs/doxygen/img/Dtypes_fig16b.gif diff --git a/doxygen/img/Dtypes_fig16c.gif b/docs/doxygen/img/Dtypes_fig16c.gif similarity index 100% rename from doxygen/img/Dtypes_fig16c.gif rename to docs/doxygen/img/Dtypes_fig16c.gif diff --git a/doxygen/img/Dtypes_fig16d.gif b/docs/doxygen/img/Dtypes_fig16d.gif similarity index 100% rename from doxygen/img/Dtypes_fig16d.gif rename to docs/doxygen/img/Dtypes_fig16d.gif diff --git a/doxygen/img/Dtypes_fig17a.gif b/docs/doxygen/img/Dtypes_fig17a.gif similarity index 100% rename from doxygen/img/Dtypes_fig17a.gif rename to docs/doxygen/img/Dtypes_fig17a.gif diff --git a/doxygen/img/Dtypes_fig17b.gif b/docs/doxygen/img/Dtypes_fig17b.gif similarity index 100% rename from doxygen/img/Dtypes_fig17b.gif rename to docs/doxygen/img/Dtypes_fig17b.gif diff --git a/doxygen/img/Dtypes_fig18.gif b/docs/doxygen/img/Dtypes_fig18.gif similarity index 100% rename from doxygen/img/Dtypes_fig18.gif rename to docs/doxygen/img/Dtypes_fig18.gif diff --git a/doxygen/img/Dtypes_fig19.gif b/docs/doxygen/img/Dtypes_fig19.gif similarity index 100% rename from doxygen/img/Dtypes_fig19.gif rename to docs/doxygen/img/Dtypes_fig19.gif diff --git a/doxygen/img/Dtypes_fig2.gif b/docs/doxygen/img/Dtypes_fig2.gif similarity index 100% rename from doxygen/img/Dtypes_fig2.gif rename to docs/doxygen/img/Dtypes_fig2.gif diff --git a/doxygen/img/Dtypes_fig20a.gif b/docs/doxygen/img/Dtypes_fig20a.gif similarity index 100% rename from doxygen/img/Dtypes_fig20a.gif rename to docs/doxygen/img/Dtypes_fig20a.gif diff --git a/doxygen/img/Dtypes_fig20b.gif b/docs/doxygen/img/Dtypes_fig20b.gif similarity index 100% rename from doxygen/img/Dtypes_fig20b.gif rename to docs/doxygen/img/Dtypes_fig20b.gif diff --git a/doxygen/img/Dtypes_fig20c.gif b/docs/doxygen/img/Dtypes_fig20c.gif similarity index 100% rename from doxygen/img/Dtypes_fig20c.gif rename to docs/doxygen/img/Dtypes_fig20c.gif diff --git a/doxygen/img/Dtypes_fig20d.gif b/docs/doxygen/img/Dtypes_fig20d.gif similarity index 100% rename from doxygen/img/Dtypes_fig20d.gif rename to docs/doxygen/img/Dtypes_fig20d.gif diff --git a/doxygen/img/Dtypes_fig21.gif b/docs/doxygen/img/Dtypes_fig21.gif similarity index 100% rename from doxygen/img/Dtypes_fig21.gif rename to docs/doxygen/img/Dtypes_fig21.gif diff --git a/doxygen/img/Dtypes_fig22.gif b/docs/doxygen/img/Dtypes_fig22.gif similarity index 100% rename from doxygen/img/Dtypes_fig22.gif rename to docs/doxygen/img/Dtypes_fig22.gif diff --git a/doxygen/img/Dtypes_fig23.gif b/docs/doxygen/img/Dtypes_fig23.gif similarity index 100% rename from doxygen/img/Dtypes_fig23.gif rename to docs/doxygen/img/Dtypes_fig23.gif diff --git a/doxygen/img/Dtypes_fig24.gif b/docs/doxygen/img/Dtypes_fig24.gif similarity index 100% rename from doxygen/img/Dtypes_fig24.gif rename to docs/doxygen/img/Dtypes_fig24.gif diff --git a/doxygen/img/Dtypes_fig25a.gif b/docs/doxygen/img/Dtypes_fig25a.gif similarity index 100% rename from doxygen/img/Dtypes_fig25a.gif rename to docs/doxygen/img/Dtypes_fig25a.gif diff --git a/doxygen/img/Dtypes_fig25c.gif b/docs/doxygen/img/Dtypes_fig25c.gif similarity index 100% rename from doxygen/img/Dtypes_fig25c.gif rename to docs/doxygen/img/Dtypes_fig25c.gif diff --git a/doxygen/img/Dtypes_fig26.gif b/docs/doxygen/img/Dtypes_fig26.gif similarity index 100% rename from doxygen/img/Dtypes_fig26.gif rename to docs/doxygen/img/Dtypes_fig26.gif diff --git a/doxygen/img/Dtypes_fig27.gif b/docs/doxygen/img/Dtypes_fig27.gif similarity index 100% rename from doxygen/img/Dtypes_fig27.gif rename to docs/doxygen/img/Dtypes_fig27.gif diff --git a/doxygen/img/Dtypes_fig28.gif b/docs/doxygen/img/Dtypes_fig28.gif similarity index 100% rename from doxygen/img/Dtypes_fig28.gif rename to docs/doxygen/img/Dtypes_fig28.gif diff --git a/doxygen/img/Dtypes_fig3.gif b/docs/doxygen/img/Dtypes_fig3.gif similarity index 100% rename from doxygen/img/Dtypes_fig3.gif rename to docs/doxygen/img/Dtypes_fig3.gif diff --git a/doxygen/img/Dtypes_fig4.gif b/docs/doxygen/img/Dtypes_fig4.gif similarity index 100% rename from doxygen/img/Dtypes_fig4.gif rename to docs/doxygen/img/Dtypes_fig4.gif diff --git a/doxygen/img/Dtypes_fig5.gif b/docs/doxygen/img/Dtypes_fig5.gif similarity index 100% rename from doxygen/img/Dtypes_fig5.gif rename to docs/doxygen/img/Dtypes_fig5.gif diff --git a/doxygen/img/Dtypes_fig6.gif b/docs/doxygen/img/Dtypes_fig6.gif similarity index 100% rename from doxygen/img/Dtypes_fig6.gif rename to docs/doxygen/img/Dtypes_fig6.gif diff --git a/doxygen/img/Dtypes_fig7.gif b/docs/doxygen/img/Dtypes_fig7.gif similarity index 100% rename from doxygen/img/Dtypes_fig7.gif rename to docs/doxygen/img/Dtypes_fig7.gif diff --git a/doxygen/img/Dtypes_fig8.gif b/docs/doxygen/img/Dtypes_fig8.gif similarity index 100% rename from doxygen/img/Dtypes_fig8.gif rename to docs/doxygen/img/Dtypes_fig8.gif diff --git a/doxygen/img/Dtypes_fig9.gif b/docs/doxygen/img/Dtypes_fig9.gif similarity index 100% rename from doxygen/img/Dtypes_fig9.gif rename to docs/doxygen/img/Dtypes_fig9.gif diff --git a/doxygen/img/FF-IH_FileGroup.gif b/docs/doxygen/img/FF-IH_FileGroup.gif similarity index 100% rename from doxygen/img/FF-IH_FileGroup.gif rename to docs/doxygen/img/FF-IH_FileGroup.gif diff --git a/doxygen/img/FF-IH_FileObject.gif b/docs/doxygen/img/FF-IH_FileObject.gif similarity index 100% rename from doxygen/img/FF-IH_FileObject.gif rename to docs/doxygen/img/FF-IH_FileObject.gif diff --git a/doxygen/img/FileFormatSpecChunkDiagram.jpg b/docs/doxygen/img/FileFormatSpecChunkDiagram.jpg similarity index 100% rename from doxygen/img/FileFormatSpecChunkDiagram.jpg rename to docs/doxygen/img/FileFormatSpecChunkDiagram.jpg diff --git a/doxygen/img/Files_fig3.gif b/docs/doxygen/img/Files_fig3.gif similarity index 100% rename from doxygen/img/Files_fig3.gif rename to docs/doxygen/img/Files_fig3.gif diff --git a/doxygen/img/Files_fig4.gif b/docs/doxygen/img/Files_fig4.gif similarity index 100% rename from doxygen/img/Files_fig4.gif rename to docs/doxygen/img/Files_fig4.gif diff --git a/doxygen/img/FortBuildFlow.svg b/docs/doxygen/img/FortBuildFlow.svg similarity index 100% rename from doxygen/img/FortBuildFlow.svg rename to docs/doxygen/img/FortBuildFlow.svg diff --git a/doxygen/img/FreeingMemory_fig1.png b/docs/doxygen/img/FreeingMemory_fig1.png similarity index 100% rename from doxygen/img/FreeingMemory_fig1.png rename to docs/doxygen/img/FreeingMemory_fig1.png diff --git a/doxygen/img/Groups_fig1.gif b/docs/doxygen/img/Groups_fig1.gif similarity index 100% rename from doxygen/img/Groups_fig1.gif rename to docs/doxygen/img/Groups_fig1.gif diff --git a/doxygen/img/Groups_fig10_a.gif b/docs/doxygen/img/Groups_fig10_a.gif similarity index 100% rename from doxygen/img/Groups_fig10_a.gif rename to docs/doxygen/img/Groups_fig10_a.gif diff --git a/doxygen/img/Groups_fig10_b.gif b/docs/doxygen/img/Groups_fig10_b.gif similarity index 100% rename from doxygen/img/Groups_fig10_b.gif rename to docs/doxygen/img/Groups_fig10_b.gif diff --git a/doxygen/img/Groups_fig10_c.gif b/docs/doxygen/img/Groups_fig10_c.gif similarity index 100% rename from doxygen/img/Groups_fig10_c.gif rename to docs/doxygen/img/Groups_fig10_c.gif diff --git a/doxygen/img/Groups_fig10_d.gif b/docs/doxygen/img/Groups_fig10_d.gif similarity index 100% rename from doxygen/img/Groups_fig10_d.gif rename to docs/doxygen/img/Groups_fig10_d.gif diff --git a/doxygen/img/Groups_fig11_a.gif b/docs/doxygen/img/Groups_fig11_a.gif similarity index 100% rename from doxygen/img/Groups_fig11_a.gif rename to docs/doxygen/img/Groups_fig11_a.gif diff --git a/doxygen/img/Groups_fig11_b.gif b/docs/doxygen/img/Groups_fig11_b.gif similarity index 100% rename from doxygen/img/Groups_fig11_b.gif rename to docs/doxygen/img/Groups_fig11_b.gif diff --git a/doxygen/img/Groups_fig11_c.gif b/docs/doxygen/img/Groups_fig11_c.gif similarity index 100% rename from doxygen/img/Groups_fig11_c.gif rename to docs/doxygen/img/Groups_fig11_c.gif diff --git a/doxygen/img/Groups_fig11_d.gif b/docs/doxygen/img/Groups_fig11_d.gif similarity index 100% rename from doxygen/img/Groups_fig11_d.gif rename to docs/doxygen/img/Groups_fig11_d.gif diff --git a/doxygen/img/Groups_fig2.gif b/docs/doxygen/img/Groups_fig2.gif similarity index 100% rename from doxygen/img/Groups_fig2.gif rename to docs/doxygen/img/Groups_fig2.gif diff --git a/doxygen/img/Groups_fig3.gif b/docs/doxygen/img/Groups_fig3.gif similarity index 100% rename from doxygen/img/Groups_fig3.gif rename to docs/doxygen/img/Groups_fig3.gif diff --git a/doxygen/img/Groups_fig4.gif b/docs/doxygen/img/Groups_fig4.gif similarity index 100% rename from doxygen/img/Groups_fig4.gif rename to docs/doxygen/img/Groups_fig4.gif diff --git a/doxygen/img/Groups_fig5.gif b/docs/doxygen/img/Groups_fig5.gif similarity index 100% rename from doxygen/img/Groups_fig5.gif rename to docs/doxygen/img/Groups_fig5.gif diff --git a/doxygen/img/Groups_fig6.gif b/docs/doxygen/img/Groups_fig6.gif similarity index 100% rename from doxygen/img/Groups_fig6.gif rename to docs/doxygen/img/Groups_fig6.gif diff --git a/doxygen/img/Groups_fig9_a.gif b/docs/doxygen/img/Groups_fig9_a.gif similarity index 100% rename from doxygen/img/Groups_fig9_a.gif rename to docs/doxygen/img/Groups_fig9_a.gif diff --git a/doxygen/img/Groups_fig9_aa.gif b/docs/doxygen/img/Groups_fig9_aa.gif similarity index 100% rename from doxygen/img/Groups_fig9_aa.gif rename to docs/doxygen/img/Groups_fig9_aa.gif diff --git a/doxygen/img/Groups_fig9_b.gif b/docs/doxygen/img/Groups_fig9_b.gif similarity index 100% rename from doxygen/img/Groups_fig9_b.gif rename to docs/doxygen/img/Groups_fig9_b.gif diff --git a/doxygen/img/Groups_fig9_bb.gif b/docs/doxygen/img/Groups_fig9_bb.gif similarity index 100% rename from doxygen/img/Groups_fig9_bb.gif rename to docs/doxygen/img/Groups_fig9_bb.gif diff --git a/doxygen/img/H5DS_fig1.png b/docs/doxygen/img/H5DS_fig1.png similarity index 100% rename from doxygen/img/H5DS_fig1.png rename to docs/doxygen/img/H5DS_fig1.png diff --git a/doxygen/img/H5DS_fig2.png b/docs/doxygen/img/H5DS_fig2.png similarity index 100% rename from doxygen/img/H5DS_fig2.png rename to docs/doxygen/img/H5DS_fig2.png diff --git a/doxygen/img/H5DS_fig3.png b/docs/doxygen/img/H5DS_fig3.png similarity index 100% rename from doxygen/img/H5DS_fig3.png rename to docs/doxygen/img/H5DS_fig3.png diff --git a/doxygen/img/H5DS_fig4.png b/docs/doxygen/img/H5DS_fig4.png similarity index 100% rename from doxygen/img/H5DS_fig4.png rename to docs/doxygen/img/H5DS_fig4.png diff --git a/doxygen/img/H5DS_fig5.png b/docs/doxygen/img/H5DS_fig5.png similarity index 100% rename from doxygen/img/H5DS_fig5.png rename to docs/doxygen/img/H5DS_fig5.png diff --git a/doxygen/img/HDF5.png b/docs/doxygen/img/HDF5.png similarity index 100% rename from doxygen/img/HDF5.png rename to docs/doxygen/img/HDF5.png diff --git a/doxygen/img/HDFG-logo.png b/docs/doxygen/img/HDFG-logo.png similarity index 100% rename from doxygen/img/HDFG-logo.png rename to docs/doxygen/img/HDFG-logo.png diff --git a/doxygen/img/IOFlow.gif b/docs/doxygen/img/IOFlow.gif similarity index 100% rename from doxygen/img/IOFlow.gif rename to docs/doxygen/img/IOFlow.gif diff --git a/doxygen/img/IOFlow2.gif b/docs/doxygen/img/IOFlow2.gif similarity index 100% rename from doxygen/img/IOFlow2.gif rename to docs/doxygen/img/IOFlow2.gif diff --git a/doxygen/img/IOFlow3.gif b/docs/doxygen/img/IOFlow3.gif similarity index 100% rename from doxygen/img/IOFlow3.gif rename to docs/doxygen/img/IOFlow3.gif diff --git a/doxygen/img/LBDsetSubRWProg.png b/docs/doxygen/img/LBDsetSubRWProg.png similarity index 100% rename from doxygen/img/LBDsetSubRWProg.png rename to docs/doxygen/img/LBDsetSubRWProg.png diff --git a/doxygen/img/PaletteExample1.gif b/docs/doxygen/img/PaletteExample1.gif similarity index 100% rename from doxygen/img/PaletteExample1.gif rename to docs/doxygen/img/PaletteExample1.gif diff --git a/doxygen/img/Palettes_fm_anc.gif b/docs/doxygen/img/Palettes_fm_anc.gif similarity index 100% rename from doxygen/img/Palettes_fm_anc.gif rename to docs/doxygen/img/Palettes_fm_anc.gif diff --git a/doxygen/img/Pmodel_fig2.gif b/docs/doxygen/img/Pmodel_fig2.gif similarity index 100% rename from doxygen/img/Pmodel_fig2.gif rename to docs/doxygen/img/Pmodel_fig2.gif diff --git a/doxygen/img/Pmodel_fig3.gif b/docs/doxygen/img/Pmodel_fig3.gif similarity index 100% rename from doxygen/img/Pmodel_fig3.gif rename to docs/doxygen/img/Pmodel_fig3.gif diff --git a/doxygen/img/Pmodel_fig5_a.gif b/docs/doxygen/img/Pmodel_fig5_a.gif similarity index 100% rename from doxygen/img/Pmodel_fig5_a.gif rename to docs/doxygen/img/Pmodel_fig5_a.gif diff --git a/doxygen/img/Pmodel_fig5_b.gif b/docs/doxygen/img/Pmodel_fig5_b.gif similarity index 100% rename from doxygen/img/Pmodel_fig5_b.gif rename to docs/doxygen/img/Pmodel_fig5_b.gif diff --git a/doxygen/img/Pmodel_fig5_c.gif b/docs/doxygen/img/Pmodel_fig5_c.gif similarity index 100% rename from doxygen/img/Pmodel_fig5_c.gif rename to docs/doxygen/img/Pmodel_fig5_c.gif diff --git a/doxygen/img/Pmodel_fig5_d.gif b/docs/doxygen/img/Pmodel_fig5_d.gif similarity index 100% rename from doxygen/img/Pmodel_fig5_d.gif rename to docs/doxygen/img/Pmodel_fig5_d.gif diff --git a/doxygen/img/Pmodel_fig5_e.gif b/docs/doxygen/img/Pmodel_fig5_e.gif similarity index 100% rename from doxygen/img/Pmodel_fig5_e.gif rename to docs/doxygen/img/Pmodel_fig5_e.gif diff --git a/doxygen/img/Pmodel_fig6.gif b/docs/doxygen/img/Pmodel_fig6.gif similarity index 100% rename from doxygen/img/Pmodel_fig6.gif rename to docs/doxygen/img/Pmodel_fig6.gif diff --git a/doxygen/img/PropListClassInheritance.gif b/docs/doxygen/img/PropListClassInheritance.gif similarity index 100% rename from doxygen/img/PropListClassInheritance.gif rename to docs/doxygen/img/PropListClassInheritance.gif diff --git a/doxygen/img/PropListEcosystem.gif b/docs/doxygen/img/PropListEcosystem.gif similarity index 100% rename from doxygen/img/PropListEcosystem.gif rename to docs/doxygen/img/PropListEcosystem.gif diff --git a/doxygen/img/Shared_Attribute.jpg b/docs/doxygen/img/Shared_Attribute.jpg similarity index 100% rename from doxygen/img/Shared_Attribute.jpg rename to docs/doxygen/img/Shared_Attribute.jpg diff --git a/doxygen/img/StormDataset.png b/docs/doxygen/img/StormDataset.png similarity index 100% rename from doxygen/img/StormDataset.png rename to docs/doxygen/img/StormDataset.png diff --git a/doxygen/img/UML_Attribute.jpg b/docs/doxygen/img/UML_Attribute.jpg similarity index 100% rename from doxygen/img/UML_Attribute.jpg rename to docs/doxygen/img/UML_Attribute.jpg diff --git a/doxygen/img/UML_FileAndProps.gif b/docs/doxygen/img/UML_FileAndProps.gif similarity index 100% rename from doxygen/img/UML_FileAndProps.gif rename to docs/doxygen/img/UML_FileAndProps.gif diff --git a/doxygen/img/VFL_Drivers.gif b/docs/doxygen/img/VFL_Drivers.gif similarity index 100% rename from doxygen/img/VFL_Drivers.gif rename to docs/doxygen/img/VFL_Drivers.gif diff --git a/doxygen/img/cgns.png b/docs/doxygen/img/cgns.png similarity index 100% rename from doxygen/img/cgns.png rename to docs/doxygen/img/cgns.png diff --git a/doxygen/img/chunking1and2.png b/docs/doxygen/img/chunking1and2.png similarity index 100% rename from doxygen/img/chunking1and2.png rename to docs/doxygen/img/chunking1and2.png diff --git a/doxygen/img/chunking3and4.png b/docs/doxygen/img/chunking3and4.png similarity index 100% rename from doxygen/img/chunking3and4.png rename to docs/doxygen/img/chunking3and4.png diff --git a/doxygen/img/chunking5.png b/docs/doxygen/img/chunking5.png similarity index 100% rename from doxygen/img/chunking5.png rename to docs/doxygen/img/chunking5.png diff --git a/doxygen/img/chunking6.png b/docs/doxygen/img/chunking6.png similarity index 100% rename from doxygen/img/chunking6.png rename to docs/doxygen/img/chunking6.png diff --git a/doxygen/img/chunking7.png b/docs/doxygen/img/chunking7.png similarity index 100% rename from doxygen/img/chunking7.png rename to docs/doxygen/img/chunking7.png diff --git a/doxygen/img/chunking8.png b/docs/doxygen/img/chunking8.png similarity index 100% rename from doxygen/img/chunking8.png rename to docs/doxygen/img/chunking8.png diff --git a/doxygen/img/cmpnddtype.png b/docs/doxygen/img/cmpnddtype.png similarity index 100% rename from doxygen/img/cmpnddtype.png rename to docs/doxygen/img/cmpnddtype.png diff --git a/doxygen/img/crtatt.png b/docs/doxygen/img/crtatt.png similarity index 100% rename from doxygen/img/crtatt.png rename to docs/doxygen/img/crtatt.png diff --git a/doxygen/img/crtdset.png b/docs/doxygen/img/crtdset.png similarity index 100% rename from doxygen/img/crtdset.png rename to docs/doxygen/img/crtdset.png diff --git a/doxygen/img/crtf-pic.png b/docs/doxygen/img/crtf-pic.png similarity index 100% rename from doxygen/img/crtf-pic.png rename to docs/doxygen/img/crtf-pic.png diff --git a/doxygen/img/crtgrp.png b/docs/doxygen/img/crtgrp.png similarity index 100% rename from doxygen/img/crtgrp.png rename to docs/doxygen/img/crtgrp.png diff --git a/doxygen/img/dataset.png b/docs/doxygen/img/dataset.png similarity index 100% rename from doxygen/img/dataset.png rename to docs/doxygen/img/dataset.png diff --git a/doxygen/img/datasetwdata.png b/docs/doxygen/img/datasetwdata.png similarity index 100% rename from doxygen/img/datasetwdata.png rename to docs/doxygen/img/datasetwdata.png diff --git a/doxygen/img/dataspace.png b/docs/doxygen/img/dataspace.png similarity index 100% rename from doxygen/img/dataspace.png rename to docs/doxygen/img/dataspace.png diff --git a/doxygen/img/dataspace1.png b/docs/doxygen/img/dataspace1.png similarity index 100% rename from doxygen/img/dataspace1.png rename to docs/doxygen/img/dataspace1.png diff --git a/doxygen/img/datatype.png b/docs/doxygen/img/datatype.png similarity index 100% rename from doxygen/img/datatype.png rename to docs/doxygen/img/datatype.png diff --git a/doxygen/img/dtypes_fig25b.gif b/docs/doxygen/img/dtypes_fig25b.gif similarity index 100% rename from doxygen/img/dtypes_fig25b.gif rename to docs/doxygen/img/dtypes_fig25b.gif diff --git a/doxygen/img/fileobj.png b/docs/doxygen/img/fileobj.png similarity index 100% rename from doxygen/img/fileobj.png rename to docs/doxygen/img/fileobj.png diff --git a/doxygen/img/ftv2node.png b/docs/doxygen/img/ftv2node.png similarity index 100% rename from doxygen/img/ftv2node.png rename to docs/doxygen/img/ftv2node.png diff --git a/doxygen/img/ftv2pnode.png b/docs/doxygen/img/ftv2pnode.png similarity index 100% rename from doxygen/img/ftv2pnode.png rename to docs/doxygen/img/ftv2pnode.png diff --git a/doxygen/img/group.png b/docs/doxygen/img/group.png similarity index 100% rename from doxygen/img/group.png rename to docs/doxygen/img/group.png diff --git a/doxygen/img/hdfview-anthrstrm-img.png b/docs/doxygen/img/hdfview-anthrstrm-img.png similarity index 100% rename from doxygen/img/hdfview-anthrstrm-img.png rename to docs/doxygen/img/hdfview-anthrstrm-img.png diff --git a/doxygen/img/hdfview-anthrstrm-sprdsht.png b/docs/doxygen/img/hdfview-anthrstrm-sprdsht.png similarity index 100% rename from doxygen/img/hdfview-anthrstrm-sprdsht.png rename to docs/doxygen/img/hdfview-anthrstrm-sprdsht.png diff --git a/doxygen/img/hdfview-anthrstrm.png b/docs/doxygen/img/hdfview-anthrstrm.png similarity index 100% rename from doxygen/img/hdfview-anthrstrm.png rename to docs/doxygen/img/hdfview-anthrstrm.png diff --git a/doxygen/img/hdfview-imgicon.png b/docs/doxygen/img/hdfview-imgicon.png similarity index 100% rename from doxygen/img/hdfview-imgicon.png rename to docs/doxygen/img/hdfview-imgicon.png diff --git a/doxygen/img/hdfview-imgprop.png b/docs/doxygen/img/hdfview-imgprop.png similarity index 100% rename from doxygen/img/hdfview-imgprop.png rename to docs/doxygen/img/hdfview-imgprop.png diff --git a/doxygen/img/hdfview-imgsubset.png b/docs/doxygen/img/hdfview-imgsubset.png similarity index 100% rename from doxygen/img/hdfview-imgsubset.png rename to docs/doxygen/img/hdfview-imgsubset.png diff --git a/doxygen/img/hdfview-newcmpd.png b/docs/doxygen/img/hdfview-newcmpd.png similarity index 100% rename from doxygen/img/hdfview-newcmpd.png rename to docs/doxygen/img/hdfview-newcmpd.png diff --git a/doxygen/img/hdfview-newimgsubset.png b/docs/doxygen/img/hdfview-newimgsubset.png similarity index 100% rename from doxygen/img/hdfview-newimgsubset.png rename to docs/doxygen/img/hdfview-newimgsubset.png diff --git a/doxygen/img/hdfview-prop.png b/docs/doxygen/img/hdfview-prop.png similarity index 100% rename from doxygen/img/hdfview-prop.png rename to docs/doxygen/img/hdfview-prop.png diff --git a/doxygen/img/hdfview-qf.png b/docs/doxygen/img/hdfview-qf.png similarity index 100% rename from doxygen/img/hdfview-qf.png rename to docs/doxygen/img/hdfview-qf.png diff --git a/doxygen/img/hdfview-regref.png b/docs/doxygen/img/hdfview-regref.png similarity index 100% rename from doxygen/img/hdfview-regref.png rename to docs/doxygen/img/hdfview-regref.png diff --git a/doxygen/img/hdfview-regref1.png b/docs/doxygen/img/hdfview-regref1.png similarity index 100% rename from doxygen/img/hdfview-regref1.png rename to docs/doxygen/img/hdfview-regref1.png diff --git a/doxygen/img/hdfview-regref2.png b/docs/doxygen/img/hdfview-regref2.png similarity index 100% rename from doxygen/img/hdfview-regref2.png rename to docs/doxygen/img/hdfview-regref2.png diff --git a/doxygen/img/hdfview-regrefval.png b/docs/doxygen/img/hdfview-regrefval.png similarity index 100% rename from doxygen/img/hdfview-regrefval.png rename to docs/doxygen/img/hdfview-regrefval.png diff --git a/doxygen/img/hdfview-table.png b/docs/doxygen/img/hdfview-table.png similarity index 100% rename from doxygen/img/hdfview-table.png rename to docs/doxygen/img/hdfview-table.png diff --git a/doxygen/img/hdfview-tree.png b/docs/doxygen/img/hdfview-tree.png similarity index 100% rename from doxygen/img/hdfview-tree.png rename to docs/doxygen/img/hdfview-tree.png diff --git a/doxygen/img/images_to_copy.dox b/docs/doxygen/img/images_to_copy.dox similarity index 100% rename from doxygen/img/images_to_copy.dox rename to docs/doxygen/img/images_to_copy.dox diff --git a/doxygen/img/imgLBDsetCreate.gif b/docs/doxygen/img/imgLBDsetCreate.gif similarity index 100% rename from doxygen/img/imgLBDsetCreate.gif rename to docs/doxygen/img/imgLBDsetCreate.gif diff --git a/doxygen/img/imgLBDsetSubRW11.png b/docs/doxygen/img/imgLBDsetSubRW11.png similarity index 100% rename from doxygen/img/imgLBDsetSubRW11.png rename to docs/doxygen/img/imgLBDsetSubRW11.png diff --git a/doxygen/img/imgLBDsetSubRW12.png b/docs/doxygen/img/imgLBDsetSubRW12.png similarity index 100% rename from doxygen/img/imgLBDsetSubRW12.png rename to docs/doxygen/img/imgLBDsetSubRW12.png diff --git a/doxygen/img/imgLBDsetSubRW31.png b/docs/doxygen/img/imgLBDsetSubRW31.png similarity index 100% rename from doxygen/img/imgLBDsetSubRW31.png rename to docs/doxygen/img/imgLBDsetSubRW31.png diff --git a/doxygen/img/imgLBDsetSubRW32.png b/docs/doxygen/img/imgLBDsetSubRW32.png similarity index 100% rename from doxygen/img/imgLBDsetSubRW32.png rename to docs/doxygen/img/imgLBDsetSubRW32.png diff --git a/doxygen/img/imgLBDsetSubRW33.png b/docs/doxygen/img/imgLBDsetSubRW33.png similarity index 100% rename from doxygen/img/imgLBDsetSubRW33.png rename to docs/doxygen/img/imgLBDsetSubRW33.png diff --git a/doxygen/img/imgLBFile.gif b/docs/doxygen/img/imgLBFile.gif similarity index 100% rename from doxygen/img/imgLBFile.gif rename to docs/doxygen/img/imgLBFile.gif diff --git a/doxygen/img/imggrpcreate.gif b/docs/doxygen/img/imggrpcreate.gif similarity index 100% rename from doxygen/img/imggrpcreate.gif rename to docs/doxygen/img/imggrpcreate.gif diff --git a/doxygen/img/imggrpdsets.gif b/docs/doxygen/img/imggrpdsets.gif similarity index 100% rename from doxygen/img/imggrpdsets.gif rename to docs/doxygen/img/imggrpdsets.gif diff --git a/doxygen/img/imggrps.gif b/docs/doxygen/img/imggrps.gif similarity index 100% rename from doxygen/img/imggrps.gif rename to docs/doxygen/img/imggrps.gif diff --git a/doxygen/img/improve_perf-compress_fig_1.png b/docs/doxygen/img/improve_perf-compress_fig_1.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_1.png rename to docs/doxygen/img/improve_perf-compress_fig_1.png diff --git a/doxygen/img/improve_perf-compress_fig_2.png b/docs/doxygen/img/improve_perf-compress_fig_2.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_2.png rename to docs/doxygen/img/improve_perf-compress_fig_2.png diff --git a/doxygen/img/improve_perf-compress_fig_3.png b/docs/doxygen/img/improve_perf-compress_fig_3.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_3.png rename to docs/doxygen/img/improve_perf-compress_fig_3.png diff --git a/doxygen/img/improve_perf-compress_fig_6.png b/docs/doxygen/img/improve_perf-compress_fig_6.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_6.png rename to docs/doxygen/img/improve_perf-compress_fig_6.png diff --git a/doxygen/img/improve_perf-compress_fig_7.png b/docs/doxygen/img/improve_perf-compress_fig_7.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_7.png rename to docs/doxygen/img/improve_perf-compress_fig_7.png diff --git a/doxygen/img/improve_perf-compress_fig_8.png b/docs/doxygen/img/improve_perf-compress_fig_8.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_8.png rename to docs/doxygen/img/improve_perf-compress_fig_8.png diff --git a/doxygen/img/improve_perf-compress_fig_9.png b/docs/doxygen/img/improve_perf-compress_fig_9.png similarity index 100% rename from doxygen/img/improve_perf-compress_fig_9.png rename to docs/doxygen/img/improve_perf-compress_fig_9.png diff --git a/doxygen/img/modregwrite.png b/docs/doxygen/img/modregwrite.png similarity index 100% rename from doxygen/img/modregwrite.png rename to docs/doxygen/img/modregwrite.png diff --git a/doxygen/img/newgroupimage.png b/docs/doxygen/img/newgroupimage.png similarity index 100% rename from doxygen/img/newgroupimage.png rename to docs/doxygen/img/newgroupimage.png diff --git a/doxygen/img/noattrs.png b/docs/doxygen/img/noattrs.png similarity index 100% rename from doxygen/img/noattrs.png rename to docs/doxygen/img/noattrs.png diff --git a/doxygen/img/pchunk_figa.gif b/docs/doxygen/img/pchunk_figa.gif similarity index 100% rename from doxygen/img/pchunk_figa.gif rename to docs/doxygen/img/pchunk_figa.gif diff --git a/doxygen/img/pchunk_figb.gif b/docs/doxygen/img/pchunk_figb.gif similarity index 100% rename from doxygen/img/pchunk_figb.gif rename to docs/doxygen/img/pchunk_figb.gif diff --git a/doxygen/img/pchunk_figc.gif b/docs/doxygen/img/pchunk_figc.gif similarity index 100% rename from doxygen/img/pchunk_figc.gif rename to docs/doxygen/img/pchunk_figc.gif diff --git a/doxygen/img/pchunk_figd.gif b/docs/doxygen/img/pchunk_figd.gif similarity index 100% rename from doxygen/img/pchunk_figd.gif rename to docs/doxygen/img/pchunk_figd.gif diff --git a/doxygen/img/pcont_hy_figa.gif b/docs/doxygen/img/pcont_hy_figa.gif similarity index 100% rename from doxygen/img/pcont_hy_figa.gif rename to docs/doxygen/img/pcont_hy_figa.gif diff --git a/doxygen/img/pcont_hy_figb.gif b/docs/doxygen/img/pcont_hy_figb.gif similarity index 100% rename from doxygen/img/pcont_hy_figb.gif rename to docs/doxygen/img/pcont_hy_figb.gif diff --git a/doxygen/img/pcont_hy_figc.gif b/docs/doxygen/img/pcont_hy_figc.gif similarity index 100% rename from doxygen/img/pcont_hy_figc.gif rename to docs/doxygen/img/pcont_hy_figc.gif diff --git a/doxygen/img/pcont_hy_figd.gif b/docs/doxygen/img/pcont_hy_figd.gif similarity index 100% rename from doxygen/img/pcont_hy_figd.gif rename to docs/doxygen/img/pcont_hy_figd.gif diff --git a/doxygen/img/pimplayer.gif b/docs/doxygen/img/pimplayer.gif similarity index 100% rename from doxygen/img/pimplayer.gif rename to docs/doxygen/img/pimplayer.gif diff --git a/doxygen/img/ppatt_figa.gif b/docs/doxygen/img/ppatt_figa.gif similarity index 100% rename from doxygen/img/ppatt_figa.gif rename to docs/doxygen/img/ppatt_figa.gif diff --git a/doxygen/img/ppatt_figb.gif b/docs/doxygen/img/ppatt_figb.gif similarity index 100% rename from doxygen/img/ppatt_figb.gif rename to docs/doxygen/img/ppatt_figb.gif diff --git a/doxygen/img/ppatt_figc.gif b/docs/doxygen/img/ppatt_figc.gif similarity index 100% rename from doxygen/img/ppatt_figc.gif rename to docs/doxygen/img/ppatt_figc.gif diff --git a/doxygen/img/ppatt_figd.gif b/docs/doxygen/img/ppatt_figd.gif similarity index 100% rename from doxygen/img/ppatt_figd.gif rename to docs/doxygen/img/ppatt_figd.gif diff --git a/doxygen/img/preg_figa.gif b/docs/doxygen/img/preg_figa.gif similarity index 100% rename from doxygen/img/preg_figa.gif rename to docs/doxygen/img/preg_figa.gif diff --git a/doxygen/img/preg_figb.gif b/docs/doxygen/img/preg_figb.gif similarity index 100% rename from doxygen/img/preg_figb.gif rename to docs/doxygen/img/preg_figb.gif diff --git a/doxygen/img/preg_figc.gif b/docs/doxygen/img/preg_figc.gif similarity index 100% rename from doxygen/img/preg_figc.gif rename to docs/doxygen/img/preg_figc.gif diff --git a/doxygen/img/preg_figd.gif b/docs/doxygen/img/preg_figd.gif similarity index 100% rename from doxygen/img/preg_figd.gif rename to docs/doxygen/img/preg_figd.gif diff --git a/doxygen/img/properties.png b/docs/doxygen/img/properties.png similarity index 100% rename from doxygen/img/properties.png rename to docs/doxygen/img/properties.png diff --git a/doxygen/img/scarletletter.png b/docs/doxygen/img/scarletletter.png similarity index 100% rename from doxygen/img/scarletletter.png rename to docs/doxygen/img/scarletletter.png diff --git a/doxygen/img/showasimage.png b/docs/doxygen/img/showasimage.png similarity index 100% rename from doxygen/img/showasimage.png rename to docs/doxygen/img/showasimage.png diff --git a/doxygen/img/storm.png b/docs/doxygen/img/storm.png similarity index 100% rename from doxygen/img/storm.png rename to docs/doxygen/img/storm.png diff --git a/doxygen/img/trunk_branches.jpg b/docs/doxygen/img/trunk_branches.jpg similarity index 100% rename from doxygen/img/trunk_branches.jpg rename to docs/doxygen/img/trunk_branches.jpg diff --git a/doxygen/img/tutr-lochk.png b/docs/doxygen/img/tutr-lochk.png similarity index 100% rename from doxygen/img/tutr-lochk.png rename to docs/doxygen/img/tutr-lochk.png diff --git a/doxygen/img/tutr-lochks.png b/docs/doxygen/img/tutr-lochks.png similarity index 100% rename from doxygen/img/tutr-lochks.png rename to docs/doxygen/img/tutr-lochks.png diff --git a/doxygen/img/tutr-locons.png b/docs/doxygen/img/tutr-locons.png similarity index 100% rename from doxygen/img/tutr-locons.png rename to docs/doxygen/img/tutr-locons.png diff --git a/doxygen/img/tutr-lodset.png b/docs/doxygen/img/tutr-lodset.png similarity index 100% rename from doxygen/img/tutr-lodset.png rename to docs/doxygen/img/tutr-lodset.png diff --git a/doxygen/img/tutr-swmr1.png b/docs/doxygen/img/tutr-swmr1.png similarity index 100% rename from doxygen/img/tutr-swmr1.png rename to docs/doxygen/img/tutr-swmr1.png diff --git a/doxygen/img/tutr-swmr2.png b/docs/doxygen/img/tutr-swmr2.png similarity index 100% rename from doxygen/img/tutr-swmr2.png rename to docs/doxygen/img/tutr-swmr2.png diff --git a/doxygen/img/tutr-swmr3.png b/docs/doxygen/img/tutr-swmr3.png similarity index 100% rename from doxygen/img/tutr-swmr3.png rename to docs/doxygen/img/tutr-swmr3.png diff --git a/doxygen/img/tutrvds-ex.png b/docs/doxygen/img/tutrvds-ex.png similarity index 100% rename from doxygen/img/tutrvds-ex.png rename to docs/doxygen/img/tutrvds-ex.png diff --git a/doxygen/img/tutrvds-map.png b/docs/doxygen/img/tutrvds-map.png similarity index 100% rename from doxygen/img/tutrvds-map.png rename to docs/doxygen/img/tutrvds-map.png diff --git a/doxygen/img/tutrvds-multimgs.png b/docs/doxygen/img/tutrvds-multimgs.png similarity index 100% rename from doxygen/img/tutrvds-multimgs.png rename to docs/doxygen/img/tutrvds-multimgs.png diff --git a/doxygen/img/tutrvds-snglimg.png b/docs/doxygen/img/tutrvds-snglimg.png similarity index 100% rename from doxygen/img/tutrvds-snglimg.png rename to docs/doxygen/img/tutrvds-snglimg.png diff --git a/doxygen/img/vol_architecture.png b/docs/doxygen/img/vol_architecture.png similarity index 100% rename from doxygen/img/vol_architecture.png rename to docs/doxygen/img/vol_architecture.png diff --git a/doxygen/img/writeLgNumDsets.png b/docs/doxygen/img/writeLgNumDsets.png similarity index 100% rename from doxygen/img/writeLgNumDsets.png rename to docs/doxygen/img/writeLgNumDsets.png diff --git a/release_docs/CHANGELOG.md b/release_docs/CHANGELOG.md index b88c4ec1e1b..95fe14bf818 100644 --- a/release_docs/CHANGELOG.md +++ b/release_docs/CHANGELOG.md @@ -64,6 +64,13 @@ We would like to thank the many HDF5 community members who contributed to this r ## Configuration +### Consolidated documentation under docs/ directory + + User-facing guides (installation, build instructions, platform-specific docs) and + Doxygen API documentation have been consolidated under a new top-level `docs/` + directory. All internal references (CMakeLists.txt, README.md, workflow files, + Doxygen sources, scripts, etc.) have been updated accordingly. + ### Updated external building of zlib, zlib-ng and libaec to not use a patching process When building these libraries from external sources while building HDF5, the library previously used a patching process to adapt the libraries to its own build process. The sources for these libraries are no longer patched and build directly from the sources of the latest upstream releases (currently, zlib 1.3.2, zlib-ng 2.3.3 and libaec 1.1.6). This also fixed an issue with the build of zlib-ng failing due to updates that were made since the last version that HDF5 was patching the sources for. diff --git a/release_docs/README.md b/release_docs/README.md index 65ab0f1d8a7..8a4d4800084 100644 --- a/release_docs/README.md +++ b/release_docs/README.md @@ -1,31 +1,18 @@ # The `release_docs` directory -## Intro +This directory contains **release artifacts only**: changelogs, version history, +release process documentation, and maintainer information. -This directory contains instructions for building and using the library as -well as the HDF5 history files. +User-facing guides (installation, build instructions, platform-specific docs) +have been moved to the [`docs/`](../docs/) directory. -## HISTORY files - -The `HISTORY` files contain the history of this branch of HDF5. They fall into -three categories. - -### HISTORY-\[VERSION 1\]-\[VERSION 2\].txt - -These files are created when we release a new major version and include all -the changes that were made to the `develop` branch while creating a major release. - -### HISTORY-\[VERSION\].txt - -This file contains the changes that were made to a maintenance branch since -it split off from `develop`. It will also be found in the `develop` branch -when experimental releases have been created. +## Contents ### CHANGELOG.md (formerly RELEASE.txt) This is the changelog for the current version of the library. -For a MAJOR release (or in `develop`) this files lists all the changes since the +For a MAJOR release (or in `develop`) this file lists all the changes since the last major version. For a MINOR release (or in a maintenance branch), this file lists all the changes since the last release in the maintenance branch. @@ -36,10 +23,34 @@ Examples: * The file in `develop` includes all the changes since the last major release * The file in `hdf5_1_14` includes all the changes since the last minor HDF5 1.14 release +### HISTORY files + +The `HISTORY` files contain the history of this branch of HDF5. They fall into +three categories. + +#### HISTORY-\[VERSION 1\]-\[VERSION 2\].txt + +These files are created when we release a new major version and include all +the changes that were made to the `develop` branch while creating a major release. + +#### HISTORY-\[VERSION\].txt + +This file contains the changes that were made to a maintenance branch since +it split off from `develop`. It will also be found in the `develop` branch +when experimental releases have been created. + Note that we make no effort to bring maintenance branch `HISTORY` files back to develop. If you want to compare, say, 1.10.4 with 1.12.3, you'd have to get the history files from those releases and compare them by hand. +### RELEASE_PROCESS.md + +Documentation for how releases are created and managed. + +### MAINTAINERS.md + +Maintainer information for the project. + ## Creating new releases ### MAJOR release @@ -90,82 +101,3 @@ In the maintenance branch: * Add the contents of `CHANGELOG.md` to the beginnnig of `HISTORY-\[VERSION\].txt` * Clear out `CHANGELOG.md` - -## INSTALL files - -These files include instructions for building and installing HDF5 on various -platforms. - -## USING files - -These files document how to build HDF5 applications with an installed HDF5 -library. - -## Java Examples Maven Integration - -The HDF5 Java examples are now integrated with Maven deployment to provide -complete example applications that work with HDF5 Java library Maven artifacts: - -### Maven Artifacts - -HDF5 provides two Java implementation artifacts: - -* **`org.hdfgroup:hdf5-java-ffm`** - FFM (Foreign Function & Memory) implementation - - Default for Java 25+, modern native access via Project Panama - - Platform-specific JARs: linux-x86_64, windows-x86_64, macos-x86_64, macos-aarch64 - -* **`org.hdfgroup:hdf5-java-jni`** - JNI (Java Native Interface) implementation - - Available for all Java versions (11+) - - Platform-specific JARs: linux-x86_64, windows-x86_64, macos-x86_64, macos-aarch64 - -* **`org.hdfgroup:hdf5-java-examples`** - Complete collection of 62 Java examples - - Platform-independent JAR with educational examples - - Covers all major HDF5 functionality: datasets, datatypes, groups, tutorials - - Compatible with both FFM and JNI implementations - -Both implementations use the same `hdf.hdf5lib.*` package structure for seamless migration. - -### FFM Test Suite - -**Running FFM Tests:** -```bash -ctest -R "JUnitFFM" -V # All FFM tests -ctest -R "JUnit-TestH5Affm" -V # Attribute tests -ctest -R "JUnit-TestH5Pffm" -V # Property tests -ctest -R "JUnit-TestH5Tffm" -V # Datatype tests -``` - -**Test Location:** `java/jtest/TestH5*ffm.java` - -### Features -* **Dual Implementation Support:** Choose FFM for modern Java or JNI for compatibility -* **Cross-Platform CI/CD:** Automated testing across all supported platforms -* **Fork-Based Testing:** Complete validation framework for testing on repository forks -* **Dynamic Repository Support:** Workflows adapt automatically to any GitHub repository -* **Maven Integration:** Seamless integration with standard Maven dependency management -* **Documentation:** See `HDF5Examples/JAVA/README-MAVEN.md` for complete usage instructions - -### GitHub Packages Deployment - -Using FFM implementation (Java 25+): -```xml - - org.hdfgroup - hdf5-java-ffm - 2.0.0-3 - linux-x86_64 - -``` - -Using JNI implementation (Java 11+): -```xml - - org.hdfgroup - hdf5-java-jni - 2.0.0-3 - linux-x86_64 - -``` - -The Java examples demonstrate proper usage of HDF5 Java bindings in real-world -scenarios and serve as templates for developing HDF5-based Java applications. diff --git a/release_docs/RELEASE_PROCESS.md b/release_docs/RELEASE_PROCESS.md index 2e2f618fdef..132e2a78f5f 100644 --- a/release_docs/RELEASE_PROCESS.md +++ b/release_docs/RELEASE_PROCESS.md @@ -220,8 +220,8 @@ For more information on the HDF5 versioning and backward and forward compatibili [u2]: https://github.com/HDFGroup/hdf5/blob/develop/README.md [u3]: https://github.com/HDFGroup/hdf5/blob/develop/LICENSE [u4]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs -[u5]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/INSTALL -[u7]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/INSTALL_CMake.md +[u5]: https://github.com/HDFGroup/hdf5/blob/develop/docs/INSTALL.md +[u7]: https://github.com/HDFGroup/hdf5/blob/develop/docs/INSTALL_CMake.md [u8]: https://github.com/HDFGroup/hdf5/blob/develop/.github/workflows/release.yml [u9]: https://github.com/HDFGroup/hdf5/blob/develop/config/lt_vers.am [u11]: https://github.com/HDFGroup/hdf5/blob/develop/src/H5public.h @@ -230,4 +230,4 @@ For more information on the HDF5 versioning and backward and forward compatibili [u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14 [u15]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot [u16]: https://github.com/HDFGroup/hdf5/wiki/HDF5-Version-Numbers-and-Branch-Strategy -[u17]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/USING_CMake_Examples.md +[u17]: https://github.com/HDFGroup/hdf5/blob/develop/docs/USING_CMake_Examples.md