You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
In the CFE mission documentation build, this references the osal public API headers. Since nasa/osal#1291 was merged there is now an osal_public_api target which exposes the location of the headers via its INTERFACE_INCLUDE_DIRECTORIES property, as well as a doxygen-specific target called osal_public_api_headerlist that generates a list of INPUT files that can be included for doxygen.
However, there is a missing dependency in the CFE docs build, as the mission-doc and cfe-usersguide targets reference this file, but there is not a dependency in CMake to ensure that the file gets generated before the doxygen tool runs.
As a result, if the osal-apiguide is built first, then the CFE targets will build OK, but if the CFE targets are built first, one gets an error about a missing osal-public-api.doxyfile.
To Reproduce
Start with a clean build area
Run only make prep followed by make doc
Get error:
error: @INCLUDE = /home/joe/code/cfecfs/github-cfs-bundle/build/docs/osal-public-api.doxyfile: not found!
Exiting...
Then run make osalguide followed by make doc again. Now it builds fine.
Expected behavior
Dependency should be in place so the doc build will succeed regardless of the order.
Code snips
If applicable, add references to the software.
System observed on:
Ubuntu
Additional context
The CFE docs build was also repeating the location of the OSAL include files here:
The osal_public_api target properties should be the preferred source of this info, the path should not be specified outside of the OSAL build script as it can change in the future.
Reporter Info
Joseph Hickey, Vantage Systems, Inc.
The text was updated successfully, but these errors were encountered:
Describe the bug
In the CFE mission documentation build, this references the osal public API headers. Since nasa/osal#1291 was merged there is now an
osal_public_api
target which exposes the location of the headers via itsINTERFACE_INCLUDE_DIRECTORIES
property, as well as a doxygen-specific target calledosal_public_api_headerlist
that generates a list of INPUT files that can be included for doxygen.However, there is a missing dependency in the CFE docs build, as the
mission-doc
andcfe-usersguide
targets reference this file, but there is not a dependency in CMake to ensure that the file gets generated before the doxygen tool runs.As a result, if the
osal-apiguide
is built first, then the CFE targets will build OK, but if the CFE targets are built first, one gets an error about a missingosal-public-api.doxyfile
.To Reproduce
Start with a clean build area
Run only
make prep
followed bymake doc
Get error:
Then run
make osalguide
followed bymake doc
again. Now it builds fine.Expected behavior
Dependency should be in place so the doc build will succeed regardless of the order.
Code snips
If applicable, add references to the software.
System observed on:
Ubuntu
Additional context
The CFE docs build was also repeating the location of the OSAL include files here:
cFE/cmake/mission_build.cmake
Lines 325 to 328 in be88a07
The
osal_public_api
target properties should be the preferred source of this info, the path should not be specified outside of the OSAL build script as it can change in the future.Reporter Info
Joseph Hickey, Vantage Systems, Inc.
The text was updated successfully, but these errors were encountered: