Skip to content

Commit c67f217

Browse files
committed
Fix #1589, Separate warning file for doc builds
Use a unique file name for the doxygen warnings, instead of "warnings.log", so the mutiple documentation targets will not overwrite the other log file. Use a prefixed name so that if the log file is uploaded to the build artifacts, it will be identifiable. Detail Design warnings in: detaildesign-warnings.log Users Guide warnings in: cfe-usersguide-warnings.log
1 parent d89c7ce commit c67f217

File tree

3 files changed

+2
-1
lines changed

3 files changed

+2
-1
lines changed

cmake/cfe-common.doxyfile.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ GENERATE_DEPRECATEDLIST= YES
5454
# configuration options related to warning and progress messages
5555
#---------------------------------------------------------------------------
5656
WARN_NO_PARAMDOC = YES
57-
WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/warnings.log
5857
#---------------------------------------------------------------------------
5958
# configuration options related to the input files
6059
#---------------------------------------------------------------------------

cmake/cfe-usersguide.doxyfile.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/main.dox
99
@INCLUDE = @MISSION_BINARY_DIR@/doc/cfe-common.doxyfile
1010
PROJECT_NAME = "Core Flight Executive Users Guide"
1111
OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/doc/users_guide
12+
WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/cfe-usersguide-warnings.log
1213
GENERATE_LATEX = YES
1314

1415
# For purposes of the user guide, reference the "stock" mission configuration

cmake/mission-detaildesign.doxyfile.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
PROJECT_NAME = "@MISSION_NAME@"
88
PROJECT_BRIEF = "Core Flight System project built using \"@MISSIONCONFIG@\" configuration"
99
OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/doc/detaildesign
10+
WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/detaildesign-warnings.log
1011

1112
INPUT += @MISSION_DEFS@
1213
STRIP_FROM_PATH += @MISSION_DEFS@

0 commit comments

Comments
 (0)