Fix #321, Apply header guard standard

nasa · Feb 4, 2022 · 94dffd3 · 94dffd3
1 parent 9a1af6c
commit 94dffd3
Show file tree

Hide file tree

Showing 70 changed files with 217 additions and 235 deletions.
diff --git a/fsw/inc/cfe_psp.h b/fsw/inc/cfe_psp.h
@@ -19,8 +19,6 @@
 */
 
 /*
-**  File Name:  cfe_psp.h
-**
 **  Author:  A. Cudmore
 **
 **  Purpose:  This file contains the cFE Platform Support Package(PSP)
@@ -33,8 +31,8 @@
 **
 */
 
-#ifndef _cfe_psp_
-#define _cfe_psp_
+#ifndef CFE_PSP_H
+#define CFE_PSP_H
 
 /*
 ** Include Files
@@ -490,4 +488,4 @@ void CFE_PSP_GetVersionNumber(uint8 VersionNumbers[4]);
  */
 uint32 CFE_PSP_GetBuildNumber(void);
 
-#endif /* _cfe_psp_ */
+#endif
diff --git a/fsw/mcp750-vxworks/inc/cfe_psp_config.h b/fsw/mcp750-vxworks/inc/cfe_psp_config.h
@@ -18,13 +18,8 @@
 **  limitations under the License.
 */
 
-/*
-** cfe_psp_config.h
-**
-*/
-
-#ifndef _cfe_psp_config_
-#define _cfe_psp_config_
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #include "common_types.h"
 

diff --git a/fsw/mcp750-vxworks/inc/psp_version.h b/fsw/mcp750-vxworks/inc/psp_version.h
@@ -18,13 +18,13 @@
 **  limitations under the License.
 */
 
-/*! @file mcp750-vxworks/inc/psp_version.h
+/*! @file
  *  @brief Purpose:
  *  @details Provide version identifiers for the cFE Platform Support Packages (PSP).
  *  See @ref cfsversions for version and build number and description
  */
-#ifndef _psp_version_
-#define _psp_version_
+#ifndef PSP_VERSION_H
+#define PSP_VERSION_H
 
 /*
  * Development Build Macro Definitions
@@ -70,4 +70,4 @@
     " PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
     ", Last Official Release: psp v1.4.0" /* For full support please use this version */
 
-#endif /* _psp_version_ */
+#endif
diff --git a/fsw/pc-linux/inc/cfe_psp_config.h b/fsw/pc-linux/inc/cfe_psp_config.h
@@ -18,12 +18,8 @@
 **  limitations under the License.
 */
 
-/*
-** cfe_psp_config.h
-*/
-
-#ifndef _cfe_psp_config_
-#define _cfe_psp_config_
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #include "common_types.h"
 

diff --git a/fsw/pc-linux/inc/psp_version.h b/fsw/pc-linux/inc/psp_version.h
@@ -18,13 +18,13 @@
 **  limitations under the License.
 */
 
-/*! @file pc-linux/inc/psp_version.h
+/*! @file
  *  @brief Purpose:
  *  @details Provide version identifiers for the cFE Platform Support Packages (PSP).
  *  See @ref cfsversions for version and build number and description
  */
-#ifndef _psp_version_
-#define _psp_version_
+#ifndef PSP_VERSION_H
+#define PSP_VERSION_H
 
 /*
  * Development Build Macro Definitions
@@ -70,4 +70,4 @@
     " PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
     ", Last Official Release: psp v1.4.0" /* For full support please use this version */
 
-#endif /* _psp_version_ */
+#endif
diff --git a/fsw/pc-rtems/inc/cfe_psp_config.h b/fsw/pc-rtems/inc/cfe_psp_config.h
@@ -18,13 +18,8 @@
 **  limitations under the License.
 */
 
-/*
-** cfe_psp_config.h
-**
-*/
-
-#ifndef _cfe_psp_config_
-#define _cfe_psp_config_
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #include "common_types.h"
 #include <rtems.h>

diff --git a/fsw/pc-rtems/inc/psp_version.h b/fsw/pc-rtems/inc/psp_version.h
@@ -18,13 +18,13 @@
 **  limitations under the License.
 */
 
-/*! @file pc-rtems/inc/psp_version.h
+/*! @file
  *  @brief Purpose:
  *  @details Provide version identifiers for the cFE Platform Support Packages (PSP).
  *  See @ref cfsversions for version and build number and description
  */
