diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..088cca3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,149 @@ +# Changelog + +## Development Build: v1.3.0-rc4+dev27 +- Misaligned comments +- Remove unnecessary parentheses around return values. +- Remove 'return;' from last line of void functions. +- See , , and + +## Development Build: v1.3.0-rc4+dev21 +- Remove registration of empty event filters +- Update codeql workflow for reusable updates +- See + +## Development Build: v1.3.0-rc4+dev16 +- Update copyright headers +- Standardize version information +- See and + +## Development Build: v1.3.0-rc4+dev9 +- Use preferred UT patterns +- Reuse CodeQL, Static Analysis, and Format Check +- See + +## Development Build: v1.3.0-rc4+dev4 +- Use CFE_MSG_PTR conversion macro +- Update baseline for cFS-Caelum-rc4 to v1.3.0-rc4 +- See and + +## Development Build: v1.2.0-rc1+dev73 +- Apply CFE_SB_ValueToMsgId where required +- See and + +## Development Build: v1.2.0-rc1+dev66 +- Implement Coding Standard in CodeQL workflow +- See and + +## Development Build: v1.2.0-rc1+dev62 +- Removes app registration call, `CFE_ES_RegisterApp()` since applications do not need to register themselves. +- Apply standard header guard on all header files by removing leading underscore. Convert file-scope block comments to doxygen format. +- See + +## Development Build: v1.2.0-rc1+dev56 +- Replaces <> with " in local includes +- Adds CONTRIBUTING.md that links to the main cFS contributing guide. +- Adds a description for the requirements of command and telemetry Message IDs to explain why the Msg IDs have those requirements in documentation. +- See + +## Development Build: v1.2.0-rc1+dev48 +- Simplify build to use wrappers and interface libs +- Add Testing Tools to the Security Policy +- See + +## Development Build: v1.2.0-rc1+dev37 +- Documentation: Add `Security.md` with instructions on reporting vulnerabilities +- Resolves bug where success code was reported as an error for `CFE_TBL_GetAddress`. +- Rename `UT_ClearForceFail` as `UT_ClearDefaultValue` given change from +- See + +## Development Build: v1.2.0-rc1+dev29 +- Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition +- See + +## Development Build: v1.2.0-rc1+dev25 +- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing +- See + +## Development Build: v1.2.0-rc1+dev22 +- Replaces deprecated SB API's with MSG +- No impact, removes undesirable pattern use of `OS_PACK` +- See + +## Development Build: v1.2.0-rc1+dev18 +- No behavior changes. All identifiers now use the prefix `SAMPLE_APP_`. Changes the name of the main function from SAMPLE_AppMain to SAMPLE_APP_Main which affects the CFE startup script. +- Set REVISION to "99" to indicate development version status +- See + +## Development Build: v1.2.0-rc1+dev13 +- Unit test MID string format now 32bit +- Installs unit test to target directory +- Checks only format string in UT event test +- See + +## Development Build: v1.2.0-rc1+dev5 +- Applies standard coding style. +- Removes test code call of CFE_SB_InitMsg and sets the API/stub buffers directly. +- See + +## Development Build: 1.1.0+dev65 +- Add build number and baseline to version report +- Install unit test as part of cmake recipe. Sample app test runner now shows up in expected install directory +- See + +## Development Build: 1.1.11 +- Move the table to fsw/tables and renames "sample_table" to "sample_app_table +- See + +## Development Build: 1.1.10 +- Test cases now compare an expected event string with a string derived from the spec string and arguments that were output by the unit under test. +- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. +- See + +## Development Build: 1.1.9 +- Applies the CFE_SB_MsgIdToValue() and CFE_SB_ValueToMsgId() routines where compatibility with an integer MsgId is necessary - syslog prints, events, compile-time MID #define values. +- No more format conversion error in RTEMS build +- See + +## Development Build: 1.1.8 +- Coverage data from make lcov includes the sample_app code +- See + +## Development Build: 1.1.7 +- Fix bug where table is not released after being used +- Minor updates (see ) + +## Development Build: 1.1.6 +- Minor updates (see ) + +## Development Build: 1.1.5 +- Fix to build on RASPBIAN OS +- Minor updates (see ) + +## Development Build: 1.1.4 +- Fix for a clean build with OMIT_DEPRECATED +- Minor updates (see ) + +## Development Build: 1.1.3 +- Minor updates (see ) + +## Development Build: 1.1.2 +- Minor updates (see ) + +## Development Build: 1.1.1 +- Minor updates (see ) + +## _**OFFICIAL RELEASE: 1.1.0 - Aquila**_ +- Minor updates (see ) +- Not backwards compatible with OSAL 4.2.1 +- Released as part of cFE 6.7.0, Apache 2.0 + +## _**OFFICIAL RELEASE: 1.0.0a**_ +- Released as part of cFE 6.6.0a, Apache 2.0 + +## Known issues +As a sample application, extensive testing is not performed prior to release and only minimal functionality is included. Note discrepancies likely exist between this application and the example detailed in the application developer guide. + +## Getting Help +For best results, submit issues:questions or issues:help wanted requests at . + +Official cFS page: diff --git a/README.md b/README.md index 0f2b5da..5c69ebb 100644 --- a/README.md +++ b/README.md @@ -9,179 +9,6 @@ This sample application is a non-flight example application implementation for t sample_app is an example for how to build and link an application in cFS. See also the skeleton_app () if you are looking for a bare-bones application to which to add your business logic. -## Version History - -### Development Build: v1.3.0-rc4+dev27 -- Misaligned comments -- Remove unnecessary parentheses around return values. -- Remove 'return;' from last line of void functions. -- See , , and - -### Development Build: v1.3.0-rc4+dev21 - -- Remove registration of empty event filters -- Update codeql workflow for reusable updates -- See - -### Development Build: v1.3.0-rc4+dev16 - -- Update copyright headers -- Standardize version information -- See and -### Development Build: v1.3.0-rc4+dev9 - -- Use preferred UT patterns -- Reuse CodeQL, Static Analysis, and Format Check -- See - -### Development Build: v1.3.0-rc4+dev4 - -- Use CFE_MSG_PTR conversion macro -- Update baseline for cFS-Caelum-rc4 to v1.3.0-rc4 -- See and - -### Development Build: v1.2.0-rc1+dev73 - -- Apply CFE_SB_ValueToMsgId where required -- See and -### Development Build: v1.2.0-rc1+dev66 - -- Implement Coding Standard in CodeQL workflow -- See and - -### Development Build: v1.2.0-rc1+dev62 - -- Removes app registration call, `CFE_ES_RegisterApp()` since applications do not need to register themselves. -- Apply standard header guard on all header files by removing leading underscore. Convert file-scope block comments to doxygen format. -- See - - -### Development Build: v1.2.0-rc1+dev56 - -- Replaces <> with " in local includes -- Adds CONTRIBUTING.md that links to the main cFS contributing guide. -- Adds a description for the requirements of command and telemetry Message IDs to explain why the Msg IDs have those requirements in documentation. -- See - -### Development Build: v1.2.0-rc1+dev48 - -- Simplify build to use wrappers and interface libs -- Add Testing Tools to the Security Policy -- See - -### Development Build: v1.2.0-rc1+dev37 - -- Documentation: Add `Security.md` with instructions on reporting vulnerabilities -- Resolves bug where success code was reported as an error for `CFE_TBL_GetAddress`. -- Rename `UT_ClearForceFail` as `UT_ClearDefaultValue` given change from -- See - -### Development Build: v1.2.0-rc1+dev29 - -- Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition -- See - - -### Development Build: v1.2.0-rc1+dev25 - -- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing -- See - - -### Development Build: v1.2.0-rc1+dev22 - -- Replaces deprecated SB API's with MSG -- No impact, removes undesirable pattern use of `OS_PACK` -- See - -### Development Build: v1.2.0-rc1+dev18 - -- No behavior changes. All identifiers now use the prefix `SAMPLE_APP_`. Changes the name of the main function from SAMPLE_AppMain to SAMPLE_APP_Main which affects the CFE startup script. -- Set REVISION to "99" to indicate development version status -- See - -### Development Build: v1.2.0-rc1+dev13 - -- Unit test MID string format now 32bit -- Installs unit test to target directory -- Checks only format string in UT event test -- See - -### Development Build: v1.2.0-rc1+dev5 - -- Applies standard coding style. -- Removes test code call of CFE_SB_InitMsg and sets the API/stub buffers directly. -- See - -### Development Build: 1.1.0+dev65 - -- Add build number and baseline to version report -- Install unit test as part of cmake recipe. Sample app test runner now shows up in expected install directory -- See - -### Development Build: 1.1.11 - -- Move the table to fsw/tables and renames "sample_table" to "sample_app_table -- See - -### Development Build: 1.1.10 - -- Test cases now compare an expected event string with a string derived from the spec string and arguments that were output by the unit under test. -- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. -- See - -### Development Build: 1.1.9 - -- Applies the CFE_SB_MsgIdToValue() and CFE_SB_ValueToMsgId() routines where compatibility with an integer MsgId is necessary - syslog prints, events, compile-time MID #define values. -- No more format conversion error in RTEMS build -- See - -### Development Build: 1.1.8 - -- Coverage data from make lcov includes the sample_app code -- See - -### Development Build: 1.1.7 - -- Fix bug where table is not released after being used -- Minor updates (see ) - -### Development Build: 1.1.6 - -- Minor updates (see ) - -### Development Build: 1.1.5 - -- Fix to build on RASPBIAN OS -- Minor updates (see ) - -### Development Build: 1.1.4 - -- Fix for a clean build with OMIT_DEPRECATED -- Minor updates (see ) - -### Development Build: 1.1.3 - -- Minor updates (see ) - -### Development Build: 1.1.2 - -- Minor updates (see ) - -### Development Build: 1.1.1 - -- Minor updates (see ) - -### _**OFFICIAL RELEASE: 1.1.0 - Aquila**_ - -- Minor updates (see ) -- Not backwards compatible with OSAL 4.2.1 -- Released as part of cFE 6.7.0, Apache 2.0 - -### _**OFFICIAL RELEASE: 1.0.0a**_ - -- Released as part of cFE 6.6.0a, Apache 2.0 - ## Known issues As a sample application, extensive testing is not performed prior to release and only minimal functionality is included. Note discrepancies likely exist between this application and the example detailed in the application developer guide.