Skip to content

Commit

Permalink
Fix nasa#1561, use OSAL script to generate API guide
Browse files Browse the repository at this point in the history
Instead of including the OSAL API guide templates and pages
in the CFE repo, invoke the build script now provided in
the OSAL repo itself.
  • Loading branch information
jphickey committed May 20, 2021
1 parent 8443a46 commit a98d831
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 112 deletions.
1 change: 0 additions & 1 deletion cmake/Makefile.sample
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,6 @@ usersguide:

osalguide:
$(MAKE) --no-print-directory -C "$(O)" osalguide
@/bin/echo -e "\n\nOsal Users Guide: \nfile://$(CURDIR)/$(O)/doc/osalguide/html/index.html\n"

# Make all the commands that use the build tree depend on a flag file
# that is used to indicate the prep step has been done. This way
Expand Down
23 changes: 8 additions & 15 deletions cmake/mission_build.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,6 @@ function(prepare)
configure_file("${CFE_SOURCE_DIR}/cmake/cfe-common.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/cfe-common.doxyfile")

configure_file("${CFE_SOURCE_DIR}/cmake/osal-common.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/osal-common.doxyfile")

configure_file("${CFE_SOURCE_DIR}/cmake/mission-detaildesign.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/mission-detaildesign.doxyfile")

Expand All @@ -298,18 +295,9 @@ function(prepare)

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

# OSAL API GUIDE include PUBLIC API
file(GLOB MISSION_OSAL_HEADERFILES
"${osal_MISSION_DIR}/src/os/inc/*.h"
"${CMAKE_BINARY_DIR}/doc/osconfig-example.h")
string(REPLACE ";" " \\\n" MISSION_OSAL_HEADERFILES "${MISSION_OSAL_HEADERFILES}")

configure_file("${CFE_SOURCE_DIR}/cmake/cfe-usersguide.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/cfe-usersguide.doxyfile")

configure_file("${CFE_SOURCE_DIR}/cmake/osalguide.doxyfile.in"
"${CMAKE_BINARY_DIR}/doc/osalguide.doxyfile")

add_custom_target(mission-doc
doxygen mission-detaildesign.doxyfile
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
Expand All @@ -318,9 +306,14 @@ function(prepare)
doxygen cfe-usersguide.doxyfile
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")

add_custom_target(osalguide
doxygen osalguide.doxyfile
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
# OSAL API GUIDE include PUBLIC API
set(OSAL_API_INCLUDE_DIRECTORIES
"${osal_MISSION_DIR}/src/os/inc"
"${CMAKE_BINARY_DIR}/doc"
)
add_subdirectory(${osal_MISSION_DIR}/doc/src ${CMAKE_BINARY_DIR}/doc/osalguide)
add_custom_target(osalguide)
add_dependencies(osalguide osal-apiguide)

# Pull in any application-specific mission-scope configuration
# This may include user configuration files such as cfe_mission_cfg.h,
Expand Down
78 changes: 0 additions & 78 deletions cmake/osal-common.doxyfile.in

This file was deleted.

18 changes: 0 additions & 18 deletions cmake/osalguide.doxyfile.in

This file was deleted.

0 comments on commit a98d831

Please sign in to comment.