-#ifndef _psp_version_
-#define _psp_version_
+#ifndef PSP_VERSION_H
+#define PSP_VERSION_H
 
 /*
  * Development Build Macro Definitions
@@ -70,4 +70,4 @@
     " PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
     ", Last Official Release: psp v1.4.0" /* For full support please use this version */
 
-#endif /* _psp_version_ */
+#endif
diff --git a/fsw/shared/inc/cfe_psp_memory.h b/fsw/shared/inc/cfe_psp_memory.h
@@ -19,8 +19,6 @@
 */
 
 /*
-**  File Name:  cfe_psp_memory.h
-**
 **  Author:  A. Cudmore
 **
 **  Purpose:  This file contains PSP support routine internal prototypes
@@ -31,8 +29,8 @@
 **
 */
 
-#ifndef _cfe_psp_memory_
-#define _cfe_psp_memory_
+#ifndef CFE_PSP_MEMORY_H
+#define CFE_PSP_MEMORY_H
 
 /*
 ** Include Files
@@ -120,4 +118,4 @@ extern void CFE_PSP_DeleteProcessorReservedMemory(void);
 */
 extern CFE_PSP_ReservedMemoryMap_t CFE_PSP_ReservedMemoryMap;
 
-#endif /* _cfe_psp_memory_ */
+#endif
diff --git a/unit-test-coverage/mcp750-vxworks/adaptors/inc/ut-adaptor-bootrec.h b/unit-test-coverage/mcp750-vxworks/adaptors/inc/ut-adaptor-bootrec.h
@@ -11,19 +11,19 @@
  */
 
 /**
- * \file     ut-adaptor-bootrec.h
+ * \file
  * \ingroup  adaptors
  * \author   joseph.p.hickey@nasa.gov
  *
  */
 
-#ifndef INCLUDE_UT_ADAPTOR_BOOTREC_H_
-#define INCLUDE_UT_ADAPTOR_BOOTREC_H_
+#ifndef UT_ADAPTOR_BOOTREC_H
+#define UT_ADAPTOR_BOOTREC_H
 
 #include "common_types.h"
 
 void   UT_Setup_ReservedMem_BootRec(void);
 uint32 UT_Get_ReservedMem_BootType(void);
 void   UT_Set_ReservedMem_BootType(uint32 reset_type);
 
-#endif /* INCLUDE_UT_ADAPTOR_BOOTREC_H_ */
+#endif
diff --git a/unit-test-coverage/mcp750-vxworks/src/coveragetest-psp-mcp750-vxworks.h b/unit-test-coverage/mcp750-vxworks/src/coveragetest-psp-mcp750-vxworks.h
@@ -11,14 +11,14 @@
  */
 
 /**
- * \file     psp-mcp750-vxworks-coveragetest.h
+ * \file
  * \ingroup  vxworks
  * \author   joseph.p.hickey@nasa.gov
  *
  */
 
-#ifndef INCLUDE_PSP_MCP750_VXWORKS_COVERAGETEST_H_
-#define INCLUDE_PSP_MCP750_VXWORKS_COVERAGETEST_H_
+#ifndef COVERAGETEST_PSP_MCP750_VXWORKS_H
+#define COVERAGETEST_PSP_MCP750_VXWORKS_H
 
 #include "utassert.h"
 #include "uttest.h"
@@ -48,4 +48,4 @@ void Test_CFE_PSP_GetSpacecraftId(void);
 void Test_OS_Application_Startup(void);
 void Test_OS_Application_Run(void);
 
-#endif /* INCLUDE_PSP_MCP750_VXWORKS_COVERAGETEST_H_ */
+#endif
diff --git a/unit-test-coverage/modules/timebase_vxworks/inc/cfe_psp_config.h b/unit-test-coverage/modules/timebase_vxworks/inc/cfe_psp_config.h
@@ -17,8 +17,8 @@
  * Stub for "cfe_psp_config.h" to use with coverage testing
  */
 
-#ifndef COVERAGETEST_CFE_PSP_CONFIG_H
-#define COVERAGETEST_CFE_PSP_CONFIG_H
+#ifndef CFE_PSP_CONFIG_H
+#define CFE_PSP_CONFIG_H
 
 #define CFE_PSP_VX_TIMEBASE_PERIOD_NUMERATOR   (UT_PSP_TIMEBASE_VXWORKS_TESTCONFIG.PeriodNumerator)
 #define CFE_PSP_VX_TIMEBASE_PERIOD_DENOMINATOR (UT_PSP_TIMEBASE_VXWORKS_TESTCONFIG.PeriodDenominator)
