No longer deploy private header files

Autotools flavor (CMake next)
HDFGroup · Feb 20, 2024 · dae7392 · dae7392
1 parent 276e2c2
commit dae7392
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 11 deletions.
diff --git 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/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
@@ -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