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.

Sign up for GitHub

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

Jump to bottom

Add doxygen dependencies to "doc-prebuild" abstract target #1339

Closed
jphickey opened this issue Nov 23, 2022 · 0 comments · Fixed by #1341
Closed

Add doxygen dependencies to "doc-prebuild" abstract target #1339

jphickey opened this issue Nov 23, 2022 · 0 comments · Fixed by #1341
Assignees
@jphickey
Labels
draco-rc4 enhancement
Milestone
Draco

Comments

@jphickey
Copy link
Contributor

Is your feature request related to a problem? Please describe.
nasa/cFE#2214 adds an abstract target for dependencies of the documentation build. Currently OSAL requires generating the file osal-public-api.doxyfile before documentation builds are run, so this should be registered as a dependency.

This only affects documentation builds of CFE and CFS apps that in turn include OSAL headers as part of the document. These are depending on some artifacts that are generated by the OSAL build recipe.

Describe the solution you'd like
Add dependencies so that CFE and CFS app documentation builds that refer to OSAL files will work.

Additional context
See nasa/cFE#2214 and nasa/CF#344 for more context

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey self-assigned this Nov 23, 2022
jphickey added a commit to jphickey/osal that referenced this issue Nov 23, 2022
@jphickey
Fix nasa#1339, add doc-prebuild dependency
2b30fe0 
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 mentioned this issue Nov 23, 2022
Merged
2 tasks
dzbaker added a commit that referenced this issue Dec 6, 2022
@dzbaker
Merge pull request #1341 from jphickey/fix-1339-doc-dependencies
2ff34b4 
Fix #1339, add doc-prebuild dependency
@dzbaker dzbaker mentioned this issue Dec 6, 2022
Merged
2 tasks
@dzbaker dzbaker closed this as completed in 057a371 Dec 6, 2022
@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
Assignees

@jphickey jphickey

Labels
draco-rc4 enhancement
Projects
None yet
Milestone
Draco
Development

Successfully merging a pull request may close this issue.

Fix #1339, add doc-prebuild dependency jphickey/osal
2 participants
@jphickey @dmknutsen