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

Fix #2064, Use osal-common.doxygen to resolve OSAL Doxygen refs #2065

Merged
merged 2 commits into from
Mar 16, 2022
Merged

Fix #2064, Use osal-common.doxygen to resolve OSAL Doxygen refs #2065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
198ae7d
Fix #2064, Use osal-common.doxygen to resolve OSAL Doxygen refs
skliper Mar 16, 2022
0a9e232
Fix #2064, Update doxygen warning file logic in workflow
skliper Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/build-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
- name: Build Usersguide
run: |
make usersguide > make_usersguide_stdout.txt 2> make_usersguide_stderr.txt
mv build/docs/cfe-usersguide-warnings.log usersguide_warnings.log
mv build/docs/users_guide/cfe-usersguide-warnings.log cfe-usersguide-warnings.log

- name: Archive Users Guide Build Logs
uses: actions/upload-artifact@v2
Expand All @@ -131,7 +131,7 @@ jobs:
path: |
make_usersguide_stdout.txt
make_usersguide_stderr.txt
usersguide_warnings.log
cfe-usersguide-warnings.log

- name: Error Check
run: |
Expand All @@ -142,7 +142,7 @@ jobs:

- name: Warning Check
run: |
if [[ -s usersguide_warnings.log ]]; then
cat usersguide_warnings.log
if [[ -s cfe-usersguide-warnings.log ]]; then
cat cfe-usersguide-warnings.log
exit -1
fi
8 changes: 5 additions & 3 deletions cmake/cfe-usersguide.doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
# Allow overrides
@INCLUDE_PATH = @MISSION_SOURCE_DIR@

# Common configuration and default settings
# Common setup
@INCLUDE = @MISSION_BINARY_DIR@/docs/cfe-common.doxyfile
@INCLUDE = @MISSION_SOURCE_DIR@/osal/docs/src/default-settings.doxyfile

# Include osal to resolve references and provide default settings
@INCLUDE = @MISSION_BINARY_DIR@/docs/osal-common.doxyfile

# Document specific settings
PROJECT_NAME = "Core Flight Executive Users Guide"
OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/docs/users_guide
WARN_LOGFILE = @CMAKE_BINARY_DIR@/docs/cfe-usersguide-warnings.log
WARN_LOGFILE = @CMAKE_BINARY_DIR@/docs/users_guide/cfe-usersguide-warnings.log

# For purposes of the user guide, reference the "stock" mission configuration
# Although missions may override these files, for the users guide we are mainly
Expand Down
1 change: 0 additions & 1 deletion cmake/mission-detaildesign.doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

# Common configuration and default settings
@INCLUDE = @MISSION_BINARY_DIR@/docs/cfe-common.doxyfile
@INCLUDE = @MISSION_SOURCE_DIR@/osal/docs/src/default-settings.doxyfile

# Example detailed design setup
PROJECT_NAME = "@MISSION_NAME@"
Expand Down
2 changes: 0 additions & 2 deletions cmake/mission_build.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,15 +290,13 @@ function(prepare)
# NOTE: the userguide is built against the headers of the default core apps. Even if
# an alternate version of the module is in use, it should adhere to the same interface.
set(SUBMODULE_HEADER_PATHS
"${osal_MISSION_DIR}/src/os/inc/*.h"
"${psp_MISSION_DIR}/psp/fsw/inc/*.h"
)
foreach(MODULE core_api ${MISSION_CORE_MODULES})
list(APPEND SUBMODULE_HEADER_PATHS "${${MODULE}_MISSION_DIR}/fsw/inc/*.h")
endforeach()
file(GLOB MISSION_USERGUIDE_HEADERFILES
${SUBMODULE_HEADER_PATHS}
"${CMAKE_BINARY_DIR}/docs/osconfig-example.h"
)

string(REPLACE ";" " \\\n" MISSION_USERGUIDE_HEADERFILES "${MISSION_USERGUIDE_HEADERFILES}")
Expand Down