awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

cmake: add strict mode for ldoc, based on STRICT_TESTS (#2035) 

This allows for building the docs with an older ldoc version, and it
makes sense in general to make warnings not fatal by default.

Ref: https://github.com/awesomeWM/awesome/pull/2027#issuecomment-328354095
This commit is contained in:
Daniel Hahler 2017-09-11 14:20:43 +02:00 committed by GitHub
parent b04b1b27af
commit 790a669029
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CMakeLists.txt
View File

@ -268,7 +268,6 @@ endif()
# {{{ Lua API Documentation
if(GENERATE_DOC)
if(NOT BUILD_DIR STREQUAL SOURCE_DIR)
file(MAKE_DIRECTORY ${BUILD_DIR}/lib)
file(MAKE_DIRECTORY ${BUILD_DIR}/doc)
@ -291,13 +290,18 @@ if(GENERATE_DOC)
add_custom_target(ldoc ALL
DEPENDS ${BUILD_DIR}/doc/index.html)
if (STRICT_TESTS)
set(ldoc_args --fatalwarnings .)
set(ldoc_desc_suffix " (fatal warnings)")
else()
set(ldoc_args .)
endif()
add_custom_command(
COMMAND ${LDOC_EXECUTABLE} --fatalwarnings .
OUTPUT ${BUILD_DIR}/doc/index.html
COMMAND ${LDOC_EXECUTABLE} ${ldoc_args}
WORKING_DIRECTORY ${AWE_DOC_DIR}
DEPENDS ${AWE_SRCS} ${AWE_LUA_FILES} ${AWE_MD_FILES} ${BUILD_DIR}/docs/config.ld
COMMENT "Generating API documentation"
VERBATIM)
COMMENT "Generating API documentation${ldoc_desc_suffix}")
endif()
# }}}