From 3705985fbd58d5699e242a02539c68902142b7d5 Mon Sep 17 00:00:00 2001 From: Avi Date: Fri, 30 Sep 2022 22:47:38 +1000 Subject: [PATCH] Fix #128, Create CHANGELOG.md --- CHANGELOG.md | 163 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 154 ------------------------------------------------ 2 files changed, 163 insertions(+), 154 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..397798e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,163 @@ +# Changelog + +## Development Build: v2.5.0-rc4+dev23 +- Update cmake mimimum required to something more recent +- See + +## Development Build: v2.5.0-rc4+dev21 + +- Remove registration of empty EVS filters +- Update codeql workflow for reusable updates +- See + + +## Development Build: v2.5.0-rc4+dev16 + +- Update Copyright Headers +- Standardize version.h +- See and + +## Development Build: v2.5.0-rc4+dev9 + +- Apply header guard standard +- See + +## Development Build: v2.5.0-rc4+dev4 + +- Use CFE_MSG_PTR conversion macro +- Set new baseline for cFS-Caelum-rc4: v2.5.0-rc4 +- See and + +## Development Build: v2.4.0-rc1+dev58 + +- Apply CFE_SB_ValueToMsgId where required +- See and + +## Development Build: v2.4.0-rc1+dev49 + +- Implement Coding Standard in CodeQL workflow +- See and + +## Development Build: v2.4.0-rc1+dev47 + +- Removes app registration call, `CFE_ES_RegisterApp()` since applications do not need to register themselves. +- See + +## Development Build: v2.4.0-rc1+dev41 + +- Use `cfe.h` header file +- See + +## Development Build: v2.4.0-rc1+dev38 + +- Remove numeric pipe ID from event printf +- Add Testing Tools to the Security Policy +- See + +## Development Build: v.2.4.0-rc1+dev32 + +- Removes end-of-function comments in `to_lab_app.c` +- Adds static analysis and code format check to continuous integration workflow. Updates workflow status badges in ReadMe +- Adds CodeQL analysis to continuous integration workflow +- See + +## Development Build: v.2.4.0-rc1+dev21 + +- TO remains command-able after a "remove all subscriptions" command; the command now only removes all subscriptions to the Tlm_pipe +- See + +## Development Build: v.2.4.0-rc1+dev17 + +- Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition +- See + +## Development Build: v.2.4.0-rc1+dev13 + +- Replaces deprecated SB API's with MSG +- See + +## Development Build: v.2.4.0-rc1+dev9 + +- Update the TLMsockid field to be `osal_id_t` instead of uint32 +- Set revision number to 99 to indicate development status in telemetry +- See + +## Development Build: v.2.4.0-rc1+dev6 + +- Adds header guard to `to_lab_sub_table.h` +- See + +## Development Build: v.2.4.0-rc1+dev3 + +- Remove reference to deprecated `CFE_ES_SHELL_TLM_MID`. +- See + +## Development Build: v2.3.0+dev45 + +- Fixes bug where an unset address values caused subscriptions to MsgId 0 over 200 times. Added a `TO_UNUSED` entry at the end of the subscription list and a break in the subscription loop when `TO_UNUSED` found. No more subscriptions on the unused table slots (no MsgId 0 subscriptions). +- Corrects return value of `TO_LAB_init()` to be `int32` instead of `int`. Declaration now matches definition, and app builds without errors. +- Add build number and baseline to version reporting. +- See + +## Development Build: v2.3.7 + +- Makes the `TO_LAB_Subs` table into a CFE_TBL-managed table. +- See + + +## Development Build: v2.3.6 + +- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. +- See + +## Development Build: v2.3.5 + +- Apply code style +- See + +## Development Build: v2.3.4 + +- Configure the maximum depth supported by OSAL, rather than a hard coded 64. +- See + +## Development Build: v2.3.3 + +- Apply 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. +- Deprecates shell tlm subscription +- Changes to documentation +- See + +## Development Build: v2.3.2 + +- Use OSAL socket API instead of BSD Sockets + +- Use global namespace to isolate variables + +- Minor updates (see ) + +## Development Build: v2.3.1 + +- Fix for a clean build with OMIT_DEPRECATED +- Minor updates (see ) + +## _**OFFICIAL RELEASE: 2.3.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: 2.2.0a**_ + +- Released as part of cFE 6.6.0a, Apache 2.0 + +## Known issues + +As a lab application, 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 . + +Official cFS page: diff --git a/README.md b/README.md index 0cc9f24..9144e1e 100644 --- a/README.md +++ b/README.md @@ -11,160 +11,6 @@ to_lab is a simple telemetry downlink application that sends CCSDS telecommand p To send telemetry to the "ground" or UDP/IP port, edit the subscription table in the platform include file: fsw/platform_inc/to_lab_sub_table.h. to_lab will subscribe to the packet IDs that are listed in this table and send the telemetry packets it receives to the UDP/IP port. -## Version History - -### Development Build: v2.5.0-rc4+dev23 -- Update cmake mimimum required to something more recent -- See - -### Development Build: v2.5.0-rc4+dev21 - -- Remove registration of empty EVS filters -- Update codeql workflow for reusable updates -- See - - -### Development Build: v2.5.0-rc4+dev16 - -- Update Copyright Headers -- Standardize version.h -- See and - -### Development Build: v2.5.0-rc4+dev9 - -- Apply header guard standard -- See - -### Development Build: v2.5.0-rc4+dev4 - -- Use CFE_MSG_PTR conversion macro -- Set new baseline for cFS-Caelum-rc4: v2.5.0-rc4 -- See and - -### Development Build: v2.4.0-rc1+dev58 - -- Apply CFE_SB_ValueToMsgId where required -- See and - -### Development Build: v2.4.0-rc1+dev49 - -- Implement Coding Standard in CodeQL workflow -- See and - -### Development Build: v2.4.0-rc1+dev47 - -- Removes app registration call, `CFE_ES_RegisterApp()` since applications do not need to register themselves. -- See - -### Development Build: v2.4.0-rc1+dev41 - -- Use `cfe.h` header file -- See - -### Development Build: v2.4.0-rc1+dev38 - -- Remove numeric pipe ID from event printf -- Add Testing Tools to the Security Policy -- See - -### Development Build: v.2.4.0-rc1+dev32 - -- Removes end-of-function comments in `to_lab_app.c` -- Adds static analysis and code format check to continuous integration workflow. Updates workflow status badges in ReadMe -- Adds CodeQL analysis to continuous integration workflow -- See - -### Development Build: v.2.4.0-rc1+dev21 - -- TO remains command-able after a "remove all subscriptions" command; the command now only removes all subscriptions to the Tlm_pipe -- See - -### Development Build: v.2.4.0-rc1+dev17 - -- Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition -- See - -### Development Build: v.2.4.0-rc1+dev13 - -- Replaces deprecated SB API's with MSG -- See - -### Development Build: v.2.4.0-rc1+dev9 - -- Update the TLMsockid field to be `osal_id_t` instead of uint32 -- Set revision number to 99 to indicate development status in telemetry -- See - -### Development Build: v.2.4.0-rc1+dev6 - -- Adds header guard to `to_lab_sub_table.h` -- See - -### Development Build: v.2.4.0-rc1+dev3 - -- Remove reference to deprecated `CFE_ES_SHELL_TLM_MID`. -- See - -### Development Build: v2.3.0+dev45 - -- Fixes bug where an unset address values caused subscriptions to MsgId 0 over 200 times. Added a `TO_UNUSED` entry at the end of the subscription list and a break in the subscription loop when `TO_UNUSED` found. No more subscriptions on the unused table slots (no MsgId 0 subscriptions). -- Corrects return value of `TO_LAB_init()` to be `int32` instead of `int`. Declaration now matches definition, and app builds without errors. -- Add build number and baseline to version reporting. -- See - -### Development Build: v2.3.7 - -- Makes the `TO_LAB_Subs` table into a CFE_TBL-managed table. -- See - - -### Development Build: v2.3.6 - -- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. -- See - -### Development Build: v2.3.5 - -- Apply code style -- See - -### Development Build: v2.3.4 - -- Configure the maximum depth supported by OSAL, rather than a hard coded 64. -- See - -### Development Build: v2.3.3 - -- Apply 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. -- Deprecates shell tlm subscription -- Changes to documentation -- See - -### Development Build: v2.3.2 - -- Use OSAL socket API instead of BSD Sockets - -- Use global namespace to isolate variables - -- Minor updates (see ) - -### Development Build: v2.3.1 - -- Fix for a clean build with OMIT_DEPRECATED -- Minor updates (see ) - -### _**OFFICIAL RELEASE: 2.3.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: 2.2.0a**_ - -- Released as part of cFE 6.6.0a, Apache 2.0 - ## Known issues As a lab application, extensive testing is not performed prior to release and only minimal functionality is included.