From 1d01f7f16e558a769814fbfd3f7f8384667393fc Mon Sep 17 00:00:00 2001 From: Dana Robinson <43805+derobins@users.noreply.github.com> Date: Mon, 19 Feb 2024 22:38:07 -0800 Subject: [PATCH] No longer deploy private header files (#568) Both the Autotools and CMake no longer install the following header files: atom.h bitvect.h cdeflate.h cnbit.h cnone.h crle.h cskphuff.h cszip.h df.h dfan.h dfgr.h dfrig.h dfsd.h dfufp2i.h dynarray.h hchunks.h hcompi.h hconv.h hdfi.h hfile.h hkit.h linklist.h local_nc.h mfan.h mfani.h mfgri.h mstdio.h tbbt.h --- hdf/src/CMakeLists.txt | 36 ++++++++++++++++++------------------ hdf/src/Makefile.am | 10 +++------- mfhdf/libsrc/CMakeLists.txt | 8 ++++---- mfhdf/libsrc/Makefile.am | 7 ++++--- release_notes/RELEASE.txt | 36 +++++++++++++++++++++++++++++++++++- 5 files changed, 64 insertions(+), 33 deletions(-) diff --git a/hdf/src/CMakeLists.txt b/hdf/src/CMakeLists.txt index e164b5ef8c..ab2b8818c5 100644 --- a/hdf/src/CMakeLists.txt +++ b/hdf/src/CMakeLists.txt @@ -66,6 +66,22 @@ set (HDF4_HDF_SRC_CSRCS ) set (HDF4_HDF_SRC_CHDRS + ${HDF4_HDF_SRC_SOURCE_DIR}/H4api_adpt.h + #${HDF4_BINARY_DIR}/h4config.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hbitio.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hcomp.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hdatainfo.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hdf.h + ${HDF4_HDF_SRC_SOURCE_DIR}/herr.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hlimits.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hntdefs.h + ${HDF4_HDF_SRC_SOURCE_DIR}/hproto.h + ${HDF4_HDF_SRC_SOURCE_DIR}/htags.h + ${HDF4_HDF_SRC_SOURCE_DIR}/mfgr.h + ${HDF4_HDF_SRC_SOURCE_DIR}/vg.h +) + +set (HDF4_PRIVATE_HDF_SRC_CHDRS ${HDF4_HDF_SRC_SOURCE_DIR}/atom.h ${HDF4_HDF_SRC_SOURCE_DIR}/bitvect.h ${HDF4_HDF_SRC_SOURCE_DIR}/cdeflate.h @@ -81,37 +97,21 @@ set (HDF4_HDF_SRC_CHDRS ${HDF4_HDF_SRC_SOURCE_DIR}/dfsd.h ${HDF4_HDF_SRC_SOURCE_DIR}/dfufp2i.h ${HDF4_HDF_SRC_SOURCE_DIR}/dynarray.h - ${HDF4_HDF_SRC_SOURCE_DIR}/H4api_adpt.h - #${HDF4_BINARY_DIR}/h4config.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hbitio.h + ${HDF4_HDF_SRC_SOURCE_DIR}/glist.h ${HDF4_HDF_SRC_SOURCE_DIR}/hchunks.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hcomp.h ${HDF4_HDF_SRC_SOURCE_DIR}/hcompi.h ${HDF4_HDF_SRC_SOURCE_DIR}/hconv.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hdatainfo.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hdf.h ${HDF4_HDF_SRC_SOURCE_DIR}/hdfi.h - ${HDF4_HDF_SRC_SOURCE_DIR}/herr.h ${HDF4_HDF_SRC_SOURCE_DIR}/hfile.h ${HDF4_HDF_SRC_SOURCE_DIR}/hkit.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hlimits.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hntdefs.h - ${HDF4_HDF_SRC_SOURCE_DIR}/hproto.h ${HDF4_HDF_SRC_SOURCE_DIR}/hqueue.h - ${HDF4_HDF_SRC_SOURCE_DIR}/htags.h ${HDF4_HDF_SRC_SOURCE_DIR}/linklist.h + ${HDF4_HDF_SRC_SOURCE_DIR}/mcache.h ${HDF4_HDF_SRC_SOURCE_DIR}/mfan.h ${HDF4_HDF_SRC_SOURCE_DIR}/mfani.h - ${HDF4_HDF_SRC_SOURCE_DIR}/mfgr.h ${HDF4_HDF_SRC_SOURCE_DIR}/mfgri.h ${HDF4_HDF_SRC_SOURCE_DIR}/mstdio.h ${HDF4_HDF_SRC_SOURCE_DIR}/tbbt.h - ${HDF4_HDF_SRC_SOURCE_DIR}/vg.h -) - -set (HDF4_PRIVATE_HDF_SRC_CHDRS - ${HDF4_HDF_SRC_SOURCE_DIR}/glist.h - ${HDF4_HDF_SRC_SOURCE_DIR}/mcache.h ${HDF4_HDF_SRC_SOURCE_DIR}/vgint.h ) diff --git a/hdf/src/Makefile.am b/hdf/src/Makefile.am index 0bf30c7d35..c9cc6b7edf 100644 --- a/hdf/src/Makefile.am +++ b/hdf/src/Makefile.am @@ -20,13 +20,9 @@ CSOURCES = atom.c bitvect.c cdeflate.c cnbit.c cnone.c crle.c cskphuff.c \ mcache.c mfan.c mfgr.c mstdio.c tbbt.c vattr.c vconv.c vg.c \ vgp.c vhi.c vio.c vparse.c vrw.c vsfld.c -CHEADERS = atom.h bitvect.h cdeflate.h cnbit.h cnone.h cskphuff.h crle.h \ - cszip.h df.h dfan.h dfgr.h dfrig.h dfsd.h dfufp2i.h \ - dynarray.h H4api_adpt.h h4config.h hbitio.h hchunks.h hcomp.h \ - hcompi.h hconv.h hdf.h hdfi.h herr.h hfile.h hkit.h hlimits.h \ - hproto.h hntdefs.h htags.h linklist.h mfan.h mfani.h mfgr.h \ - mfgri.h mstdio.h tbbt.h vg.h hdatainfo.h -## hdatainfo.h needs to be added conditionally only, should fix this asap +CHEADERS = H4api_adpt.h h4config.h hbitio.h hcomp.h hdatainfo.h hdf.h \ + herr.h hlimits.h hntdefs.h hproto.h htags.h mfgr.h vg.h + FHEADERS = dffunc.f90 hdf.f90 dffunc.inc hdf.inc if HDF_BUILD_FORTRAN diff --git a/mfhdf/libsrc/CMakeLists.txt b/mfhdf/libsrc/CMakeLists.txt index b3bf90d17d..2a472aaa6d 100644 --- a/mfhdf/libsrc/CMakeLists.txt +++ b/mfhdf/libsrc/CMakeLists.txt @@ -35,18 +35,18 @@ set (HDF4_MFHDF_LIBSRC_CSRCS ) set (HDF4_MFHDF_LIBSRC_INSTALL_CHDRS - ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/local_nc.h + ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/hdf2netcdf.h + ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/mfdatainfo.h ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/mfhdf.h ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/mfhdfi.h - ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/mfdatainfo.h - ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/hdf2netcdf.h ) set (HDF4_MFHDF_LIBSRC_CHDRS ${HDF4_MFHDF_LIBSRC_INSTALL_CHDRS} ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/error.h - ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/mfprivate.h ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/h4_xdr.h + ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/local_nc.h + ${HDF4_MFHDF_LIBSRC_SOURCE_DIR}/mfprivate.h ) if (HDF4_ENABLE_NETCDF) diff --git a/mfhdf/libsrc/Makefile.am b/mfhdf/libsrc/Makefile.am index 64862de8a5..dae0e31b7f 100644 --- a/mfhdf/libsrc/Makefile.am +++ b/mfhdf/libsrc/Makefile.am @@ -36,10 +36,11 @@ endif libmfhdf_la_LIBADD = $(top_builddir)/hdf/src/libdf.la if HDF_BUILD_NETCDF -include_HEADERS = hdf2netcdf.h local_nc.h mfhdf.h netcdf.h mfhdfi.h mfdatainfo.h +include_HEADERS = hdf2netcdf.h mfhdf.h netcdf.h mfdatainfo.h \ + mfhdfi.h else -include_HEADERS = hdf2netcdf.h local_nc.h mfhdf.h hdf4_netcdf.h mfhdfi.h mfdatainfo.h -# mfdatainfo.h should be added conditionally only; should local_nc.h even be here? -BMR +include_HEADERS = hdf2netcdf.h mfhdf.h hdf4_netcdf.h mfdatainfo.h \ + mfhdfi.h endif # The following is a workaround. Since Fortran is included in this diff --git a/release_notes/RELEASE.txt b/release_notes/RELEASE.txt index 888b817827..7dc0cbe201 100644 --- a/release_notes/RELEASE.txt +++ b/release_notes/RELEASE.txt @@ -124,7 +124,41 @@ New features and changes C Library: ---------- - hdfi.h is no longer included by hdf.h + - Private headers are no longer deployed + + The following private headers are not a part of the public API and + will no longer be deployed when installing the library: + + atom.h + bitvect.h + cdeflate.h + cnbit.h + cnone.h + crle.h + cskphuff.h + cszip.h + df.h + dfan.h + dfgr.h + dfrig.h + dfsd.h + dfufp2i.h + dynarray.h + hchunks.h + hcompi.h + hconv.h + hdfi.h + hfile.h + hkit.h + linklist.h + local_nc.h + mfan.h + mfani.h + mfgri.h + mstdio.h + tbbt.h + + - hdfi.h is no longer included by hdf.h In the past, hdfi.h (an internal header file) was included in the public hdf.h header. This is no longer the case. Anything that