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 #1048, filter only whole words for keyword match #1049

Merged

Conversation

jphickey
Copy link
Contributor

Describe the contribution
In the stub generator script, filter only whole words when ignoring keywords. Do not match if the word appears as a substring inside a larger word.

Fixes #1048

Testing performed
Regenerate stubs, and build and run all unit tests.

Expected behavior changes
Corrects the argument name in OS_TimeBaseCreate stub (only occurrence discovered so far)

System(s) tested on
Ubuntu

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

In the stub generator script, filter only whole words
when ignoring keywords.  Do not match if the word appears
as a substring inside a larger word.
Truncate input lines at C++-style comment markers, in case users/projects
allow this style of comment.
@jphickey
Copy link
Contributor Author

Note, it was brought to my attention that C++-style comments presented an issue for the script, they got incorrectly put into the output. Updated this issue/PR to also include a fix for that.

@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label May 25, 2021
@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels May 26, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate June 2, 2021 01:58
@astrogeco astrogeco merged commit d5d370a into nasa:integration-candidate Jun 2, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 2, 2021
Update nasa/osal#1058

Includes:

nasa/osal#1044, resolve discrepancies between mutex API and unit tests
nasa/osal#1038, resolve discrepancies between queue API and unit tests
nasa/osal#1037, resolve discrepancies between task API and unit tests
nasa/osal#1051, resolve discrepancies between timebase API and unit tests

nasa/osal#1030, check misc API return codes
nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
nasa/osal#1049, filter only whole words for keyword match
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 2, 2021
Update nasa/osal#1058

Includes:

nasa/osal#1044, resolve discrepancies between mutex API and unit tests
nasa/osal#1038, resolve discrepancies between queue API and unit tests
nasa/osal#1037, resolve discrepancies between task API and unit tests
nasa/osal#1051, resolve discrepancies between timebase API and unit tests

nasa/osal#1030, check misc API return codes
nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
nasa/osal#1049, filter only whole words for keyword match
@jphickey jphickey deleted the fix-1048-extern-strings branch June 8, 2021 18:22
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021
- #263, bundle

Combines:

- nasa/cFE#1584, v6.8.0-rc1+dev642
- nasa/osal#1058, v5.1.0-rc1+dev500
- nasa/sch_lab#82, v2.4.0-rc1+dev36

Includes:

- nasa/cFE#1580, Update ES verify errors to match test
- nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt
- nasa/cFE#1579, Improve event filter documentation
- nasa/cFE#1576, EVS/FS documentation cleanup
- nasa/cFE#1575, Remove shell file subtype and clarify scope
- nasa/cFE#1582, Simplify file open/truncate logic
- nasa/cFE#1567, Remove deprecated elements
- nasa/cFE#1556, Replace Header Content Type magic number
- nasa/cFE#1553, Remove unused EVS LogMode defines
- nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS
- nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers
- nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type
- nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling
- nasa/cFE#1560, Documentation cleanup in TBL/TIME
- nasa/cFE#1558, Document TblName as app specific
- nasa/cFE#1563, use OSAL script to generate API guide
- nasa/cFE#1557, Include verify headers to validate config
- nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals

- nasa/osal#1033, include doxygen targets locally
- nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public
- nasa/osal#1040, resolve discrepancies between binsem API and unit tests
- nasa/osal#1029, add missing clock retcode tests
- nasa/osal#1046, resolve discrepancies between common API and unit tests
- nasa/osal#1041, resolve discrepancies between countsem API and unit tests
- nasa/osal#1045, resolve discrepancies between dir API and unit tests
- nasa/osal#1043, resolve discrepancies between module API and unit tests
- nasa/osal#1044, resolve discrepancies between mutex API and unit tests
- nasa/osal#1038, resolve discrepancies between queue API and unit tests
- nasa/osal#1037, resolve discrepancies between task API and unit tests
- nasa/osal#1051, resolve discrepancies between timebase API and unit tests
- nasa/osal#1030, check misc API return codes
- nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
- nasa/osal#1049, filter only whole words for keyword match
- nasa/osal#962, update OSAL Config Guide link

- nasa/sch_lab#81, exit the main loop if init fails

- HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build
workflow errors,
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021
- #263, bundle

Combines:

- nasa/cFE#1584, v6.8.0-rc1+dev642
- nasa/osal#1058, v5.1.0-rc1+dev500
- nasa/sch_lab#82, v2.4.0-rc1+dev36

Includes:

- nasa/cFE#1580, Update ES verify errors to match test
- nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt
- nasa/cFE#1579, Improve event filter documentation
- nasa/cFE#1576, EVS/FS documentation cleanup
- nasa/cFE#1575, Remove shell file subtype and clarify scope
- nasa/cFE#1582, Simplify file open/truncate logic
- nasa/cFE#1567, Remove deprecated elements
- nasa/cFE#1556, Replace Header Content Type magic number
- nasa/cFE#1553, Remove unused EVS LogMode defines
- nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS
- nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers
- nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type
- nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling
- nasa/cFE#1560, Documentation cleanup in TBL/TIME
- nasa/cFE#1558, Document TblName as app specific
- nasa/cFE#1563, use OSAL script to generate API guide
- nasa/cFE#1557, Include verify headers to validate config
- nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals

- nasa/osal#1033, include doxygen targets locally
- nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public
- nasa/osal#1040, resolve discrepancies between binsem API and unit tests
- nasa/osal#1029, add missing clock retcode tests
- nasa/osal#1046, resolve discrepancies between common API and unit tests
- nasa/osal#1041, resolve discrepancies between countsem API and unit tests
- nasa/osal#1045, resolve discrepancies between dir API and unit tests
- nasa/osal#1043, resolve discrepancies between module API and unit tests
- nasa/osal#1044, resolve discrepancies between mutex API and unit tests
- nasa/osal#1038, resolve discrepancies between queue API and unit tests
- nasa/osal#1037, resolve discrepancies between task API and unit tests
- nasa/osal#1051, resolve discrepancies between timebase API and unit tests
- nasa/osal#1030, check misc API return codes
- nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
- nasa/osal#1049, filter only whole words for keyword match
- nasa/osal#962, update OSAL Config Guide link

- nasa/sch_lab#81, exit the main loop if init fails

- HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build
workflow errors,

Co-authored-by: Joseph Hickey <[email protected]>
Co-authored-by: Jake Hageman skliper <[email protected]>
Co-authored-by: Alex Campbell <[email protected]>
Co-authored-by: Ariel Adams <[email protected]>
Co-authored-by: Ross Peters <[email protected]>
@skliper skliper added this to the 6.0.0 milestone Sep 24, 2021
jphickey added a commit to jphickey/osal that referenced this pull request Aug 10, 2022
Use OS_FileSysStatVolume() instead.  This also enables the check
to be more appropriate as this call reports the number of total
blocks, not just the free blocks, so no workaround for desktop
machines is needed.
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:Approved Indicates code review and approval by community CCB
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stub generator script filtering all "extern" strings
3 participants