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 #1339, add doc-prebuild dependency #1341

Merged
merged 1 commit into from
Dec 6, 2022

Conversation

jphickey
Copy link
Contributor

Checklist (Please check before submitting)

Describe the contribution
When building as part of CFE/CFS, register the osal header list file (osal-public-api.doxyfile) as a dependency of the doc-prebuild abstract target. This way, CFE and any other CFS apps that refer to the OSAL headers in their documentation can easily ensure that this (and any other file produced by other modules) exist prior to attempting to run doxygen.

Fixes #1339

Testing performed
Build documentation

Expected behavior changes
None directly to OSAL, but dependent items can now operate correctly

System(s) tested on
Github hosted runner

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

When building as part of CFE/CFS, register the osal header list file
(osal-public-api.doxyfile) as a dependency of the doc-prebuild abstract
target.  This way, CFE and any other CFS apps that refer to the OSAL
headers in their documentation can easily ensure that this (and any
other file produced by other modules) exist prior to attempting to run
doxygen.
@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Nov 25, 2022
@dzbaker dzbaker 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 Dec 1, 2022
dzbaker added a commit to nasa/cFS that referenced this pull request Dec 6, 2022
*Combines:*

osal v6.0.0-rc4+dev173
cFE v7.0.0-rc4+dev229

**Includes:**

*cFS*
- #622
- #625
- #626
- #582

*osal*
- nasa/osal#1342
- nasa/osal#1341
- nasa/osal#1321

*cFE*
- nasa/cFE#2215
- nasa/cFE#2219
- nasa/cFE#2217
- nasa/cFE#2222

Co-authored by: Joseph Hickey <[email protected]>
Co-authored by: Daniel Knutsen <[email protected]>
Co-authored by: Avi Weiss: <[email protected]>
@dzbaker dzbaker merged commit 2ff34b4 into nasa:main Dec 6, 2022
dzbaker added a commit to nasa/cFS that referenced this pull request Dec 6, 2022
*Combines:*

osal v6.0.0-rc4+dev173
cFE v7.0.0-rc4+dev229

**Includes:**

*cFS*
- #622
- #625
- #626
- #582

*osal*
- nasa/osal#1342
- nasa/osal#1341
- nasa/osal#1321

*cFE*
- nasa/cFE#2215
- nasa/cFE#2219
- nasa/cFE#2217
- nasa/cFE#2222

Co-authored by: Joseph Hickey <[email protected]>
Co-authored by: Daniel Knutsen <[email protected]>
Co-authored by: Avi Weiss: <[email protected]>
@jphickey jphickey deleted the fix-1339-doc-dependencies branch December 8, 2022 22:07
@dmknutsen dmknutsen added this to the Draco milestone Jan 18, 2023
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 draco-rc4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add doxygen dependencies to "doc-prebuild" abstract target
3 participants