Remove references to autotools options in documentation/comments (#5619)

Author: byrnHDF

.github/workflows/README.md

@@ -38,7 +38,6 @@ There are a few that only get triggered manually.
     * release-files.yml uploads new binaries to releases page
 
 ## Triggered Workflows
-- autotools.yml
 - clang-format-check.yml runs clang-format and reports issues
 - cmake.yml
 - codespell.yml checks spelling
@@ -47,24 +46,6 @@ There are a few that only get triggered manually.
 - linkchecker.yml verifies the links in generated doxygen files
 - netcdf.yml configures and builds HDF5 then tests NetCDF
 
-## Workflows called by autotools.yml
-- main-auto-spc.yml configure, build, and test HDF5 with:
-    * API default v1_6
-    * API default v1_8
-    * API default v1_10
-    * API default v1_12
-    * API default v1_14
-    * using no deprecated
-    * in debug mode and -Werror compiler option
-    * in release mode and -Werror compiler option
-- main-auto-par-spc.yml configure, build, and test HDF5 with CFLAGS=-Werror
-- main-auto-par.yml configure, build, and test HDF5 with openmpi
-- main-auto.yml configure, build, and test HDF5
-- intel-auto.yml configure, build, and test HDF5 with Intel OneAPI on Linux and Windows
-- nvhpc-auto.yml configure, build, and test HDF5 with nvhpc
-- aocc-auto.yml configure, build, and test HDF5 with AOCC and OpenMPI
-- testxpr-auto.yml configure, build, and test HDF5 with HDF_TEST_EXPRESS=0
-
 ## Workflows called by cmake.yml
 - main-cmake-spc.yml configure, build, and test HDF5 with:
     * API default v1_6

config/ConfigureChecks.cmake

@@ -460,7 +460,7 @@ if (HDF5_ENABLE_USING_MEMCHECKER)
 endif ()
 
 #-----------------------------------------------------------------------------
-# Option for --enable-strict-format-checks
+# Option for strict file format checks
 #-----------------------------------------------------------------------------
 option (HDF5_STRICT_FORMAT_CHECKS "Whether to perform strict file format checks" OFF)
 mark_as_advanced (HDF5_STRICT_FORMAT_CHECKS)

config/flags/HDFCompilerCXXFlags.cmake

@@ -126,15 +126,13 @@ if (CMAKE_CXX_COMPILER_LOADED)
   endif ()
 
   #-----------------------------------------------------------------------------
-  # Option for --enable-profiling
   # This option will force/override the default setting for all configurations
   #-----------------------------------------------------------------------------
   if (HDF5_ENABLE_PROFILING)
     list (APPEND HDF5_CMAKE_CXX_FLAGS "${PROFILE_CXXFLAGS}")
   endif ()
 
   #-----------------------------------------------------------------------------
-  # Option for --enable-optimization
   # This option will force/override the default setting for all configurations
   #-----------------------------------------------------------------------------
   if (HDF5_ENABLE_OPTIMIZATION)

config/flags/HDFCompilerFlags.cmake

@@ -161,7 +161,6 @@ if (HDF5_ENABLE_ALL_WARNINGS)
 endif ()
 
 #-----------------------------------------------------------------------------
-# Option for --enable-asserts
 # By default, CMake adds NDEBUG to CMAKE_${lang}_FLAGS for Release build types
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
@@ -176,7 +175,6 @@ endif ()
 MARK_AS_ADVANCED (HDF5_ENABLE_ASSERTS)
 
 #-----------------------------------------------------------------------------
-# Option for --enable-symbols
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
 #option (HDF5_ENABLE_SYMBOLS "Add debug symbols to the library independent of the build mode and optimization level." OFF)
@@ -185,7 +183,6 @@ set_property (CACHE HDF5_ENABLE_SYMBOLS PROPERTY STRINGS OFF NO YES)
 MARK_AS_ADVANCED (HDF5_ENABLE_SYMBOLS)
 
 #-----------------------------------------------------------------------------
-# Option for --enable-profiling
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
 option (HDF5_ENABLE_PROFILING "Enable profiling flags independently from the build mode." OFF)
@@ -195,7 +192,6 @@ endif ()
 MARK_AS_ADVANCED (HDF5_ENABLE_PROFILING)
 
 #-----------------------------------------------------------------------------
-# Option for --enable-optimization
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
 option (HDF5_ENABLE_OPTIMIZATION "Enable optimization flags/settings independently from the build mode" OFF)

config/flags/HDFGnuCXXFlags.cmake

@@ -180,7 +180,6 @@ endif ()
   set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fmessage-length=0")
 
 #-----------------------------------------------------------------------------
-# Option for --enable-symbols
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
 if (HDF5_ENABLE_SYMBOLS MATCHES "YES")

config/flags/HDFGnuFlags.cmake

@@ -185,7 +185,6 @@ endif ()
   set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fmessage-length=0")
 
 #-----------------------------------------------------------------------------
-# Option for --enable-symbols
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
 if (HDF5_ENABLE_SYMBOLS MATCHES "YES")

config/flags/HDFIntelCXXFlags.cmake

@@ -81,7 +81,6 @@ if (HDF5_ENABLE_DEV_WARNINGS)
 endif ()
 
 #-----------------------------------------------------------------------------
-# Option for --enable-symbols
 # This option will force/override the default setting for all configurations
 #-----------------------------------------------------------------------------
 if (NOT _INTEL_WINDOWS)

doxygen/dox/HDF5CompressionTroubleshooting.dox

@@ -74,8 +74,7 @@ Everywhere in this document, the term \b szip refers to the \b szip filter and t
 
 \b gzip and \b szip require the \b libz.a(so,dylib,lib) and \b libsz.a(so,dylib,lib)/libaec.a(so,dylib,lib)
 libraries, respectively, to be present on the system and to be enabled during HDF5 configuration with
-this autotools configure command:
-CMake configure command:
+this CMake configure command:
 \code
     cmake -G "Unix Makefiles" -DHDF5_ENABLE_ZLIB_SUPPORT=ON -DHDF5_ENABLE_SZIP_SUPPORT=ON -D<other flags>
 \endcode

doxygen/dox/LearnBasics3.dox

@@ -731,7 +731,7 @@ Compiling applications to use the HDF5 Library can be as simple as executing:
 h5cc -o myprog myprog.c
 \endcode
 
-As an application's file base evolves, there are better solutions using autotools and makefiles or
+As an application's file base evolves, there are better solutions using
 CMake and CMakeLists.txt files. Many tutorials and references can be found with a simple search.
 
 This tutorial section will discuss the use of compile scripts on Linux.

doxygen/dox/ThreadSafe.dox

@@ -12,8 +12,7 @@ The following code is placed at the beginning of H5private.h:
 \endcode
 
 <code>H5_HAVE_THREADSAFE</code> is defined when the HDF5 library is
-compiled with the <em>--enable-threadsafe</em> configuration option using autotools or
-<em>HDF5_ENABLE_THREADSAFE=ON</em> using CMake. In general,
+compiled with the <em>HDF5_ENABLE_THREADSAFE=ON</em> using CMake. In general,
 code for the non-threadsafe version of HDF5 library are placed within
 the <code># else</code> part of the conditional compilation. The exception
 to this rule are the changes to the <code>FUNC_ENTER</code> (in

release_docs/AutotoolsToCMakeOptions.md

@@ -31,6 +31,7 @@ release_docs/INSTALL_CMake.txt file for more information on the CMake build syst
 | threads[Enable threads capability. A prerequisite for enabling threadsafe API calls.  [default=yes] | HDF5_THREADS_ENABLED "Enable thread support" [ON] |  |
 | threadsafe[Enable thread-safe capability. Not compatible with the high-level library, Fortran, or C++ wrappers.  [default=no]] | HDF5_ENABLE_THREADSAFE "Enable Threadsafety" [OFF] |  |
 | file-locking[Sets the default for whether or not to use file locking when opening files. [default=best-effort]] | HDF5_USE_FILE_LOCKING "Use file locking by default (mainly for SWMR)" [ON] | HDF5_IGNORE_DISABLED_FILE_LOCKS "Ignore file locks when disabled on file system" [ON] |
+| enable-concurrency[Support for concurrent multithreaded operation of supported API routines [default=no]] | HDF5_ENABLE_CONCURRENCY "Enable multi-threaded concurrency" [OFF] | This option also provides threadsafe execution of all other, non-concurrent operations. |
 
 | Autotools Language Options | CMake Language Options | Notes |
 | ------- |  ------- | ------------ |

release_docs/INSTALL_Cygwin.txt

@@ -130,7 +130,7 @@ Build, Test and Install HDF5 on Cygwin
 
    "make check" fails when building shared lib files is enabled.  The default
    on Cygwin has been changed to disable shared.  It can be enabled with
-   the --enable-shared configure option but is likely to fail "make check"
+   the BUILD_SHARED_LIBS configure option but is likely to fail "make check"
    with GCC compilers.
 
 -----------------------------------------------------------------------

release_docs/RELEASE.txt

@@ -39,7 +39,7 @@ CONTENTS
 - Bug Fixes since HDF5-2.0.0
 - Platforms Tested
 - Known Problems
-- CMake vs. Autotools installations
+- CMake Installations
 
 
 New Features
@@ -90,7 +90,6 @@ New Features
     - Added configuration option for API concurrency support:
 
           CMake:      HDF5_ENABLE_CONCURRENCY (ON/OFF) (Default: OFF)
-          Autotools:  --enable-concurrency    (yes/no) (Default: no)
 
       This option enables support for concurrent multithreaded operation
       of supported API routines.  This option also provides threadsafe
@@ -111,8 +110,8 @@ New Features
 
     - Added support for MinGW + MSYS2 when building with CMake
 
-      We previously added support for this to the Autotools and the appropriate
-      configure-time checks have been added to CMake.
+      We added support for this to the appropriate
+      configure-time checks in CMake.
 
       CMake + MinGW + MSYS2 is now tested with the following environments:
 
@@ -657,9 +656,6 @@ New Features
       repository in the future.
 
       This also removes the following configure options:
-
-        Autotools:  --(dis|en)able-hlgiftools
-
         CMake:      HDF5_BUILD_HL_GIF_TOOLS
 
     High-Level APIs:
@@ -846,12 +842,6 @@ Bug Fixes since HDF5-2.0.0 release
       find_package in config mode. The choice then is to either build szip, with libaec,
       inline or find a system installed szip library, built with CMake.
 
-    - Changed name of libhdf5hl_fortran installed by autotools to libhdf5_hl_fortran.  The 
-      new name is consistent with the name of the lib when installed by CMake and with the 
-      other hl libs.  
-
-      Fixes GitHub issue #4811
-
 
     Tools
     -----
@@ -950,14 +940,14 @@ Platforms Tested
     GNU/Linux Ubuntu 24.04           Ubuntu clang version 18.1.3 (1ubuntu1)
                                      Intel(R) oneAPI DPC++/C++ Compiler 2024.2.0
                                      ifx (IFX) 2024.2.0 20240602
-                                     (cmake and autotools)
+                                     (cmake )
 
     Linux 6.5.0-1018-aws             GNU gcc, gfortran, g++
     #18-Ubuntu SMP x86_64 GNU/Linux  (Ubuntu 11.4.0-1ubuntu1~22.04) 11.4.0
     Ubuntu 22.04                     Ubuntu clang version 14.0.0-1ubuntu1
                                      Intel(R) oneAPI DPC++/C++ Compiler 2024.0.2
                                      ifx (IFX) 2024.0.2 20231213
-                                     (cmake and autotools)
+                                     (cmake)
 
     Linux 5.14.21-cray_shasta_c      cray-mpich/8.1.28
     #1 SMP x86_64 GNU/Linux              cce/15.0.0
@@ -968,7 +958,7 @@ Platforms Tested
     #1 SMP x86_64 GNU/Linux          clang version 17.0.6
     Rocky 9                          Intel(R) oneAPI DPC++/C++ Compiler 2024.2.0
                                      ifx (IFX) 2024.2.0 
-                                     (cmake and autotools)
+                                     (cmake)
 
     Linux-4.18.0-553.16.1.1toss.t4   openmpi/4.1.2
     #1 SMP x86_64 GNU/Linux              clang 14.0.6
@@ -1020,7 +1010,7 @@ Platforms Tested
                                      x86_64;
                                          Versions 18.4.0 and 19.10-0
                                      NVIDIA nvc, nvfortran and nvc++ version 22.5-0
-                                     (autotools and cmake)
+                                     (cmake)
 
 
     Linux-3.10.0-1160.119.1.1chaos   openmpi/4.1.4
@@ -1057,11 +1047,6 @@ Platforms Tested
 Known Problems
 ==============
 
- -  When building with the NAG Fortran compiler using the Autotools and libtool
-    2.4.2 or earlier, the -shared flag will be missing '-Wl,', which will cause
-    compilation to fail. This is due to a bug in libtool that was fixed in 2012
-    and released in 2.4.4 in 2014.
-
  -  When the library detects and builds in support for the _Float16 datatype, an
     issue has been observed on at least one MacOS 14 system where the library
     fails to initialize due to not being able to detect the byte order of the
@@ -1075,7 +1060,6 @@ Known Problems
     with a configuration option:
 
         CMake:      HDF5_ENABLE_NONSTANDARD_FEATURE_FLOAT16=OFF
-        Autotools:  --disable-nonstandard-feature-float16
 
  -  When HDF5 is compiled with NVHPC versions 23.5 - 23.9 (additional versions may
     also be applicable) and with -O2 (or higher) and -DNDEBUG, test failures occur
@@ -1135,28 +1119,23 @@ Known Problems
     [email protected].
 
 
-CMake vs. Autotools installations
+CMake Installations
 =================================
-While both build systems produce similar results, there are differences.
-Each system produces the same set of folders on Linux (only CMake works
-on standard Windows); bin, include, lib and share. Autotools places the
-LICENSE and RELEASE.txt file in the root folder, CMake places them in
-the share folder.
+See the AutotoolsToCMakeOptions.md file for CMake options for former Autotools options.
+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". Autotools
-installs one set of tools depending on the "--enable-shared" configuration
-option.
+creates dynamic versions of the tools with the suffix "-shared".
   build scripts
   -------------
-  Autotools: h5c++, h5cc, h5fc
   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,
-while Autotools 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.
+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
@@ -1165,15 +1144,13 @@ 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.
 
-The share folder will have the most differences because CMake builds include
-a number of CMake specific files for support of CMake's find_package and support
-for the HDF5 Examples CMake project.
+CMake builds include a number of CMake specific files for support of CMake's
+find_package and support for the HDF5 Examples CMake project.
 
 The issues with the gif tool are:
     HDFFV-10592 CVE-2018-17433
     HDFFV-10593 CVE-2018-17436
     HDFFV-11048 CVE-2020-10809
 These CVE issues have not yet been addressed and are avoided by not building
-the gif tool by default. Enable building the High-Level tools with these options:
-    autotools:   --enable-hlgiftools
+the gif tool by default. Enable building the High-Level tools with this options:
     cmake:       HDF5_BUILD_HL_GIF_TOOLS=ON

src/H5Fpublic.h

@@ -1775,7 +1775,7 @@ H5_DLL herr_t H5Fset_dset_no_attrs_hint(hid_t file_id, hbool_t minimize);
  * pass the same values for \p file_id and \p flag.
  *
  * This function is available only when the HDF5 library is configured with parallel support
- * (\TText{--enable-parallel | HDF5_ENABLE_PARALLEL}). It is useful only when used with the #H5FD_MPIO driver
+ * (\TText{HDF5_ENABLE_PARALLEL}). It is useful only when used with the #H5FD_MPIO driver
  * (see H5Pset_fapl_mpio()).
  * \endparblock
  *