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 #574, Document UtAssert_Message parameters #713

Merged

Conversation

skliper
Copy link
Contributor

@skliper skliper commented Dec 29, 2020

Describe the contribution
Fix #574 - document UtAssert_Message parameters, also adds see also for helper macros

Testing performed
CI, comment change only.

Expected behavior changes
None

System(s) tested on
N/A

Additional context
Worth considering making this internal, no identified use case for direct call. Would be confusing to output any message other than info/debug.

Third party code
None.

Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman - NASA/GSFC

@skliper skliper added unit-test Tickets related to the OSAL unit testing (functional and/or coverage) CCB:FastTrack labels Dec 29, 2020
@skliper skliper added this to the 6.0.0 milestone Dec 29, 2020
@skliper
Copy link
Contributor Author

skliper commented Dec 29, 2020

Ping @asgibson - do you have a use case for calling this directly? Expectation in test cases is to use the UtPrintf and UtDebug helper marcos.

@asgibson
Copy link
Contributor

I do not think I had a use case in mind when I found it. I was looking to solve a problem which ended up unrelated to this and happened to notice it. After looking at the other message types defined, I also see no reason for this to be available to unit testers. The only level above the two defined that you mentioned is the default, "OTHER".

@astrogeco astrogeco changed the base branch from main to integration-candidate January 6, 2021 00:38
@astrogeco astrogeco merged commit ea39bb1 into nasa:integration-candidate Jan 6, 2021
@skliper skliper deleted the fix574_utassert-msg-params branch February 1, 2021 21:35
jphickey pushed a commit to jphickey/osal that referenced this pull request Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:FastTrack unit-test Tickets related to the OSAL unit testing (functional and/or coverage)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UtAssert_Message doxygen comments should include params
4 participants