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 abstract target for documentation dependencies #2214

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

Add abstract target for documentation dependencies #2214

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

Comments

@jphickey
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Both the CFE documentation as well as the CFS app documentation builds require certain generated files to exist before they can run. Currently the CFE itself solved this with a direct dependency on osal_public_api_headerlist but this is not ideal, because it is referring to a very specific OSAL target, which is based on the way OSAL documentation is currently implemented, but may not be so in the future.

Furthermore, the CFS app doc workflows do not have this, and thus the workflow fails.

Describe the solution you'd like
Add an abstract target for documentation, correlating to the existing mission-prebuild for source files, such as doc-prebuild. This can in turn depend on the specific targets that are needed to be created in order to build documentation. This allows all submodules to also add dependencies onto this target, in case they have an artifact that needs to be generated prior to building documentation.

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey self-assigned this Nov 23, 2022
This was referenced Nov 23, 2022
Closed
Merged
Merged
dzbaker added a commit that referenced this issue Dec 6, 2022
@dzbaker
Merge pull request #2215 from jphickey/fix-2214-doc-dependency-tgt
70906a7 
Fix #2214, add abstract documentation dependency target
@dzbaker dzbaker mentioned this issue Dec 6, 2022
Merged
2 tasks
@dzbaker dzbaker closed this as completed in e6454b2 Dec 6, 2022
@dmknutsen dmknutsen added this to the Draco milestone Jan 18, 2023
dzbaker added a commit to nasa/cFS that referenced this issue May 4, 2023
@dzbaker
IC: Caelum-rc4+dev49
3834b6f 
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
@dzbaker dzbaker mentioned this issue May 4, 2023
Merged
2 tasks
dzbaker added a commit to nasa/cFS that referenced this issue May 4, 2023
@dzbaker
IC: Caelum-rc4+dev49
17075e4 
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
dzbaker added a commit to nasa/cFS that referenced this issue May 4, 2023
@dzbaker
IC: Caelum-rc4+dev49
a0fea13 
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
dzbaker added a commit to nasa/cFS that referenced this issue May 4, 2023
@dzbaker
IC: Caelum-rc4+dev49
f0a0f53 
*Combines:*

cFE v7.0.0-rc4+dev304

**Includes:**

*cFE*
- nasa/cFE#2321
- nasa/cFE#2214
- nasa/cFE#2319

Co-authored by: Joseph Hickey <[email protected]>
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 #2214, add abstract documentation dependency target jphickey/cFE
2 participants
@jphickey @dmknutsen