Merge pull request nasa#90 from nasa/integration-candidate

sample_lib Integration candidate: Caelum-rc4+dev25
jphickey · Oct 11, 2022 · 2da1173 · 2da1173
2 parents 286bb59 + 7b3645d
commit 2da1173
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 108 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,90 @@
+# Changelog
+
+## Development Build: v1.3.0-rc4+dev28
+- Remove redundant comments
+- Create CHANGELOG.md
+- See <https://github.com/nasa/sample_lib/pull/89> and <https://github.com/nasa/sample_lib/pull/86>
+
+## Development Build: v1.3.0-rc4+dev20
+- Remove unnecessary parentheses around return values.
+- See <https://github.com/nasa/sample_lib/pull/84>
+
+## Development Build: v1.3.0-rc4+dev16
+- Update Copyright Headers
+- Standardize version.h 
+- See <https://github.com/nasa/sample_lib/pull/80> and <https://github.com/nasa/cFS/445>
+
+## Development Build: v1.3.0-rc4+dev9
+- Apply header guard standard 
+- Remove explicit filename doxygen comments 
+- See <https://github.com/nasa/cFS/pull/432>
+
+## Development Build: v1.3.0-rc4+dev3
+- Update baseline to cFS-Caelum-rc4: v1.3.0-rc4
+- See <https://github.com/nasa/cfs/issues/390>
+
+## Development Build: v1.2.0-rc1+dev38
+-  Implement Coding Standard in CodeQL workflow
+- See <https://github.com/nasa/sample_lib/pull/64> and <https://github.com/nasa/cFS/pull/270>
+
+## Development Build: v1.2.0-rc1+dev34
+- Replace direct ref to ArgPtr with `UT_Hook_GetArgValueByName` macro. Reading the pointer directly is not advised.
+- See <https://github.com/nasa/sample_lib/pull/61> and <https://github.com/nasa/cFS/pull/250>
+
+## Development Build: v1.2.0-rc1+dev30
+- Replace <> with " for local includes
+- Adds CONTRIBUTING.md that links to the main cFS contributing guide.
+- See <https://github.com/nasa/sample_lib/pull/55>
+
+## Development Build: v1.2.0-rc1+dev24
+- Simplify build to use wrappers and interface libs
+- Add Testing Tools to the Security Policy
+- See <https://github.com/nasa/sample_lib/pull/50>
+
+## Development Build: v1.2.0-rc1+dev10
+- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing
+- See <https://github.com/nasa/sample_lib/pull/38>
+
+## Development Build: v1.2.0-rc1+dev8
+- No behavior changes. All identifiers now use the prefix `SAMPLE_LIB_`. Changes the name of the init function from SAMPLE_LibInit to SAMPLE_LIB_Init which affects the CFE startup script.
+- Set REVISION to "99" to indicate development version status
+- See <https://github.com/nasa/sample_lib/pull/35>
+
+## Development Build: v1.2.0-rc1+dev3
+- Installs unit test to target directory.
+- See <https://github.com/nasa/sample_lib/pull/32>
+
+## Development Build: 1.1.0+dev27
+- Install unit test as part of cmake recipe. Sample lib test runner now shows up in expected install directory
+- Add build number and baseline to version reporting
+- See <https://github.com/nasa/sample_lib/pull/28>
+
+## Development Build: 1.1.4
+- Apply code style
+- See <https://github.com/nasa/sample_lib/pull/24>
+
+## Development Build: 1.1.3
+- Coverage data `make lcov` includes the sample_lib code
+- See <https://github.com/nasa/sample_lib/pull/22>
+
+## Development Build: 1.1.2
+- Added coverage test and a stub library to facilitate unit test
+- See <https://github.com/nasa/sample_lib/pull/16>
+
+## Development Build: 1.1.1
+- See <https://github.com/nasa/sample_lib/pull/14>
+
+## ***OFFICIAL RELEASE: 1.1.0 - Aquila***
+- Released as part of cFE 6.7.0, Apache 2.0
+- See <https://github.com/nasa/sample_lib/pull/6>
+
+## ***OFFICIAL RELEASE: 1.0.0a***
+- Released as part of cFE 6.6.0a, Apache 2.0
+
+## Known issues
+As a lab library, extensive testing is not performed prior to release and only minimal functionality is included.
+
+## Getting Help
+For best results, submit issues:questions or issues:help wanted requests at https://github.com/nasa/cFS.
+
+Official cFS page: http://cfs.gsfc.nasa.gov
diff --git a/README.md b/README.md
@@ -9,100 +9,6 @@ This sample library is a non-flight example library implementation for the cFS B
 
 sample_lib implements SAMPLE_Function, as an example for how to build and link a library in cFS.
 
