[svn-r3790] Purpose:

    Improvment
Description:
    H5config.h and H5pubconf.h are generated by configure.  It does
    not have the #ifndef _H5config_H ... #endif guard to prevent
    duplicated definitions if it is included more than once.
    It is messy to try make configure to put in those guards.
Solution:
    HDF5 has set an internal rule that H5public.h includes H5pubconf.h
    and H5private.h includes H5config.h.  Source files should NOT include
    H5config.h or H5pubconf.h directly but include it via H5public.h or
    H5private.h respectively.   The #ifndef ... #endif in the H5public.h
    and H5private.h would prevent repeated definitions from repeated
    include.

    Adjusted H5FDstream.c and H5FDstream.h to follow this rule.
Platforms tested:
    modi4, eirene.

1 files changed, 8 insertions, 0 deletions

diff --git a/src/H5public.h b/src/H5public.h
index 4b038e1..a494571 100644
--- a/src/H5public.h
+++ b/src/H5public.h
@@ -20,6 +20,14 @@
 #define _H5public_H
 
 /* Include files for public use... */
+/*
+ * Since H5pubconf.h is a generated header file, it is messy to try
+ * to put a #ifndef _H5pubconf_H ... #endif guard in it.
+ * HDF5 has set an internal rule that it is being included here.
+ * Source files should NOT include H5pubconf.h directly but include
+ * it via H5public.h.  The #ifndef _H5public_H guard above would
+ * prevent repeated include.
+ */
 #include <H5pubconf.h>		/*from configure                             */
 #include <sys/types.h>
 #ifdef H5_STDC_HEADERS