Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #1349, remove unneeded CFE_ES_SYSLOG_APPEND macro #1368

Merged

Conversation

jphickey
Copy link
Contributor

Describe the contribution

Replace uses of this internal macro with the CFE_ES_WriteToSysLog() API.

Fixes #1349

Testing performed
Build and sanity check, run all unit tests

Expected behavior changes
None

System(s) tested on
Ubuntu 20.04

Additional context
Coding standards discourage use of multi-line macros, and for the 3 remaining uses there is no compelling reason not to just use the standard public API.

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Apr 16, 2021
@skliper
Copy link
Contributor

skliper commented Apr 20, 2021

Related to #409

@jphickey
Copy link
Contributor Author

Updated, I noticed I missed the change of CFE_ES_SysLog_snprintf to basic snprintf, which would have resulted in a double timestamp (fixed now). Also noticed that one of the functions didn't even do any syslog so it can be completely removed.

Replace remaining uses of this internal macro with the
CFE_ES_WriteToSysLog API.
@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB CFS-40 labels Apr 21, 2021
@astrogeco
Copy link
Contributor

CCB:2021-04-21 APPROVED

  • Not worth having a macro that doesn't follow the coding standard

@astrogeco astrogeco removed the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Apr 28, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate April 28, 2021 01:27
@astrogeco astrogeco merged commit 628c150 into nasa:integration-candidate Apr 28, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 28, 2021
nasa/cFE#1385, exception logic when app/task is not found
nasa/cFE#1372, error if alignment size not a power of two
nasa/cFE#1368, remove unneeded CFE_ES_SYSLOG_APPEND macro
nasa/cFE#1382, improve documentation for resourceID patterns
nasa/cFE#1371, assert `CFE_RESOURCEID_MAX` is a bitmask
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 29, 2021
Combines:

nasa/cFE#1431
nasa/osal#975
nasa/sample_lib#61

Includes:

nasa/cFE#1379, memory pool pointer type
nasa/cFE#1289, ES child task functional test
nasa/cFE#1289, typo in macro name
nasa/cFE#1286, Remove broken BUILDDIR reference
nasa/cFE#1305, remove option for "osal_compatible"
nasa/cFE#1374, CFE_SUCCESS constant type
nasa/cFE#1316, Remove Unused Error Codes
nasa/cFE#1370, better warning about malformed startup line
nasa/cFE#1373, check status of call to `CFE_ES_CDS_CachePreload`
nasa/cFE#1384, update documentation for `CFE_ES_DeleteCDS`
nasa/cFE#1385, exception logic when app/task is not found
nasa/cFE#1372, error if alignment size not a power of two
nasa/cFE#1368, remove unneeded CFE_ES_SYSLOG_APPEND macro
nasa/cFE#1382, improve documentation for resourceID patterns
nasa/cFE#1371, assert `CFE_RESOURCEID_MAX` is a bitmask

nasa/osal#972, update documentation for read/write
nasa/osal#966, add "handler" feature to utassert stub API
nasa/osal#953, Adds local makefile and bundle/local unit test actions with coverage verification
nasa/osal#971, socket accept using incorrect record
nasa/osal#959, move async console option

nasa/sample_lib#60, replace direct ref to ArgPtr with macro
@jphickey jphickey deleted the fix-1349-append-macro branch May 14, 2021 14:23
@skliper skliper added this to the 7.0.0 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB CFS-40
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace multiline CFE_ES_SYSLOG_APPEND macro with inline function
3 participants