-## Version History
-
-### Development Build: v1.3.0-rc4+dev20
-- Remove unnecessary parentheses around return values.
-- See <https://github.com/nasa/sample_lib/pull/84>
-
-### Development Build: v1.3.0-rc4+dev16
-
-- Update Copyright Headers
-- Standardize version.h 
-- See <https://github.com/nasa/sample_lib/pull/80> and <https://github.com/nasa/cFS/445>
-### Development Build: v1.3.0-rc4+dev9
-
-- Apply header guard standard 
-- Remove explicit filename doxygen comments 
-- See <https://github.com/nasa/cFS/pull/432>
-
-### Development Build: v1.3.0-rc4+dev3
-
-- Update baseline to cFS-Caelum-rc4: v1.3.0-rc4
-- See <https://github.com/nasa/cfs/issues/390>
-
-### Development Build: v1.2.0-rc1+dev38
-
--  Implement Coding Standard in CodeQL workflow
-- See <https://github.com/nasa/sample_lib/pull/64> and <https://github.com/nasa/cFS/pull/270>
-
-### Development Build: v1.2.0-rc1+dev34
-
-- Replace direct ref to ArgPtr with `UT_Hook_GetArgValueByName` macro. Reading the pointer directly is not advised.
-- See <https://github.com/nasa/sample_lib/pull/61> and <https://github.com/nasa/cFS/pull/250>
-
-### Development Build: v1.2.0-rc1+dev30
-
-- Replace <> with " for local includes
-- Adds CONTRIBUTING.md that links to the main cFS contributing guide.
-- See <https://github.com/nasa/sample_lib/pull/55>
-
-### Development Build: v1.2.0-rc1+dev24
-
-- Simplify build to use wrappers and interface libs
-- Add Testing Tools to the Security Policy
-- See <https://github.com/nasa/sample_lib/pull/50>
-
-### Development Build: v1.2.0-rc1+dev10
-
-- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing
-- See <https://github.com/nasa/sample_lib/pull/38>
-
-### Development Build: v1.2.0-rc1+dev8
-
-- No behavior changes. All identifiers now use the prefix `SAMPLE_LIB_`. Changes the name of the init function from SAMPLE_LibInit to SAMPLE_LIB_Init which affects the CFE startup script.
-- Set REVISION to "99" to indicate development version status
-- See <https://github.com/nasa/sample_lib/pull/35>
-
-### Development Build: v1.2.0-rc1+dev3
-
-- Installs unit test to target directory.
-- See <https://github.com/nasa/sample_lib/pull/32>
-
-### Development Build: 1.1.0+dev27
-
-- Install unit test as part of cmake recipe. Sample lib test runner now shows up in expected install directory
-- Add build number and baseline to version reporting
-- See <https://github.com/nasa/sample_lib/pull/28>
-
-### Development Build: 1.1.4
-
-- Apply code style
-- See <https://github.com/nasa/sample_lib/pull/24>
-
-### Development Build: 1.1.3
-
-- Coverage data `make lcov` includes the sample_lib code
-- See <https://github.com/nasa/sample_lib/pull/22>
-
-### Development Build: 1.1.2
-
-- Added coverage test and a stub library to facilitate unit test
-- See <https://github.com/nasa/sample_lib/pull/16>
-
-### Development Build: 1.1.1
-
-- See <https://github.com/nasa/sample_lib/pull/14>
-
-### ***OFFICIAL RELEASE: 1.1.0 - Aquila***
-
-- Released as part of cFE 6.7.0, Apache 2.0
-- See <https://github.com/nasa/sample_lib/pull/6>
-
-### ***OFFICIAL RELEASE: 1.0.0a***
-
-- Released as part of cFE 6.6.0a, Apache 2.0
-
 ## Known issues
 
 As a lab library, extensive testing is not performed prior to release and only minimal functionality is included.

diff --git a/fsw/src/sample_lib.c b/fsw/src/sample_lib.c
@@ -64,8 +64,7 @@ int32 SAMPLE_LIB_Init(void)
     OS_printf("SAMPLE Lib Initialized.%s\n", SAMPLE_LIB_VERSION_STRING);
 
     return CFE_SUCCESS;
-
-} /* End SAMPLE_LIB_Init */
+}
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /*                                                                 */
@@ -77,9 +76,4 @@ int32 SAMPLE_LIB_Function(void)
     OS_printf("SAMPLE_LIB_Function called, buffer=\'%s\'\n", SAMPLE_LIB_Buffer);
 
     return CFE_SUCCESS;
-
-} /* End SAMPLE_LIB_Function */
-
-/************************/
-/*  End of File Comment */
-/************************/
+}
diff --git a/fsw/src/sample_lib_version.h b/fsw/src/sample_lib_version.h
@@ -26,7 +26,7 @@
 
 /* Development Build Macro Definitions */
 
-#define SAMPLE_LIB_BUILD_NUMBER 20 /*!< Development Build: Number of commits since baseline */
+#define SAMPLE_LIB_BUILD_NUMBER 28 /*!< Development Build: Number of commits since baseline */
 #define SAMPLE_LIB_BUILD_BASELINE \
     "v1.3.0-rc4" /*!< Development Build: git tag that is the base for the current development */
 

diff --git a/unit-test/inc/OCS_string.h b/unit-test/inc/OCS_string.h
@@ -32,7 +32,7 @@
 #define OSC_STRING_H
 
 /* ----------------------------------------- */
-/* prototypes normally declared in string.h */
+/* prototypes normally declared in string.h  */
 /* ----------------------------------------- */
 
 extern char *OCS_strncpy(char *dest, const char *src, unsigned long size);

diff --git a/unit-test/override_inc/string.h b/unit-test/override_inc/string.h
@@ -34,7 +34,7 @@
 #include "OCS_string.h"
 
 /* ----------------------------------------- */
-/* mappings for declarations in string.h */
+/* mappings for declarations in string.h     */
 /* ----------------------------------------- */
 
 #define strncpy OCS_strncpy

diff --git a/ut-stubs/sample_lib_stubs.c b/ut-stubs/sample_lib_stubs.c
@@ -61,8 +61,7 @@ int32 SAMPLE_LIB_Init(void)
      * case configures something different.
      */
     return UT_DEFAULT_IMPL(SAMPLE_LIB_Init);
-
-} /* End SAMPLE_LIB_Init */
+}
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /*                                                                 */
@@ -72,4 +71,4 @@ int32 SAMPLE_LIB_Init(void)
 int32 SAMPLE_LIB_Function(void)
 {
     return UT_DEFAULT_IMPL(SAMPLE_LIB_Function);
-} /* End SAMPLE_LIB_Function */
+}