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

Documentation builds should use separate directories #1378

Closed
jphickey opened this issue Apr 19, 2021 · 2 comments · Fixed by #1612 or #1619
Closed

Documentation builds should use separate directories #1378

jphickey opened this issue Apr 19, 2021 · 2 comments · Fixed by #1612 or #1619
Labels
enhancement
Milestone
Caelum

Comments

@jphickey
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The 3 documentation targets (detaildesign, usersguide, osalguide) all share the same "doc" subdirectory for the doxygen run. This can become a problem when trying to validate documentation builds and building with the -j option. They work fine when built one at a time, but with -j at one point my machine got into an endless loop with two doxygen builds running in parallel that kept stepping on the other's files.

Describe the solution you'd like
Use separate dirs so that builds can be done in parallel without interfering with each other.

Additional context
This should also result in separate "warnings.log" files too, that can be more easily checked.

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@skliper
Copy link
Contributor

skliper commented Apr 19, 2021

Related to #389

@skliper skliper mentioned this issue May 28, 2021
Closed
@jphickey
Copy link
Contributor Author

After nasa/osal#1033 and #1561 this fixes half of the issue - now just between the detail design and user guide sharing the same subdirectory and "warnings.log" file.

jphickey added a commit to jphickey/cFE that referenced this issue Jun 8, 2021
@jphickey
Fix nasa#1378, simplify doxygen configs
c742819 
Put the "detaildesign" and "users_guide" into separate working
directories, and do a general cleanup/simplification of the generated
doxyfiles.

Detail design just includes all components, and use "exclude" where
special treatment was needed, and to avoid UT code.

Paths for each "arch" (target-specific) are written to separate files
and included directly in the generated doxyfile, reducing the number
of generated files/layers.
@jphickey jphickey mentioned this issue Jun 8, 2021
Merged
jphickey added a commit to jphickey/cFE that referenced this issue Jun 9, 2021
@jphickey
Fix nasa#1378, simplify doxygen configs
d89c7ce 
Put the "detaildesign" and "users_guide" into separate working
directories, and do a general cleanup/simplification of the generated
doxyfiles.

Detail design just includes all components, and use "exclude" where
special treatment was needed, and to avoid UT code.

Paths for each "arch" (target-specific) are written to separate files
and included directly in the generated doxyfile, reducing the number
of generated files/layers.
jphickey added a commit that referenced this issue Jun 15, 2021
@jphickey
Merge pull request #1612 from jphickey/fix-1378-1589-doxygen-cleanup
e54e908 
Fix #1378, 1589, doxygen cleanup
@astrogeco astrogeco mentioned this issue Jun 16, 2021
Merged
@skliper skliper added this to the 7.0.0 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
Caelum
Development

Successfully merging a pull request may close this issue.

Fix #1378, 1589, doxygen cleanup jphickey/cFE
cFE Integration candidate: 2021-06-15 nasa/cFE
2 participants
@jphickey @skliper