Replace the RELEASE.txt file with CHANGELOG.md (#5778)

Author: loricooperhdf

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -4,5 +4,5 @@
 
 ## Checklist before requesting a review
 - [ ] My code conforms to the guidelines in CONTRIBUTING.md
-- [ ] I made an entry in release_docs/RELEASE.txt (bug fixes, new features)
+- [ ] I made an entry in release_docs/CHANGELOG.md (bug fixes, new features)
 - [ ] I added a test (bug fixes, new features)

CMakeInstallation.cmake

@@ -221,7 +221,7 @@ if (NOT HDF5_EXTERNALLY_CONFIGURED)
   if (EXISTS "${HDF5_SOURCE_DIR}/release_docs" AND IS_DIRECTORY "${HDF5_SOURCE_DIR}/release_docs")
     set (release_files
         ${HDF5_SOURCE_DIR}/release_docs/USING_HDF5_CMake.txt
-        ${HDF5_SOURCE_DIR}/release_docs/RELEASE.txt
+        ${HDF5_SOURCE_DIR}/release_docs/CHANGELOG.md
     )
     if (WIN32)
       set (release_files
@@ -279,8 +279,8 @@ if (NOT HDF5_EXTERNALLY_CONFIGURED AND NOT HDF5_NO_PACKAGES)
   set (CPACK_PACKAGE_VERSION_PATCH "")
   set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
   if (EXISTS "${HDF5_SOURCE_DIR}/release_docs")
-    set (CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/release_docs/RELEASE.txt")
-    set (CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/release_docs/RELEASE.txt")
+    set (CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/release_docs/CHANGELOG.md")
+    set (CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/release_docs/CHANGELOG.md")
   endif ()
   set (CPACK_PACKAGE_RELOCATABLE TRUE)
   if (OVERRIDE_INSTALL_VERSION)

CONTRIBUTING.md

@@ -252,7 +252,7 @@ For a pull request to be accepted, it must satisfy:
   - Machine independence (data readable across all platforms).
   - Binary compatibility for maintenance releases (no changes to public APIs/structures).
 * **Documentation:** New features must be properly documented. This includes using Doxygen
-    and providing information in release documents such as `RELEASE.txt`.
+    and providing information in release documents such as `CHANGELOG.md`.
 
 ### Branching Strategy
 
@@ -361,7 +361,7 @@ Before submitting your pull request, verify:
 - [ ] API changes follow compatibility guidelines.
 
 ### Documentation
-- [ ] Change described in `release_docs/RELEASE.txt`.
+- [ ] Change described in `release_docs/CHANGELOG.md`.
 - [ ] New functions documented with Doxygen in public headers.
 - [ ] New features documented for HDF5 community.
 

README.md

@@ -44,7 +44,7 @@ The latest documentation for the HDF5 library can be found at:
 
    https://support.hdfgroup.org/documentation/hdf5/latest
 
-See the [RELEASE.txt][u1] file in the [release_docs/][u4] directory for information specific
+See the [CHANGELOG.md][u1] file in the [release_docs/][u4] directory for information specific
 to the features and updates included in this release of the library.
 
 Several more files are located within the [release_docs/][u4] directory with specific
@@ -127,7 +127,7 @@ Development code is available at our Github location:
 
    https://github.com/HDFGroup/hdf5.git
 
-[u1]: https://github.com/HDFGroup/hdf5/blob/develop/release_docs/RELEASE.txt
+[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

doxygen/Doxyfile.in

@@ -808,6 +808,7 @@ EXCLUDE_PATTERNS       = */fortran/test/* \
                          */HDF5Examples/FORTRAN/* \
                          */sanitizer/* \
                          */CONTRIBUTING.md \
+                         */CHANGELOG.md \
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

release_docs/AutotoolsToCMakeOptions.md

@@ -1,3 +1,21 @@
+# <img src="Cmake_logo.svg" alt="Cmake logo" width=24> CMake Installations
+
+CMake produces the following set of folders; bin, include, lib and share. The LICENSE and RELEASE.txt file are placed in the share folder.
+
+The bin folder contains the tools and the build scripts. Additionally, CMake creates dynamic versions of the tools with the suffix "-shared".
+
+   ```
+   build scripts
+   /-------------
+   CMake: h5c++, h5cc, h5hlc++, h5hlcc
+   ```
+
+The include folder holds the header files and the fortran mod files. CMake places the fortran mod files into separate shared and static subfolders, however the use of `HDF5_INSTALL_MOD_FORTRAN` places one set of mod files into the include folder. Because CMake produces a tools library, the header files for tools will appear in the include folder.
+
+The lib folder contains the library files, and CMake adds the pkgconfig subfolder with the hdf5*.pc files used by the bin/build scripts created by the CMake build. CMake separates the C interface code from the fortran code by creating C-stub libraries for each Fortran library. In addition, only CMake installs the tools library. The names of the szip libraries are different between the build systems.
+
+CMake builds include a number of CMake specific files for support of CMake's find_package and support for the HDF5 Examples CMake project.
+
 # How To Convert Autotools Build Options to CMake Options
 
 ## Introduction