@@ -32,4 +32,4 @@ typedef struct
 
 extern UT_PSP_TimeBase_VxWorks_TestConfig_t UT_PSP_TIMEBASE_VXWORKS_TESTCONFIG;
 
-#endif /* COVERAGETEST_CFE_PSP_CONFIG_H */
+#endif
diff --git a/unit-test-coverage/modules/timebase_vxworks/inc/coveragetest-timebase_vxworks.h b/unit-test-coverage/modules/timebase_vxworks/inc/coveragetest-timebase_vxworks.h
@@ -11,19 +11,19 @@
  */
 
 /**
- * \file     psp-shared-coveragetest.h
+ * \file
  * \ingroup  vxworks
  * \author   joseph.p.hickey@nasa.gov
  *
  */
 
-#ifndef INCLUDE_PSP_SHARED_COVERAGETEST_H_
-#define INCLUDE_PSP_SHARED_COVERAGETEST_H_
+#ifndef COVERAGETEST_TIMEBASE_VXWORKS_H
+#define COVERAGETEST_TIMEBASE_VXWORKS_H
 
 #include "utassert.h"
 #include "uttest.h"
 #include "utstubs.h"
 
 void Test_CFE_PSP_Timebase_Vxworks_Init(void);
 
-#endif /* INCLUDE_PSP_SHARED_COVERAGETEST_H_ */
+#endif
diff --git a/unit-test-coverage/shared/adaptors/inc/ut-adaptor-exceptions.h b/unit-test-coverage/shared/adaptors/inc/ut-adaptor-exceptions.h
@@ -11,14 +11,14 @@
  */
 
 /**
- * \file     ut-adaptor-exceptions.h
+ * \file
  * \ingroup  adaptors
  * \author   joseph.p.hickey@nasa.gov
  *
  */
 
-#ifndef INCLUDE_UT_ADAPTOR_EXCEPTIONS_H_
-#define INCLUDE_UT_ADAPTOR_EXCEPTIONS_H_
+#ifndef UT_ADAPTOR_EXCEPTIONS_H
+#define UT_ADAPTOR_EXCEPTIONS_H
 
 #include "common_types.h"
 #include "cfe_psp_exceptionstorage_api.h"
@@ -28,4 +28,4 @@ size_t UT_Get_Exception_Size(void);
 uint32 UT_Get_Exception_Id(struct CFE_PSP_Exception_LogData *Buffer);
 void   UT_Generate_Exception_Context(struct CFE_PSP_Exception_LogData *Buffer, size_t Size);
 
-#endif /* INCLUDE_UT_ADAPTOR_EXCEPTIONS_H_ */
+#endif
diff --git a/unit-test-coverage/shared/inc/coveragetest-psp-shared.h b/unit-test-coverage/shared/inc/coveragetest-psp-shared.h
@@ -11,14 +11,14 @@
  */
 
 /**
- * \file     psp-shared-coveragetest.h
+ * \file
  * \ingroup  vxworks
  * \author   joseph.p.hickey@nasa.gov
  *
  */
 
-#ifndef INCLUDE_PSP_SHARED_COVERAGETEST_H_
-#define INCLUDE_PSP_SHARED_COVERAGETEST_H_
+#ifndef COVERAGETEST_PSP_SHARED_H
+#define COVERAGETEST_PSP_SHARED_H
 
 #include "utassert.h"
 #include "uttest.h"
@@ -29,4 +29,4 @@ void Test_CFE_PSP_Exception_GetNextContextBuffer(void);
 void Test_CFE_PSP_Exception_GetSummary(void);
 void Test_CFE_PSP_Exception_CopyContext(void);
 
-#endif /* INCLUDE_PSP_SHARED_COVERAGETEST_H_ */
+#endif
diff --git a/unit-test-coverage/ut-stubs/inc/PCS_arch_ppc_esfPpc.h b/unit-test-coverage/ut-stubs/inc/PCS_arch_ppc_esfPpc.h
@@ -1,6 +1,6 @@
 /* PSP coverage stub replacement for esfPpc.h */
-#ifndef _PSP_STUB_ESFPPC_H_
-#define _PSP_STUB_ESFPPC_H_
+#ifndef PCS_ARCH_PPC_ESFPPC_H
+#define PCS_ARCH_PPC_ESFPPC_H
 
 #include "PCS_basetypes.h"
 
