Split static targets into separate optional target

[opoplawski]

Fedora packaging guidelines requires that static libraries are shipped in a separate -static sub-package and are not used by other Fedora packages when building. This causes issues with many cmake projects that put both the shared and static targets in the same file, like the following:

CMake Error at /usr/lib64/cmake/hdf5/hdf5-targets.cmake:298 (message):
  The imported target "hdf5-static" references the file

     "/usr/lib64/libhdf5.a"

  but this file does not exist.  Possible reasons include:

  * The file was deleted, renamed, or moved to another location.

  * An install or uninstall procedure did not complete successfully.

  * The installation package was faulty and contained

     "/usr/lib64/cmake/hdf5/hdf5-targets.cmake"

  but not all the files it references.

Call Stack (most recent call first):
  /usr/lib64/cmake/hdf5/hdf5-config.cmake:222 (include)
  /usr/share/cmake/Modules/FindHDF5.cmake:513 (find_package)
  CMakeLists.txt:179 (find_package)

We have submitted similar patches to other upstream projects to put the static targets into a separate optional file. This patch is not completely polished - it lacks some symmetry in how names and variables are handled. But I at least wanted to put it out there for comment.

---

Important

Separate static library targets into optional -static CMake files for HDF5 components to comply with Fedora packaging guidelines.

• Behavior:
  • Separate static library targets into -static CMake files for core, tools, and language bindings.
  • Static libraries are now optional and exported separately.
• CMake Configuration:
  • Add HDF5_STATIC_LIBRARIES_TO_EXPORT variable to track static libraries.
  • Modify CMakeLists.txt in src, tools/lib, c++/src, fortran/src, hl/src, hl/c++/src, hl/fortran/src to handle static libraries separately.
  • Update install() commands to export static libraries to -static targets.
• Misc:
  • Update hdf5-config.cmake.in to include optional static targets.
  • Ensure backward compatibility by maintaining shared library targets.

^{This description was created by for 846bc8f. You can customize this summary. It will automatically update as commits are pushed.}

[opoplawski]

Looks like we're running into problems with this:

# Load information for each installed configuration.
file(GLOB _cmake_config_files "${CMAKE_CURRENT_LIST_DIR}/hdf5-targets-*.cmake")
foreach(_cmake_config_file IN LISTS _cmake_config_files)
  include("${_cmake_config_file}")
endforeach()

picking up the -static files, so I need a different name for it.

[opoplawski]

Fedora also splits out the java components, so it needs a new target as well.

[jhendersonHDF]

Hi @opoplawski,

at a first glance this seems reasonable and unlikely to be controversial. Out of curiosity, do you happen to have a link to Fedora's packaging guidelines so we can read up on them more regarding this?

[opoplawski]

Here is a place to start: https://docs.fedoraproject.org/en-US/packaging-guidelines/#packaging-static-libraries

[jhendersonHDF]

Not sure about best practices, but using OPTIONAL for these seems like it would hide errors in the cases where users were expecting that the static targets file would exist and may be confusing

[jhendersonHDF]

OPTIONAL may make sense here however, as HDF5_BUILD_JAVA is checked here, whereas the ..._java-targets.cmake file is created when HDF5_ENABLE_JNI is true rather than HDF5_BUILD_JAVA. I believe that means the ..._java-targets.cmake file won't exist when the Java implementation uses FFM instead of the old JNI, but the FFM source doesn't currently appear to have anything to export as a target anyway.

[jhendersonHDF]

Generally looks good, just a couple comments around the use of OPTIONAL when including target files