@@ -21,4 +21,4 @@ typedef struct
     uint32_t pad[32];
 } PCS_ESFPPC;
 
-#endif /* _PSP_STUB_ESFPPC_H_ */
+#endif
diff --git a/unit-test-coverage/ut-stubs/inc/PCS_arch_ppc_vxPpcLib.h b/unit-test-coverage/ut-stubs/inc/PCS_arch_ppc_vxPpcLib.h
@@ -1,6 +1,6 @@
 /* PSP coverage stub replacement for vxPpcLib.h */
-#ifndef _PSP_STUB_VXPPCLIB_H_
-#define _PSP_STUB_VXPPCLIB_H_
+#ifndef PCS_ARCH_PPC_VXPPCLIB_H
+#define PCS_ARCH_PPC_VXPPCLIB_H
 
 #include "PCS_basetypes.h"
 
@@ -61,4 +61,4 @@ extern void     PCS_vxFpscrSet(uint32_t);
 extern uint32_t PCS_vxFpscrGet(void);
 extern uint32_t PCS_vxDecGet(void);
 
-#endif /* _PSP_STUB_VXPPCLIB_H_ */
+#endif
diff --git a/unit-test-coverage/ut-stubs/inc/PCS_basetypes.h b/unit-test-coverage/ut-stubs/inc/PCS_basetypes.h
@@ -9,8 +9,8 @@
  */
 
 /* PSP coverage stub basic data types */
-#ifndef _PSP_STUB_BASETYPES_H_
-#define _PSP_STUB_BASETYPES_H_
+#ifndef PCS_BASETYPES_H
+#define PCS_BASETYPES_H
 
 /*
  * NOTE: These header files are intentionally _not_ overridden
@@ -26,4 +26,4 @@
 #include <limits.h>  /* for correct INT_MAX, etc. */
 #include <stdbool.h> /* for correct boolean semantics */
 
-#endif /* _PSP_STUB_BASETYPES_H_ */
+#endif
diff --git a/unit-test-coverage/ut-stubs/inc/PCS_blkIo.h b/unit-test-coverage/ut-stubs/inc/PCS_blkIo.h
@@ -9,8 +9,8 @@
  */
 
 /* PSP coverage stub basic data types */
-#ifndef _PSP_STUB_BLKIO_H_
-#define _PSP_STUB_BLKIO_H_
+#ifndef PCS_BLKIO_H
+#define PCS_BLKIO_H
 
 #include "PCS_basetypes.h"
 #include "PCS_vxWorks.h"
@@ -22,4 +22,4 @@ typedef struct PCS_BLK_DEV
 } PCS_BLK_DEV;
 typedef PCS_BLK_DEV *PCS_BLK_DEV_ID;
 
-#endif /* _PSP_STUB_BLKIO_H_ */
+#endif
diff --git a/unit-test-coverage/ut-stubs/inc/PCS_cacheLib.h b/unit-test-coverage/ut-stubs/inc/PCS_cacheLib.h
@@ -1,6 +1,6 @@
 /* PSP coverage stub replacement for cacheLib.h */
-#ifndef _PSP_STUB_CACHELIB_H_
-#define _PSP_STUB_CACHELIB_H_
+#ifndef PCS_CACHELIB_H
+#define PCS_CACHELIB_H
 
 #include "PCS_basetypes.h"
 #include "PCS_vxWorks.h"
@@ -18,4 +18,4 @@
 /* ----------------------------------------- */
 extern PCS_STATUS PCS_cacheTextUpdate(void *adrs, size_t bytes);
 
-#endif /* _PSP_STUB_CACHELIB_H_ */
+#endif
diff --git a/unit-test-coverage/ut-stubs/inc/PCS_cfe_configdata.h b/unit-test-coverage/ut-stubs/inc/PCS_cfe_configdata.h
@@ -1,5 +1,5 @@
-#ifndef _PSP_STUB_CFE_CONFIGDATA_H_
-#define _PSP_STUB_CFE_CONFIGDATA_H_
+#ifndef PCS_CFE_CONFIGDATA_H
+#define PCS_CFE_CONFIGDATA_H
 
 #include "PCS_basetypes.h"
 
@@ -28,4 +28,4 @@ void PCS_System1HzISR(void);
  */
 void PCS_SystemNotify(void);
 
-#endif /* _PSP_STUB_CFE_CONFIGDATA_H_ */
+#endif